3.3.3 Deleting a user-defined reception
This subsection describes the preconditions for deleting a user-defined reception deployed in the execution environment, and explains how to delete the user-defined reception.
Note that the series of processing to stop and delete the HCSC components from the HCSC server can also be executed in the development environment in a batch. However, batch execution is performed during system development or from unit testing to integration testing. For details, see "7.6 Batch execution of processes for stopping HCSC components and deleting them from the HCSC server" in "Service Platform Basic Development Guide".
- Organization of this subsection
(1) Preconditions
To delete a user-defined reception, the following conditions must be satisfied:
-
The HCSC server is running
For details on how to check the status of the HCSC server, see "5.3.15 Checking the HCSC server information".
-
The user-defined reception is in a stopped state
For details on how to check the status of the user-defined reception, see "5.3.19 Checking the information of user-defined reception".
(2) How to delete
To delete a user-defined reception, execute the csccompoundeploy command in the operating environment.
For details on the csccompoundeploy command, see "csccompoundeploy (Deleting the deployed HCSC components) " in "Service Platform Reference Guide".
The execution format of the command differs depending on whether all the user-defined receptions are deleted in a batch, or whether only the specified user-defined reception is deleted.
- Important note
-
If the user-defined reception cannot be deleted, eliminate the cause of the error, and then delete again.
(a) To delete all the user-defined receptions in a batch
Delete all the user-defined receptions on the HCSC server or cluster in a batch.
The execution format of the command differs depending on whether the user-defined reception is deleted from a single HCSC server, or all the HCSC servers configuring the cluster.
- To delete all the user-defined receptions from a single HCSC server
-
Execute the command by specifying the name of the HCSC server and the -all option.
All the user-defined receptions deployed on the HCSC server specified in the -csc option are deleted (all the undeleted service adapters and business processes are also deleted at the same time).
csccompoundeploy -user <login user ID> -pass <login password> -csc <HCSC server name> -all
- To delete all the user-defined receptions from all the HCSC servers configuring the cluster
-
Execute the command by specifying the cluster name and the -all option.
All the user-defined receptions deployed on all the HCSC servers in the cluster specified in the -cluster option are deleted (all the undeleted service adapters and business processes are also deleted at the same time).
csccompoundeploy -user <login user ID> -pass <login password> -cluster <cluster name> -all
(b) To delete the specified user-defined reception only
Among the user-defined receptions deployed on the HCSC server or cluster, only the specified user-defined reception is deleted.
The execution format of the command differs depending on whether the user-defined reception is deleted from a single HCSC server, or all the HCSC servers configuring the cluster.
- To delete only the specified user-defined reception from a single HCSC server
-
Execute the command by specifying the name of the HCSC server and the reception ID of the user-defined reception.
The user-defined reception specified in the -name option is deleted, from among the user-defined receptions deployed on the HCSC server specified in the -csc option.
csccompoundeploy -user <login user ID> -pass <login password> -csc <HCSC server name> -name <reception ID of the user-defined reception>
- To delete only the specified user-defined reception from all the HCSC servers configuring the cluster
-
Execute the command by specifying the cluster name and the reception ID of the user-defined reception.
Only the specified user-defined reception is deleted, from among the user-defined receptions deployed on all the HCSC servers in the cluster specified in the -cluster option.
csccompoundeploy -user <login user ID> -pass <login password> -cluster <cluster name> -name <reception ID of the user-defined reception>