Job Management Partner 1/Integrated Management - Manager Command and Definition File Reference

[Contents][Index][Back][Next]

jcadefconv

Function

This command converts an action definition file from version 8 or earlier (DESC_VERSION value is less than 3) to version 09-00 (DESC_VERSION value is 3).

If the action definition file for version 8 or earlier uses any of the characters listed below in its messages or in basic event information, detailed event information, or extended event information, the file is converted and defined.

Table 1-2 Character conversion

Character before conversion Characters after conversion
\/ /
Space %20
% %25

Before it executes this conversion, this command automatically checks the format of the action definition file. If it detects any errors, the action definition file is not converted and the command outputs error messages to standard error.

You can specify any output destination for the converted action definition file.

An action definition file is converted from version 8 or earlier to version 09-00 as shown below.

Table 1-3 Conversion of action definition files

Format of version 8 or earlier Format of version 09-00 Remarks
No DESC_VERSION DESC_VERSION=3 --
DESC_VERSION=1 DESC_VERSION=3 --
DESC_VERSION=2 DESC_VERSION=3 --
:state_watch=true cmn
[Figure]sta[Figure]true
end-cmn		 --
:state_watch=false cmn
[Figure]sta[Figure]false
end-cmn		 --
:state_watch not specified cmn
[Figure]sta[Figure]false
end-cmn		 --
#comment-1
+0[Figure]*[Figure]:action.exe		 act[Figure]action-1
[Figure]prm[Figure]0
[Figure]cmt[Figure]comment-1
. . .
end-act		 --
#[Figure]comment-1
+0[Figure]*[Figure]:action.exe		 act[Figure]action-1
[Figure]prm[Figure]0
[Figure]cmt[Figure]comment-1
. . .
end-act		 --
#comment-1
#comment-2
+0[Figure]*[Figure]:action.exe		 act[Figure]action-1
[Figure]prm[Figure]0
[Figure]cmt[Figure]comment-2
. . .
end-act		 --
Action specifying a parameter group act[Figure]action-serial-number When the command is executed in an English language environment
AND action act --
+parameter-group-number [Figure]prm[Figure]parameter-group-number --
& [Figure]prm[Figure]& --
$basic-part-of-event-ID [Figure]eid[Figure]basic-part-of-event-ID --
$basic-part-of-event-ID:extended-part-of-event-ID [Figure]eid[Figure]basic-part-of-event-ID:extended-part-of-event-ID --
* [Figure]eid[Figure]* --
/message/ [Figure]B.MESSAGE[Figure]REGEX[Figure]message --
/basic-event-information/ [Figure]B.BASIC[Figure]REGEX[Figure]basic-event-information --
/detailed-event-information/ [Figure]B.DETAIL[Figure]REGEX[Figure]detailed-event-information --
// No condition is set --
/-------E/ [Figure]E.SEVERITY[Figure]IN[Figure]Emergency --
/------A-/ [Figure]E.SEVERITY[Figure]IN[Figure]Alert --
/-----C--/ [Figure]E.SEVERITY[Figure]IN[Figure]Critical --
/----E---/ [Figure]E.SEVERITY[Figure]IN[Figure]Error --
/---W----/ [Figure]E.SEVERITY[Figure]IN[Figure]Warning --
/--N-----/ [Figure]E.SEVERITY[Figure]IN[Figure]Notice --
/-I------/ [Figure]E.SEVERITY[Figure]IN[Figure]Information --
/D-------/ [Figure]E.SEVERITY[Figure]IN[Figure]Debug --
/DINWECAE/ [Figure]E.SEVERITY[Figure]IN[Figure]Emergency[Figure]Alert[Figure]Critical[Figure]Error[Figure]Warning[Figure]Notice[Figure]Information[Figure]Debug When a condition with multiple event levels is specified
extended-event-information-attribute-name=/attribute-value/ [Figure]E.extended-event-information-attribute-name[Figure]REGEX[Figure]attribute-value --
u=user-name [Figure]usr[Figure]user-name --
e=environment-variable-file-name [Figure]var[Figure]environment-variable-file-name --
d=execution-host-name [Figure]hst[Figure]execution-host-name --
d=group-name [Figure]hst[Figure]group-name --
dt=suppression-time [Figure]det[Figure]suppression-time --
rt=delay-monitoring-period [Figure]ret[Figure]delay-monitoring-period --
+0[Figure]*[Figure]:action [Figure]cmd[Figure]action --
+0[Figure]*[Figure]:<RULE> [Figure]rule When JP1/IM - RL is executed
+0[Figure]*[Figure]:action.exe act[Figure]action-1
[Figure]prm[Figure]0
[Figure]eid[Figure]*
[Figure]cnd
[Figure]end-cnd
[Figure]cmd[Figure]action.exe
end-act		 When there is no event condition
+0[Figure]*[Figure]/message/ : action.exe act[Figure]action-1
[Figure]prm[Figure]0
[Figure]eid[Figure]*
[Figure]cnd
[Figure]B.MESSAGE[Figure]REGEX[Figure]message
[Figure]end-cnd
[Figure]cmd[Figure]action.exe
end-act		 When there is an event condition

