Preface
This manual explains in detail the functions provided by Job Management Partner 1/Base and the procedures used to extend the functions of Job Management Partner 1/Base during development of systems linked to Job Management Partner 1/Integrated Management. This manual is intended for all operating systems. When there is a difference in the functions available for the supported operating systems, a distinction to that effect is made in the manual.
In this manual, Job Management Partner 1 is abbreviated to JP1.
- Organization of this preface
■ Intended readers
This manual is intended for users who use JP1/IM and JP1/Base to develop systems that work with JP1/IM.
This manual assumes that the readers understand the functionality of JP1/IM and JP1/Base.
■ Organization of this manual
This manual consists of the following parts:
- PART 1: Overview
-
Part 1 provides a brief overview of customizing and extending the JP1/Base functions.
- PART 2: Operation
-
Part 2 explains how to customize the JP1/Base functions.
- PART 3: Reference
-
Part 3 describes the JP1/Base functions in reference format.
■ JP1/Base manual organization
The JP1/Base documentation is divided into three manuals. Read the manual appropriate to your purpose, referring to the content of each manual shown in the following table.
Manual |
Content |
---|---|
Job Management Partner 1/Base User's Guide |
|
Job Management Partner 1/Base Messages |
Messages |
Job Management Partner 1/Base Function Reference |
|
■ Conventions: "Administrator permissions" as used in this manual
In this manual, Administrator permissions refers to Administrator permissions for the local PC. The local user, domain user, or user of the Active Directory environment can perform tasks requiring Administrator permissions if granted Administrator permissions for the local PC.
■ Conventions: Fonts and symbols
Font and symbol conventions are classified as:
-
General font conventions
-
Conventions in syntax explanations
These conventions are described below.
General font conventions
The following table lists the general font conventions.
Font |
Convention |
---|---|
Bold |
Bold type indicates text on a window, other than the window title. Such text includes menus, menu options, buttons, radio box options, or explanatory labels. For example, bold is used in sentences such as the following:
|
Italics |
Italics are used to indicate a placeholder for some actual text provided by the user or system. Italics are also used for emphasis. For example:
|
Code font |
A code font indicates text that the user enters without change, or text (such as messages) output by the system. For example:
|
Examples of coding and messages appear as follows (although there may be some exceptions, such as when coding is included in a diagram):
MakeDatabase ... StoreDatabase temp DB32
In examples of coding, an ellipsis (...) indicates that one or more lines of coding are not shown for purposes of brevity.
Conventions in syntax explanations
Syntax definitions appear as follows:
StoreDatabase [temp|perm] (database-name ...)
The following table lists the conventions used in syntax explanations:
Example font or symbol |
Convention |
---|---|
| |
In syntax explanations, a vertical bar separates multiple items, and has the meaning of OR. For example: A|B|C means A, or B, or C. |
{} |
In syntax explanations, 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. |
[ ] |
In syntax explanations, square brackets indicate that the enclosed item or items are optional. For example: [A] means that you can specify A or nothing. [B|C] means that you can specify B, or C, or nothing. |
... |
In coding, an ellipsis (...) indicates that one or more lines of coding have been omitted. In syntax explanations, 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. |
() |
Parentheses indicate the range of items to which the vertical bar (|) or ellipsis (...) is applicable. |
This symbol is used to explicitly indicate a space. For example, AAABBB means that you must place a space between AAA and BBB. |
|
\ |
When a syntax character shown above is used as an ordinary character, a backslash is prefixed to the character. For example, \| means | as an ordinary character, not as a syntax character. |
StoreDatabase |
Code-font characters must be entered exactly as shown. |
database-name |
This font style marks a placeholder that indicates where appropriate characters are to be entered in an actual command. |
SD |
Bold code-font characters indicate an abbreviation for a command. |
■ Conventions: Version numbers
The version numbers of Hitachi program products are usually written as two sets of two digits each, separated by a hyphen. For example:
-
version 1.00 (or version 1.0) is written as 01-00
-
version 2.05 is written as 02-05
-
version 2.50 (or version 2.5) is written as 02-50
-
version 12.25 is written as 12-25
The version number might be shown on the spine of a manual as Ver. 2.00, but the same version number would be written in the program as 02-00.
■ JP1/Base installation folder for Windows
This manual refers to the JP1/Base installation folder in Windows as follows:
Product name |
Reference to installation folder |
Installation folder# |
---|---|---|
JP1/Base |
installation-folder |
|
Example:
This manual uses the following convention to represent the full path of the JevApi.h header file needed to compile a source file:
installation-folder\include\JevApi.h
For the default installation folder, this path would actually be system-drive:\Program Files\HITACHI\JP1Base\include\JevApi.h.
For Windows Vista or later, the manual uses the expression system-drive:\ProgramData. The actual value is determined by the OS environment variable when the program is installed. The installation destination may differ depending on the environment.
■ Other reference information
For other reference information, see Reference Material for this Manual in the Job Management Partner 1/Base User's Guide.