uCosminexus Service Platform, Reception and Adapter Definition Guide

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

Appendix A.5 Custom reception operations

This section describes the operation of custom receptions.

The following figure shows the flow of custom reception operation.

Figure A-5 Flow of custom reception operation

[Figure]

Each aspect of custom reception operation is described below.

Organization of this subsection
(1) Importing the repository
(2) Deploying custom receptions
(3) Acquiring HITACHI Application Integrated Property files for custom receptions
(4) Setting HITACHI Application Integrated Property File definition information in custom receptions
(5) Starting custom receptions
(6) Checking custom reception information
(7) Stopping custom receptions
(8) Deleting deployed custom receptions
(9) Re-importing the repository

(1) Importing the repository

You can make custom receptions you created in the development environment available in the operating environment by importing the zip file containing repository information to the repository. For details on how to import repository information, see 4.3 Importing a repository in the manual Service Platform Setup and Operation Guide.

To import repository information to the repository, you use the cscrepctl command. For details, see cscrepctl(Importing/ Exporting) in the manual Service Platform Reference Guide.

(2) Deploying custom receptions

To deploy a custom reception, execute the csccompodeploy command in the operating environment. For details, see csccompodeploy(Deploying HCSC components) in the manual Service Platform Reference Guide.

The method of deploying custom receptions in the execution environment is the same as when deploying a user-defined reception. The prerequisites are also the same. For details, see 3.1.14 Setting up the HCSC server definition information in the manual Service Platform Setup and Operation Guide.

(3) Acquiring HITACHI Application Integrated Property files for custom receptions

The following describes the prerequisites and method for acquiring the HITACHI Application Integrated Property File associated with a custom reception.

(a) Prerequisites

To acquire the HITACHI Application Integrated Property File for a custom reception, the HCSC server must be running.

For details on how to check the status of the HCSC server, see 5.3.15 Checking the HCSC server information in the manual Service Platform Setup and Operation Guide.

(b) Acquisition method

To acquire the HITACHI Application Integrated Property File for a custom reception, execute the csccompoconfig command in the operating environment.

For details, see csccompoconfig(Defining HCSC components) in the manual Service Platform Reference Guide.

The format of the csccompoconfig command is as follows:

 
csccompoconfig -user login-user-ID -pass login-password -operation get -csc HCSC-server-name -name reception-ID-of-custom-reception
 

(4) Setting HITACHI Application Integrated Property File definition information in custom receptions

The following describes how to apply the definition information in a HITACHI Application Integrated Property File to a custom reception, and the prerequisites for doing so.

(a) Prerequisites

To apply the definition information in a HITACHI Application Integrated Property File to a custom reception, the HCSC server must be running.

For details on how to check the status of the HCSC server, see 5.3.15 Checking the HCSC server information in the manual Service Platform Setup and Operation Guide.

(b) Method of applying settings

To apply the definition information in the HITACHI Application Integrated Property File to a custom reception, execute the csccompoconfig command in the operating environment.

For details, see csccompoconfig(Defining HCSC components) in the manual Service Platform Reference Guide.

The format of the csccompoconfig command is as follows:

When applying definition information to a custom reception deployed on the HCSC server
Execute the command with the HCSC server name and the reception ID of the custom reception specified.
The definition information specified in the HITACHI Application Integrated Property File is applied to the custom reception on the specified HCSC server.
 
csccompoconfig -user login-user-ID -pass login-password -operation set -propfile HITACHI-Application-Integrated-Property-file -csc HCSC-server-name -name reception-ID-of-custom-reception
 

When applying definition information to a custom reception deployed on an HCSC server in a cluster
Execute the command with the cluster name and the reception ID of the custom reception specified.
The definition information specified in the HITACHI Application Integrated Property File is applied to the custom reception deployed in the specified cluster.
 
csccompoconfig -userlogin-user-ID -pass login-password -operation set -propfile HITACHI-Application-Integrated-Property-file -cluster cluster-name -name reception-ID-of-custom-reception
 

(5) Starting custom receptions

The following describes how to start a custom reception, and the prerequisites for doing so.

(a) Prerequisites

The following conditions must be satisfied before you can start a custom reception:

For details on how to check the status of the HCSC server, see 5.3.15 Checking the HCSC server information in the manual Service Platform Setup and Operation Guide.

(b) Start method (from the GUI)

To start a custom reception from the GUI in the operating environment:

  1. In the tree view, double-click the user-defined reception (custom reception) you want to start.
    Information about the custom reception you double-clicked appears on the Operations page of the editor area.
    For details on the information shown on the Operations page for a custom reception, see the description that relates to user-defined reception operation in 4.4 Operations Page in the manual Service Platform Reference Guide.
  2. Review the information displayed on the Operations page, and then click Start.
    A dialog box appears in which you can confirm that you want to start the custom reception.
  3. Review the information in the dialog box, and then click OK.
    The system begins the process of starting the custom reception. The log data generated during start processing is output to the console view.
    If you click Cancel, the custom reception does not start and you are returned to the Operations page.
    When the system has finished start processing of the custom reception, a dialog box that shows the execution results appears.
  4. Review the execution results in the dialog box.
    • If start processing was successful:
      Click OK to return to the Operations page.
      The status of the custom reception on the Operations page is now active. At this time, the Start button becomes unavailable and the Stop button becomes available.
    • If start processing failed:
      A dialog box appears describing the nature of the error. Look up the message ID displayed in the error details and take the appropriate action.