Legend:
[Figure]: Indicates a tab
[Figure]: Indicates a space
--: None

Format

jcadefconv -i action-definition-file-name-before-conversion
           -o action-definition-file-name-after-conversion
         [ -h logical-host-name]

Execution permission

In Windows: Administrator permissions

In UNIX: Superuser permissions

Storage directory

In Windows:
Console-path\bin\

In UNIX:
/opt/jp1cons/bin/

Arguments

-i action-definition-file-name-before-conversion

Specifies the relative or absolute path name of the action definition file that is to be converted. If the path name of the action definition file contains a space, enclose the entire path name in double quotation marks ("). The file name can consist of a maximum of 255 bytes.

-o action-definition-file-name-after-conversion

Specifies the relative or absolute path name of the action definition file that is obtained after conversion. If the path name of the action definition file contains a space, enclose the entire path name in double quotation marks ("). The file name can consist of a maximum of 255 bytes.

Note that the following characters and character strings cannot be specified in a file name in Windows:

The user can select any name for action-definition-file-name-after-conversion, except that it cannot be the file name specified in the -i option. If the same file name is specified in both file name options, the command displays the KAVB5502-E message and terminates itself. In addition, the KAVB5504-E message is displayed and the program terminates.

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The command checks the contents of the definition file to be converted by using regular expressions used by the specified logical host.

If this option is omitted, the command assumes the logical host name specified in the JP1_HOSTNAME environment variable. If the JP1_HOSTNAME environment variable is not specified, the command assumes the physical host name.

Notes

When a file is converted to the format of version 09-00, some items become undefined. If such an undefined item is present, the KAVB5503-W message is displayed. Follow the directions in the message to correct the action definition file, and then use the jcamakea command to check that the definition file has been corrected successfully.

Return values

0 Normal termination
1 Abnormal termination
2 Termination with warning

Example

Convert an action definition file that was created in the format of version 8 or earlier to the format of version 09-00:

jcadefconv  -i actdef.conf  -o actdef_new.conf

The example assumes the following contents for the action definition file created in the format of version 8 or earlier:

 
DESC_VERSION=2
:state_watch=true
#comment
+0 $0000000A /message/,/basic-event-information/,/detailed-event-information/,/-------E/ ATTR1=/attribute-value-1/ : u=user-name e=environment-variable-file-name d=execution-host-name dt=20 rt=30 action

When the jcadefconv command is executed, the file is converted as follows:

 
DESC_VERSION=3
cmn
  sta true
end-cmn
 
act action-1
  prm 0
  cmt comment
  eid A
  cnd
    B.MESSAGE REGEX message
    B.BASIC REGEX basic-event-information
    B.DETAIL REGEX detailed-event-information
    E.SEVERITY IN Emergency
    E.ATTR1 REGEX attribute-value-1
  end-cnd
 
  usr user-name
  hst execution-host-name
  cmd action
  var environment-variable-file-name
  det 20
  ret 30
end-act

[Contents][Back][Next]

[Trademarks]

All Rights Reserved. Copyright (C) 2009, Hitachi, Ltd.