Management Information Parameter Generation utility
Generates a text-format parameter file from the HULFT management information managed by HULFT-HUB Server.
Usage
utlhubigen -h hostname[:servicename] -f filename [-c {e | s | 8}] [-b yyyymmdd] [-j] -i {snd:ID | rcv:ID | job:ID | hst:ID | tgrp:ID | fmt:ID | mfmt:ID | mail:ID | sch:ID | trg:ID | tran:ID}
utlhubigen -f filename [-c {e | s | 8}] [-b yyyymmdd] [-j]
-i {user:ID | group:ID}
utlhubigen -f filename [-c {e | s | 8}] [-b yyyymmdd] [-j]
-i {thst:ID | hmb:ID | cfilter:ID}
Explanation of parameters
- -h hostname[:servicename]
-
Client Name (Optional)
If you want to output management information of a client, specify the client whose management information is to be output. If you want to output Transfer Information on a server, specify a sending client.
Specify a controlled client in the format "host-name:service-name".
This parameter is mandatory when client management information or server Transfer Information is specified.
If you specify a host for which no service name is set, specify only a host name, and do not specify a service name that includes a colon (:).
= Remarks =If the service name is omitted, it will not be possible to make more than one host with the same host name a target.
- -f filename
-
Parameter File (Mandatory)
Specify the generated parameter file name in alphanumeric characters of no more than 256 bytes. Specify this field in an absolute path.
- -c {e | s | 8}
-
Character code (Optional)
Specifies the character code of the parameter file.
If omitted, Kanji Code Type (KnjCode) of the System Environment Settings of HULFT-HUB Server is assumed.
NoteYou can use only '-c 8' (UTF-8) in HULFT-HUB Server for Windows.
If you omit the -c parameter, the code set is automatically determined according to the Windows system locale. - -b yyyymmdd
-
Backup Date (Optional)
Specify the target backup date when you generate a parameter file from the backed-up management information.
If omitted, the current management information is targeted.
NoteSpecify the date that the backup of the Management Information Backup process or the Management Information Backup utility (utlhubbackup) was executed.
For details on the Management Information Backup utility (utlhubbackup), see Management Information Backup utility.
- -j
-
Japanese output of title line (Optional)
If specified, the title line of each piece of management information is output in Japanese.
If omitted, the title line of each piece of management information is output in English.
NoteYou can specify the -j parameter if the HUB operation language (HubLang) is set to 'ja' (Japanese) on the System Environment Settings screen.
- -i {snd:ID | rcv:ID | job:ID | hst:ID | tgrp:ID | fmt:ID | mfmt:ID | mail:ID | sch:ID | trg:ID | tran:ID}
-
Management information to be output (Mandatory)
Specify the management information on the client or Transfer Information on the server to be output to a parameter file.
- snd:
-
Send Management Information
- rcv:
-
Receive Management Information
- job:
-
Job Information
- hst:
-
Host Information
- tgrp:
-
Transfer Group Information
- fmt:
-
Format Information
- mfmt:
-
Multi Format Information
- mail:
-
Mail linkage Information
- sch:
-
Schedule Information
- trg:
-
File Trigger Information
- tran:
-
Transfer Information
Specify the ID of the generation target after ':'.
The ID of Host Information is specified as an alphanumeric string of no more than 68 bytes.
The ID of the Transfer Information is specified as an alphanumeric string of no more than 50 bytes.
The Mail Interface Information ID must be of no more than 50 bytes if the client is HULFT8, and the Mail Interface Information ID must be of no more than 16 bytes if the client is earlier than HULFT8.
The other IDs must be of no more than 50 bytes if the client is HULFT8, and the other IDs must be of no more than 8 bytes if the client is earlier than HULFT8.
The IDs of the Send Management Information and Receive Management Information are case insensitive.
You can specify multiple IDs by using an asterisk (*). The * specification enables matching of all the log records, forward match, and backward match. If you use an asterisk, you must enclose the string with double quotation marks ("), for example, "snd:ABC*".
= Remarks =Repetition of '-i {snd:ID | rcv:ID | job:ID | hst:ID | tgrp:ID | fmt:ID | mfmt:ID | mail:ID | sch:ID | trg:ID | tran:ID}' allows you to output more than one parameter.
- -i {user:ID | group:ID}
-
Management information to be output (Mandatory)
Specify the user information or Business Group Information on the server to be output to a parameter file.
- user:
-
User information
- group:
-
Business Group Information
Specify the ID of the generation target after ':'.
The IDs of the user information or Business Group Information is specified with alphanumeric characters of 3 to 32 bytes.
You can specify multiple IDs by using an asterisk (*). The * specification enables matching of all the log records, forward match, and backward match. If you use an asterisk, you must enclose the string with double quotation marks ("), for example, "user:ABC*".
If the user information or Business Group Information is specified, Business Permission Information related to the specified User ID or Business Group ID are output, too.
= Remarks =Repetition of '-i {user:ID | group:ID}' allows you to output more than one parameter.
- -i {thst:ID | hmb:ID | cfilter:ID}
-
Management information to be output (Mandatory)
Specify the Transfer Destination Host Information, Accumulation Environment Settings, or Network Connection Filter Information to be output to a parameter file.
- thst:
-
Transfer Destination Host Information
- hmb:
-
Accumulation Environment Settings
- cfilter:
-
Network Connection Filter Information
Specify the ID of the generation that follows the colon (:).
For the Transfer Destination Host Information, specify the host name as an ID.
As the ID of the Accumulation Environment Settings that you would like to output, specify the host name and the service name of a specified target host (a client or a server) in the format "host name:service name".
For Network Connection Filter Information, specify as an ID the network address for the Network Connection Filter Information targeted for generation. Specify the network address as alphanumeric characters within 18 bytes. (-i cfilter:xxx.xxx.xxx.xxx/xx)
You can specify multiple IDs by using an asterisk (*). The * specification enables matching of all the log records, forward match, and backward match. If you use an asterisk, you must enclose the string with double quotation marks (""). (For example, if you specify "hmb:*", all of the clients and servers of Accumulation Environment Settings will be output.)
= Remarks =Repetition of '-i {thst:ID | hmb:ID | cfilter:ID}' allows you to output more than one parameter.
Status code
- 0:
-
The utility was executed successfully.
- 10:
-
The specified options are incorrect.
- 12:
-
Failed to allocate memory.
- 13:
-
A system error occurred.
- 40:
-
The client referred to is outside of control.
- 50:
-
The client referred to does not exist.
- 100:
-
The management information does not exist.
- 101 or above:
-
An SQL error occurred.
Notes on using the utilities
For details about the operation environment for using the utilities, see Notes on execution of utilities (commands).
For details about the description format of output parameter files, see Management Information Batch Registration utility.
In addition, if you use this utility to output the management information of a client to a parameter file, an error will be generated if the specified client is either of the following.
-
A client outside of control
-
A client registered temporarily (such as if the client was not running when it was registered)