Documentation Center

Deploying component modules

Component modules are usually designed to run within WorldServer and to be controlled by it, which means that you cannot execute them outside of WorldServer. To access a component module, you need to deploy it first to the WorldServer environment. If you create a new automatic action, for example, you can include it while defining workflows, and then have it used during the execution of a project.

Procedure

  1. Create a WorldServer component descriptor for your component module.
  2. Create a component archive (.zip file) that contains the classes of the component and all of their non-WorldServer library dependencies.
  3. Deploy the component module.
    You can do this either through the WorldServer user interface or through the WSComponentManager class.
    • To deploy the component module through the user interface, do the following:
    1. In WorldServer, go to Management > Administration > Customization.
    2. In the Custom component type list, select the type of custom component that you want to deploy.
    3. Select Add.
    4. In the Add Custom <Component Type> Component dialog box, select Browse.
    5. Find the .zip file you want to deploy, select it, and then select Open.
    6. Select OK.
      Your component module is uploaded and each component referenced in the desc.xml file is registered.
    • You can also deploy the component module through the WSComponentManager class. This class provides a deployComponent () method that you can call. In addition, you can also call the WSComponentDeploymentCommand as a command-line tool:
      java com.idiominc.wssdk.component.WSComponentDeploymentCommand <username><password><component archive path>
      In this case, <username> is the user name you use to log in to WorldServer, <password> is your WorldServer password, and <component archive path> is the path to the .zip file that contains the component module.