Hitachi

Job Management Partner 1 Version 10 Job Management Partner 1/Advanced Shell Description, User's Guide, Reference, and Operator's Guide

Preface

This manual explains how to use Job Management Partner 1/Advanced Shell to create and execute job definition scripts for batch jobs.

In this manual, Job Management Partner 1 is abbreviated as JP1.

JP1/Advanced Shell consists of the following products:

This manual uses the terms execution environment and development environment to distinguish between the JP1/Advanced Shell environment and the JP1/Advanced Shell - Developer environment, respectively.

Organization of this preface

■ Intended readers

This manual is intended for individuals interested in using JP1/Advanced Shell to develop, execute, or manage batch jobs. Readers of this manual must be familiar with the following:

To Page Top

■ Organization of this manual

This manual is organized into the following parts, chapters, and appendixes:

PART 1: Overview
1. Overview of JP1/Advanced Shell

JP1/Advanced Shell is a product for creating and executing job definition scripts for batch jobs. Chapter 1 describes the purpose of JP1/Advanced Shell, provides an example of its application to a business operation, explains the overall system configuration and general procedures, and provides an overview of JP1/Advanced Shell's operation and functionality in a cluster system.

PART 2: Setup
2. Preparations for Using JP1/Advanced Shell

Chapter 2 discusses the conditions and requirements for using JP1/Advanced Shell, including the program installation directory, the main programs, prerequisites, installation, environment information settings, custom job registration, user-reply functionality settings, and environment information settings for cluster operation.

PART 3: Operation
3. Executing Batch Jobs

Chapter 3 explains how to execute batch jobs and the batch job processing in JP1/Advanced Shell (execution environment).

4. Using JP1/Advanced Shell - Developer (Windows Only)

Chapter 4 explains how to employ JP1/Advanced Shell - Developer so that you can use JP1/Advanced Shell Editor to develop job description scripts in a Windows environment. The chapter also explains how to use the editor to debug job definition script files.

5. Creating Job Definition Scripts

Chapter 5 explains the syntax for job definition scripts.

6. Debugging Job Definition Scripts

Chapter 6 describes the debugger functions of JP1/Advanced Shell.

PART 4: Reference
7. Parameters Specified in the Environment Files

Chapter 7 provides details about the description format used for parameters and commands. You define in environment files information such as return codes, coverage, system execution logs, and directory paths. Export parameters are used to define environment variables. Conditional parameters are used to apply desired environment setting parameters or export parameters specifically to the physical host or specifically to a particular logical host.

8. Commands Used During Operations

Chapter 8 describes the syntax and details of the commands used for operations.

9. Job Definition Script Commands and Control Statements

Chapter 9 describes in detail the description formats for the standard shell commands, extended shell commands, extended script commands, script control statements, and reserved script commands used in job definition scripts.

PART 5: Troubleshooting
10. Troubleshooting

Chapter 10 describes troubleshooting, including how to respond when problems occur, the types of log information, the troubleshooting information that needs to be collected, and how to collect it.

11. Messages

Chapter 11 lists the messages output by JP1/Advanced Shell and provides detailed information about errors that might occur.

A. Coverage Information That Is Acquired

Appendix A describes the coverage information that JP1/Advanced Shell acquires.

B. Reference Material for This Manual

Appendix B provides reference information such as a list of related manuals and an explanation of the abbreviations used in this manual.

C. Glossary

Appendix C is a glossary that explains the terms used in this manual.

To Page Top

■ Conventions: Administrators permissions

This manual uses the term Administrators permissions to refer to the Administrators permissions for a local PC. The actions of a user who has Administrators permissions for a local PC are no different from those for a local user or domain user, or for a user working in an Active Directory environment.

To Page Top

■ Conventions: Fonts and symbols

The following table explains the text formatting conventions used in this manual:

Text formatting

Convention

Bold

Bold characters indicate text in a window, other than the window title. Such text includes menus, menu options, buttons, radio box options, or explanatory labels. For example:

  • From the File menu, choose Open.

  • Click the Cancel button.

  • In the Enter name entry box, type your name.

Italic

Italic characters indicate a placeholder for some actual text to be provided by the user or system. For example:

  • Write the command as follows:

    copy source-file target-file

  • The following message appears:

    A file was not found. (file = file-name)

Italic characters are also used for emphasis. For example:

  • Do not delete the configuration file.

Monospace

Monospace characters indicate text that the user enters without change, or text (such as messages) output by the system. For example:

  • At the prompt, enter dir.

  • Use the send command to send mail.

  • The following message is displayed:

    The password is incorrect.

underline

The underline indicates the default value among two or more values enclosed in selection symbols.

The following table explains the symbols used by this manual in syntax explanations:

Symbol

Convention

|

A vertical bar separates multiple items, and has the meaning of OR. For example:

A|B|C means A, or B, or C.

{ }

Curly brackets indicate that only one of the enclosed items is to be selected. For example:

{A|B|C} means only one of A, or B, or C.

