Preface

This manual describes the commands, definition files and API of JP1/Integrated Management 3 - Manager, JP1/Integrated Management 3 - View, and JP1/Integrated Management 3 - Agent systems. In this manual, JP1/Integrated Management is abbreviated to JP1, and JP1/Integrated Management 3 - Manager, JP1/Integrated Management 3 - View, and JP1/Integrated Management 3 - Agent are generically referred to as JP1/Integrated Management or JP1/IM. In addition, in this manual, read JP1/Integrated Management - Manager, JP1/Integrated Management - View, and JP1/Integrated Management - Agent as JP1/Integrated Management 3 - Manager, JP1/Integrated Management 3 - View, and JP1/Integrated Management 3 - Agent, respectively.

Organization of this preface

Intended readers
Organization of this manual
Manual suite
Conventions: Diagrams
Conventions: Fonts and symbols
Conventions: Installation folders for the Windows version of JP1/IM and JP1/Base
Conventions: Meaning of "Administrator permissions" in this manual
Conventions: Version numbers
Conventions: Paths specified in definition files
Online manuals
Output destinations of Integrated trace log file

■ Intended readers

This manual is intended for users who want to manage, use, and operate an infrastructure that manages an open-platform system form JP1/IM. More specifically, it is intended for:

System administrators who manage, use, and operate JP1/IM to centrally monitor the events that arise in the system.
System administrators who manage, use, and operate JP1/IM to centrally monitor the status of the system management infrastructure based on correlation with events that arise in the system
Those who have knowledge of operating systems and applications

To Page Top

■ Organization of this manual

This manual consists of the following chapters:

1. Commands: Chapter 1 describes the syntax for the commands that can be used in JP1/Integrated Management.
2. Definition Files: Chapter 2 describes the formats and syntax of the definition files for JP1/Integrated Management.
3. JP1 Events: Chapter 3 describes the types and attributes of the JP1 events that are issued by JP1/Integrated Management.
4. User-created Plug-ins: JP1/IM - Manager (Intelligent Integrated Management Base) can execute processing by using user-created plug-ins, which will be described in detail in this chapter.
5. API: Chapter 5 describes the APIs provided by JP1/Integrated Management.
6. Customization of Integrated Operation Viewer Window: Chapter 6 describes how to display a user-defined window when a specific IM management node is selected in the Integrated Operation Viewer window.
7. Information Necessary to Use the Intelligent Integrated Management Base: Chapter 7 describes the SIDs and json objects that are necessary to use the Intelligent Integrated Management Base, the adapter command information that is necessary to use user-created plug-ins, and the functionality provided to generate an IM management node tree. It also provides a sample plug-in and details regarding the control characters.
8. Lists of System-Monitoring Objects (for Central Scope): Chapter 8 describes the system-monitoring objects that are provided by JP1/Integrated Management.
9. Monitoring Tree Models (for Central Scope): Chapter 9 describes the structures of monitoring trees that are created automatically.

To Page Top

■ Manual suite

JP1/IM manuals provide necessary information according to the phase in the system life cycle (the phases include planning/design, configuration, and operation). Read the manual appropriate for the purpose.

The following figure explains which phases the JP1/IM manuals provide information for.

[Figure]

To Page Top

■ Conventions: Diagrams

This manual uses the following conventions in diagrams:

[Figure]

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.`

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.

The following table explains the symbols used in this manual:

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.
Δ	Indicates a space. Δ₀: Zero or more spaces (space can be omitted). Δ₁: One or more spaces (space cannot be omitted).
	Indicates a tab. Example: `A` means that a tab character precedes `A`.

To Page Top

■ Conventions: Installation folders for the Windows version of JP1/IM and JP1/Base

In this manual, the installation folders for the Windows versions of JP1/IM and JP1/Base are indicated as follows:

Product name	Installation folder	Default installation folder^#
JP1/IM - View	`View-path`	`system-drive:\Program Files\Hitachi\JP1CoView`
JP1/IM - Manager	`Manager-path`	`system-drive:\Program Files\Hitachi\JP1IMM`
	`Console-path`	`system-drive:\Program Files\Hitachi\JP1Cons`
	`Scope-path`	`system-drive:\Program Files\Hitachi\JP1Scope`
JP1/IM - Agent	`Agent-path`	`system-drive:\Program Files\Hitachi\JP1IMA`
JP1/Base	`Base-path`	`system-drive:\Program Files\Hitachi\JP1Base`

#: Represents the installation folder when the product is installed in the default location. The location represented by system-drive:\Program Files is determined at the time of installation by an OS environment variable, and might differ depending on the environment.

To Page Top

■ Conventions: Meaning of "Administrator permissions" in this manual

In this manual, Administrator permissions refers to the Administrator permissions for the local PC. Provided that the user has Administrator permissions for the local PC, operations are the same whether they are performed with a local user account, a domain user account, or in an Active Directory environment.

To Page Top

■ 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.

To Page Top

■ Conventions: Paths specified in definition files

A definition cannot include any file name that is specified with a network path.

For example, the event guide information file must have EV_FILE specified with a folder path that is not a network path.

To Page Top

■ Online manuals

JP1/IM comes with an HTML manual that you can read in a web browser.

The HTML manual has the same contents as this manual.

To view the HTML manual:

In JP1/IM - View, choose Help and then Help Contents.
In Integrated Operation Viewer Window, choose Help and then Online manual.

Note:

If you use the Start menu, the HTML manual may be displayed in an existing browser window, depending on the related setting in the OS.

To Page Top

■ Output destinations of Integrated trace log file

Starting with JP1/IM 12-10, all 32-bit Java processes for JP1/IM have been changed to 64-bit Java processes. Therefore, the integrated trace log output destination output by the Java process function of each function of JP1 / IM is changed.

The following is the destination of the integrated trace log for each JP1/IM function from version 12-10 or later. If you are using the log file trap function, you must change the settings as you change the destination.

Output destinations of Integrated trace log file (32 bit): system-drive\Program Files(x86)\Hitachi\HNTRLib2\spool

IM database
Central Scope Service
Process management
Command execution
Automatic action
Installation and Setup

Output destinations of Integrated trace log file (64 bit): system-drive\Program Files\Hitachi\HNTRLib2\spool

Event base service
Central Console viewer
Central Scope viewer
Event Genaration Service
IM Configuration Management
IM Configuration Management viewer
Intelligent Integrated Management Base

To Page Top