Preface
This manual describes the functionality and operation of JP1/Base. Note that this is a common manual for each OS. If there are OS-specific differences in usage, the differences are specified in the text.
- Organization of this preface
■ Intended readers
This manual is intended for:
-
System administrators who are responsible for introducing and operating JP1/Base.
-
System administrators and system operators who are responsible for introducing, configuring, and operating a system that incorporates JP1 products (such as JP1/IM, JP1/AJS, and JP1/Power Monitor) for which JP1/Base is a prerequisite.
■ Organization of this manual
This manual is organized into the following parts:
- PART 1: Overview
-
This part gives an overview of JP1/Base.
- PART 2: Functions
-
This part describes the functionality of JP1/Base.
- PART 3: Installation and Setup
-
This part describes how to install and set up JP1/Base. This part also describes how to operate JP1/Base in a cluster system, or how to set up to operate JP1/Base in multiple networks.
- PART 4: Installation and Operation
-
This part describes how to set up and operate JP1/Base functionality.
- PART 5: Reference
-
This part describes the commands used in JP1/Base, JP1/Base definition files, and events output by JP1/Base.
- PART 6: Troubleshooting
-
This part describes the cause and what to do if a problem occurs while you are using JP1/Base.
■ JP1/Base manual organization
The JP1/Base documentation is divided into three manuals. Read the manual appropriate to your goals, referring to the content of each manual shown in the following table.
Manual |
Content |
---|---|
JP1/Base User's Guide |
|
JP1/Base Messages |
Messages |
JP1/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: Directory names
Linux directory names are used in this manual as a general rule. The directory names have symbolic links, so that users of UNIX OSs other than Linux can use the same directory names.
When Linux uses a different directory name from another flavor of UNIX, both directory names are given.
■ Conventions: Fonts and symbols
Font and symbol conventions are classified as:
-
General font conventions
-
Conventions in syntax explanations
-
Conventions for mathematical expressions
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. |
perm |
Underlined characters indicate the default value. |
|
This symbol is used to explicitly indicate a space.
|
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 the abbreviation for a command. |
■ Conventions: JP1/Base installation folder
This manual uses the following expressions for JP1/Base installation folder:
Product name |
Installation folder |
Location of installation folder# |
---|---|---|
JP1/Base |
installation-folder |
system-drive:\Program Files (x86)\HITACHI\JP1Base |
#: The installation folders in this column are the default installation folders. 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 might differ depending on the environment.
■ 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 1.0) is written as 01-00.
-
Version 2.05 is written as 02-05.
-
Version 2.50 (or 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.