[ ]

Square brackets indicate that the enclosed item or items are optional. A vertical bar is used to delimit multiple items. For example:

[A] means that you can specify A or nothing.

[B|C] means that you can specify B, or C, or nothing.

< >

Single angle brackets enclose the syntax element that must be used to specify an item.

+

The plus sign indicates that the immediately preceding item can be specified multiple times. It is also used to indicate that the items before and after it are specified together.

Examples:

{A|B}+

Indicates that A or B can be specified multiple times in any order.

CR+LF

Indicates that the carriage return character (CR) and the linefeed character (LF) are specified together.

*

The asterisk indicates that the immediately preceding item can be omitted or that it can be specified one or more times.

Example:

{A|B}*

Indicates that A or B can be specified one or more times in any order or that A and B can both be omitted.

~

A swung dash indicates that the syntax element enclosed by the single angle brackets (< >), double angle brackets (<< >>), or double parentheses ((( ))) that follow must be used to specify the item that precedes the swung dash.

<< >>

Double angle brackets enclose the default value for an item.

(( ))

Double parentheses enclose the permissible range of values that can be specified.

...

An ellipsis indicates that the immediately preceding item can be repeated as many times as necessary. For example:

A, B, B, ... means that, after you specify A, B, you can specify B as many times as necessary.

[Figure]

Denotes a single-byte space.

[Figure]0: Denotes zero or more spaces (spaces can be omitted).

[Figure]1: Denotes one or more spaces (at least one space is required).

The following table explains the syntax elements used in this manual:

Syntax element

Characters that can be specified

<numeric characters>

0|1|2|3|4|5|6|7|8|9

<uppercase alphabetic characters>

A|B|C|...|Z

<lowercase alphabetic characters>

a|b|c|...|z

<alphabetic characters>

<uppercase alphabetic characters>|<lowercase alphabetic characters>

<special characters>

,|.|/|'|(|)|*|&|+|-|=|[Figure] (space)|\

<octal>

<0|1|2|3|4|5|6|7> +

<decimal>

<numeric characters> +

<hexadecimal>

0|1|2|3|4|5|6|7|8|9|A|B|C|D|E|F

<integer>

A series of signed or unsigned numeric characters

<unsigned integer>

<numeric characters> +

ss<symbolic name>

{<alphabetic characters>|<numeric characters>|@|#|_ (underscore)} +

Used in: Job names

<environment variable name>

{<alphabetic characters>|_ (underscore)}{<alphabetic characters>|_ (underscore)}|<numeric characters)} *

Used in: Environment variable file definition names, environment variable names, and extended script commands

<path name>

A character string that conforms to the path naming conventions of UNIX or Windows

<command name>

A path name consisting of permitted characters other than the path separator

<logical host name>

{<alphabetic characters>|<numeric characters>|- (hyphen)} +

<any character string>

A string of characters consisting of any combination of alphabetic characters. Note the following:

  • JP1/Advanced Shell does not check the character type.

  • Character strings with a meaning appropriate for the location where they are used must be specified.

  • We recommend that you use characters in the range permitted for the symbolic name in which they are used.

<ASCII character string>

A character string consisting exclusively of characters in the ASCII character set, other than ASCII control characters (a character string in the range from 0x20 to 0x7E)

To Page Top

■ Conventions: common application data folder

This manual uses the term common application data folder to refer to one of the following folders, depending on the Windows version being used:

Windows Server 2003, Windows Server 2003 (x64), or Windows XP:

system drive:\Documents and Settings\All Users\Application Data

Windows Server 2012, Windows 8, Windows 7, Windows Server 2008, or Windows Vista:

system drive:\ProgramData

To Page Top

■ Conventions: Shared documents folder

This manual uses the term shared documents folder to refer to one of the following folders, depending on the Windows version being used:

Windows Server 2003, Windows Server 2003 (x64), or Windows XP:

system drive:\Documents and Settings\All Users\Documents

Windows Server 2012, Windows 8, Windows 7, Windows Server 2008, or Windows Vista:

system drive:\Users\Public\Documents

To Page Top

■ Conventions: The JP1/Advanced Shell installation folder in Windows

In this manual, installation folder refers to the folder in which JP1/Advanced Shell has been installed, unless otherwise stated. The following shows the installation folder when the product is installed with the default settings.

x86 environment:

system-drive:\Program Files\Hitachi\JP1AS

x64 environment:

system-drive:\Program Files(x86)\Hitachi\JP1AS

To Page Top

■ Conventions: Windows menu names used in the manual

The Windows menu names used in this manual assume that you are using one of the following OSs:

Windows 7, Windows Server 2008, Windows Vista, Windows Server 2003, or Windows XP

In Windows 8 and Windows Server 2012, no Start menu is displayed. Instead, you must use the Start window that can be opened from the lower left corner of the window.

To Page Top

Trademarks

All Rights Reserved. Copyright (C) 2014, 2015, Hitachi, Ltd.