csccompoundeploy (Deleting the deployed HCSC components)
Format
csccompoundeploy [-h]
-user login-user-ID
-pass login-password
{-csc HCSC-server-name|-cluster cluster-name}
{-name service-ID|reception-ID|-all
|-namelist file-name-specifying-HCSC-components}
[-force]
[-ignore]
[-nogc]
Function
Deletes the HCSC components deployed in the execution environment.
By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.
For details on how to use this command, see the following locations in the Service Platform System Setup and Operation Guide according to the purpose of use:
Arguments
-h
Displays the usage of commands. When you specify this option, all other options are ignored even if specified.
-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))
Specifies the user ID that is used to log in to HCSC-Manager.
-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))
Specifies the password that is used to log in to HCSC-Manager.
-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the HCSC server to which the HCSC components to be deleted from the execution environment, belong.
-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the name of the cluster from where the HCSC components are to be deleted in a batch. Note that an error occurs if you specify the -cluster option when the cluster type is HA.
-name service-ID|reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the service ID or reception ID of the HCSC components to be deleted from the execution environment.
-all
Deletes all the deployed HCSC components. When you specify this option along with the -csc option, all the HCSC components deployed within that HCSC server will be deleted. When you specify this option along with the -cluster option, all the HCSC components deployed within that cluster will be deleted.
The following table lists the order in which the HCSC components are deleted when you specify this option. If an error occurs during processing, the deletion processing will stop even if all the HCSC components are not deleted.
Deletion order | Types of HCSC components | Deletion order within HCSC components |
---|---|---|
1 | User-defined receptions | Ascending order of business process names and reception IDs |
2 | Business processes | Ascending order of business process names |
3 | Service adapters | Ascending order of service IDs |
-namelist file-name-specifying-HCSC-components ~ ((1 to 200 bytes))
Uses the HCSC component-specification file to specify the HCSC components to be deleted. Specify this file with an absolute or relative path. If the file does not exist, the command ends abnormally. For details on the HCSC component-specification file, see HCSC component-specification file.
Note that the HCSC components are deleted in the same order as that described for the -all option.
-force
Forcefully deletes the deployed service adapters. This option is enabled for service adapters. Even if you specify this option for a business process and a user-defined reception, the business process and the user-defined reception are not deleted. Note that if the service adapter to be deleted is asynchronous (MDB (WS-R)), the service adapter will be deleted even if there are messages in the transfer queue.
-ignore
This option is specified to update the repository information even when the HCSC components deployed in the execution environment cannot be deleted. This option is used to achieve integrity between the execution and repository environments in the event of a hard disk failure or a communication error during unsetup.
-nogc
Deletes the components without generating Full GC. However, the specification of this option does not control Full GC generated automatically by JavaVM.
Return values
Return value | Meaning |
---|---|
0 | The command terminated normally. |
1 | The command terminated abnormally. |
2 | A communication timeout occurred. |
3 | An exclusion error occurred. |
4 | The service adapter could not be deleted because message processing was underway. |
9 | An error occurred when checking the execution permission. |
Notes