Job Management Partner 1/Software Distribution Administrator's Guide Volume 2
The USER_PROGRAM_INSTALLATION_CONDITIONS tag specifies the external program that is to be started before or after the installation or in the event of an installation error. This tag can be used in the dcmcoll, dcmpack, and dcmstsw commands.
The following shows the contents of specifiable parameters and the correspondence between parameters and command arguments:
Parameter |
Description |
Command argument |
external_program_executed_before_installation#1 |
Before-installation external program |
/b external-program-executed-before-installation |
external_program_executed_after_installation |
After-installation external program |
/a external-program-executed-after-installation |
external_program_error_handler#2 |
Error-triggered external program |
/e external-program-error-handler |
external_program_handler |
External program handler |
/ep external-program-handler |
exit#2 |
Notification method for the results of an external program |
/rbR, /rbM, /raR, /raM, /reR, /reM |
action#2 |
Disposition of processing error |
/ybC, /ybS, /yaC, /yaS |
wait#2 |
Monitoring method |
/wbU, /wbT, /wbG, /waU, /waT, /waG, /weU, /weY |
timeout |
- Monitoring time
- Maximum execution time limit (dcmstsw command)
|
- /n timeout
- /wt maximum-execution-time limit (dcmstsw command)
|
wait_code |
Wait code |
/wc wait-code |
- #1
- For a package distributed to UNIX clients, this parameter, when specified with the installation_date_and_time parameter of the SCHEDULE tag, is ignored.
- #2
- This parameter is ignored when specified for a UNIX client.
For the external program to be started, specify a program that does not have a GUI. Starting a GUI program does not cause the display of a GUI.
Be careful not to specify a 16-bit application as an external program. Remotely installing a package in the background installation mode on a Windows NT client and specifying a 16-bit application as an external program can cause the client to freeze.
- Organization of this subsection
- (1) Format
- (2) Explanation
- (3) Notes
(1) Format
USER_PROGRAM_INSTALLATION_CONDITIONS{
{
external_program_executed_before_installation=
external-program-executed-before-installation
exit=external-program-processing-results-notification-method
action=disposition-of-processing-error
wait=monitoring-method (U, T, or G)
}
{
external_program_executed_after_installation=
external-program-executed-after-installation
exit=external-program-processing-results-notification-method
action=disposition-of-processing-error
wait=monitoring-method (U, T, or G)
}
{
external_program_error_handler=
external-program-error-handler
exit=external-program-processing-results-notification-method
wait=monitoring-method (U or Y)
timeout=timeout
}
{
external_program_handler=
external-program-handler
timeout=maximum-execution-time-limit
wait_code=wait-code
}
}
(2) Explanation
- external_program_executed_before_installation=external-program-executed-before-installation
Specify the full path for the external program to be started before the installation (or file collection). You should enclose a path name that contains a space in double quotation marks (" ").
The path for an external program can be coded in a maximum of 256 characters. Exceeding this limit may result in a return code 2 error.
- external_program_executed_after_installation=external-program-executed-after-installation
Specify the full path for the external program to be started after the installation (or file collection). You should enclose a path name that contains a space in double quotation marks (" ").
The path for an external program can be coded in a maximum of 256 characters. Exceeding this limit may result in a return code 2 error.
- external_program_error_handler=external-program-error-handler
Specify the full path for the external program to be started in the event of an installation (or file collection) error. You should enclose a path name that contains a space in double quotation marks (" ").
The path for an external program can be coded in a maximum of 256 characters. Exceeding this limit may result in a return code 2 error.
- external_program_handler=external-program-handler
Specify the full path for the external program to be started when a specified execution status occurs. You should enclose a path name that contains a space in double quotation marks (" ").
The path for an external program can be coded in a maximum of 256 characters. Exceeding this limit may result in a return code 2 error.
- exit=external-program-processing-results-notification-method
Specify the notification method for external program processing results in terms of either R (return code) or M (message). For a command-argument specification, specify either R or M after /rb (for before-installation external program), /ra (for after-installation external program), or /re (for error-triggered external program).
The default varies with the installation mode that is specified in installation_mode (or the command argument /m) of the INSTALLATION_METHOD tag. For the GUI installation mode, the default is M; for the background installation mode, the default is R.
- R
Reports a return code from the external program.
- M
The external program generates a defined message.
- action=disposition-of-processing-error
Specify whether the installation is to be continued if the processing results from the external program indicate an error, in terms of either C (continue) or S (suspend). For a command-argument specification, specify either C or S after /yb (for before-installation external program) or /ya (for after-installation external program). The default is S.
- C
Treat any error as being normal; continue the installation process.
- S
Treat the installation process as an error; stop the installation process.
- wait=monitoring-method
Specify the disposition of the installation processing until the external program reports processing results in terms of U, T, G, or Y. For a command-argument specification, specify U, T, G, or Y after /wb (for before-installation external program), /wa (for after-installation external program), or /we (for error-triggered external program). The default is U.
When specifying T, G, or Y, specify in timeout a maximum limit on monitoring the response from the external program.
- U
Suspend the installation process until processing results are reported.
- T
If the suspended time period has exceeded the timeout value, treat the installation process as an error, and cancel the installation process.
- G
If the suspended time period has exceeded the timeout value, treat the installation process as being normal, and continue the installation process.
- Y
If the suspended time period has exceeded the timeout value, continue the processing of the installation error-triggered program.
- timeout=timeout (maximum-execution-time-limit for the dcmstsw command)
- dcmpack command
- Specify a maximum limit on monitoring the response from the external program in units of seconds in a 0-21,600 range (6 hours). If responses are not to be monitored, specify 0. The default is 1.
- Any monitoring time specification applies on a common basis to all external programs that are started Before installation, or On installation error.
- The specification of a monitoring time is nullified if the U option is specified in monitoring-method.
- dcmstsw command
- Specify the maximum execution time limit for the monitoring of the job execution status. Specify the execution limit in seconds, in a 1 to 10,000,000 range. The default is 86,400 (1 day).
- wait_code=wait-code
Specify the job execution status or the maintenance code that starts an external program. Use commas (,) to delimit multiple items. Multiple specifications form an OR condition.
However, you can specify the job execution status only on the managing system of JP1/Software Distribution Manager.
- Specifying a job execution status
- Specify one of the following values; the default is ERROR.
- - NORMAL
- Normal termination
- - TRANS_WAIT
- The managing server is waiting for a transfer.
- - TRANSMITTED
- The job is either being transmitted to a client or is being executed.
- - REGISTERED
- The ID job is being transmitted to the ID management relay system.
- - CLT_NOTREADY
- Startup failed.
- - CLT_SERVICE_OFF#
- JP1/Software Distribution stopped; startup failed.
- - CLT_POWER_OFF#
- The power for the PC is off; startup failed.
- - CLT_NETWORK_ERR#
- Startup failed because of a network error.
- - SUSPENDED
- The relay system sent a suspension command.
- - INST_WAIT
- Waiting for installation/collection.
- - HOLD_EXEC
- The job was placed on hold.
- - REJECTED
- The installation process was rejected.
- - ID_NOPKG
- The package stored at the relay system was deleted by the ID job.
- - CANCEL
- The client cancelled the job.
- - CONNECT_ERROR
- A communication error occurred.
- - ERROR
- A job execution error occurred.
- - DELETING
- The job is being deleted at the relay system or the client.
- #
- This parameter can be specified when the Startup failure details checkbox is selected in the Server Customization Option page in the JP1/Software Distribution Manager setup. However, this parameter, when specified with CLT_NOTREADY, is ignored.
- If the checkbox is not selected, an external program cannot be started, even when these execution status options are specified.
- Specifying a maintenance code
- Specify a maintenance code in 12 digits, including a wildcard.
- Example:
- The 9th digit from the left of the maintenance code is 8, and the 10th digit is 2: "????????82??"
- external-program-executed-before-installation, external-program-executed-after-installation, and external-program-error-handler can be specified one occurrence each.
- When specifying an external program that is to be started either before or after installation, and if either a system condition (SYSTEM_CONDITIONS) or a software condition (SOFTWARE_CONDITIONS) is specified, any specification of exit, action, or wait is ignored.
- In the dcmcoll command, any specification of external_program_handler, exit, action, wait, or timeout is ignored.
- In the dcmstsw command, any specification other than external_program_handler, timeout, or wait_code is ignored.
(a) Notes about starting an external program on a UNIX client
When using the dcmpack command to specify the startup of an external program for a package to be distributed to UNIX clients, note the following points:
- Unlike with the package for a Windows client, you cannot use the external_program_error_handler, exit, action, or wait parameter.
- The external_program_executed_before_installation and external_program_executed_after_installation parameters require different external program path specification methods, depending on whether the installation_date_and_time parameter is specified in the SCHEDULE tag.
- Do not use characters that have special meaning in a shell program, such as <, >, |, &, and $.
The following table shows differences in specification methods:
installation_date_and_time specification |
Path specification method for external program |
external_program_executed_before_installation |
external_program_executed_after_installation |
Yes |
Not specifiable |
- Specify with 40 characters or less.
- A path containing a space cannot be specified.
- If an argument exists in the post-processing program, enclose all of the paths and arguments in double quotation marks (").
- If an argument contains a space, enclose the argument, including the space, in single quotation marks (').
|
None |
- When only specifying the parameter external_program_executed_before_installation, specify the path in 60 characters or less.
- When only specifying the parameter external_program_executed_after_installation, specify the path in 64 characters or less.
- When specifying both external_program_executed_before_installation and external_program_executed_after_installation, specify the path in a total of 60 characters or less.
- A maximum of 18 character strings (arguments) can be specified.
- Consecutive multiple spaces are treated as a single delimiter character.
- The character (') (single quote) is not treated as an argument.
- Because they are treated as character strings, shell variables are ignored.
- Processing that requires a response wait should not be specified.
|
When using the dcmcoll command to specify the startup of an external program for a UNIX client, observe the following notes:
- Unlike Windows clients, the external_program_error_handler parameter cannot be specified for a UNIX client.
- Specify the path for the external program to be started in 64 characters or less. If any additional characters are specified, the first 64 characters take effect.
- A space cannot be included in the path for the external program to be started.
- Arguments cannot be specified for the external program to be started.
If an error is made in a path specification method, both the packaging and the job can be executed, but the external program does not start on the distribution destination UNIX client. Note that in this case, the job terminates normally without generating an error.
All Rights Reserved. Copyright (C) 2009, 2013, Hitachi, Ltd.
Copyright, patent, trademark, and other intellectual property rights related to the "TMEng.dll" file are owned exclusively by Trend Micro Incorporated.