(c) Start method (from the command line)

To start a custom reception, execute the csccompostart command in the operating environment.

For details, see csccompostart(Starting HCSC components) in the manual Service Platform Reference Guide.

The format of the csccompostart command is as follows:

When starting custom receptions deployed to all HCSC servers in the cluster as a batch (at the cluster level)
Execute the command with the cluster name and the -all option specified.
The system starts as a batch the custom receptions deployed on all HCSC servers in the cluster specified by the -cluster option. Any service adapters and business processes that were not already started also start at this time.
 
csccompostart -user login-user-ID -pass login-password -cluster cluster-name -all
 

When starting custom receptions deployed on a specific HCSC server as a batch (at the HCSC server level)
Execute the command with the HCSC server name and the -all option specified.
The system starts as a batch the custom receptions deployed on the HCSC server specified by the -csc option. Any service adapters and business processes that were not already started also start at this time.
 
csccompostart -user login-user-ID -pass login-password -csc HSCS-server-name -all
 

When starting a specific custom reception deployed to every HCSC server in a cluster
Execute the command with the cluster name and the reception ID of the custom reception specified.
 
csccompostart -user login-user-ID -pass login-password -cluster cluster-name -name reception-ID-of-custom-reception
 

When starting a specific custom reception deployed on an HCSC server
Execute the command with the HCSC server name and the reception ID of the custom reception specified.
 
csccompostart -user login-user-ID -pass login-password -csc HCSC-server-name -name reception-ID-of-custom-reception
 

(6) Checking custom reception information

To view information about a custom reception, execute the cscsvcls command. For details, see cscsvcls(Displaying the service information) in the manual Service Platform Reference Guide.

By executing the cscsvcls command, you can view the file name and status of the definition file set in the development environment or operating environment. For details on how to check this information, see 3.1.7 Checking the service information in the manual Service Platform Setup and Operation Guide.

(7) Stopping custom receptions

The following describes how to stop a custom reception, and the prerequisites for doing so.

(a) Prerequisites

The following conditions must be satisfied before you can stop a custom reception:

(b) Stop method

To stop a custom reception, execute the csccompostop command in the operating environment.

For details, see csccompostop(Stopping HCSC components) in the manual Service Platform Reference Guide.

The format of the csccompostop command is as follows:

When stopping custom receptions deployed to all HCSC servers in a cluster as a batch (at the cluster level)
Execute the command with the cluster name and the -all option specified.
The system batch-stops the custom receptions deployed on all HCSC servers in the cluster specified by the -cluster option. Any service adapters and business processes that were not already stopped are also stopped at this time.
 
csccompostop -user login-user-ID -passlogin-password -cluster cluster-name -all
 

When batch-stopping the custom receptions deployed on a specific HCSC server (at the HCSC server level)
Execute the command with the HCSC server name and the -all option specified.
The system stops the custom receptions deployed on the HCSC server specified by the -csc option. Any service adapters and business processes that were not already stopped are also stopped at this time.
 
csccompostop -user login-user-ID -pass login-password -csc HSCS-server-name -all
 

When stopping a specific custom reception deployed to every HCSC server in a cluster
Execute the command with the cluster name and the reception ID of the custom reception specified.
 
csccompostop -user login-user-ID -pass login-password -cluster cluster-name -name reception-ID-of-custom-reception
 

When stopping a specific custom reception deployed on an HCSC server
Execute the command with the HCSC server name and the reception ID of the custom reception specified.
 
csccompostop -user login-user-ID -pass login-password -csc HCSC-server-name -name reception-ID-of-custom-reception
 

When stopping a custom reception, the csccompostop command first changes the status of the custom reception in CSC to inactive, and then stops the application associated with the custom reception. If a request is received while the custom reception is in the process of being stopped, the request will be processed normally if the custom reception maintained by CSC and the custom reception application are both still active.

(8) Deleting deployed custom receptions

To delete a custom reception that has been deployed to the execution environment, execute the csccompoundeploy command in the operating environment. For details, see csccompoundeploy(Deleting the deployed HCSC components) in the manual Service Platform Reference Guide.

The method of deleting deployed custom receptions in the execution environment and the prerequisites for doing so are the same as when deleting a user-defined reception. For details on how to delete deployed custom receptions, see 3.3.3 Deleting a user-defined reception in the manual Service Platform Setup and Operation Guide.

(9) Re-importing the repository

If you edit the definition of a custom reception in the development environment after the repository has been imported to the operating environment, use the following procedure to import the repository again:

  1. Export the repository.
    Export the repository in which the edited definition is stored.
    Export the repository in the development environment.
    For details on how to export the repository, see 3.2.2 Exporting a Repository in the manual Service Platform Basic Development Guide.
  2. Import the repository.
    Import the repository you exported in the development environment to the operating environment.
    For details on how to import the repository, see 4.3 Importing a repository in the Service Platform Setup and Operation Guide.