Starting a Business Service with the openworkitem Application

Using the openworkitem application, you can start a business service that either contains, or does not contain, formal parameters (use the optional dataFeed parameter to pass formal parameters in the method call).

Procedure

  • Invoke the openworkitem application by passing the following parameters in the browser URL: 
    http://Host:Port/workspace/openworkitem.html?ProcessName=processName&ModuleName=moduleName?Version=versionNumber&DataFeed=dataFeed&Description=description

    where:

    • Host is the name or IP address of the machine hosting the Action Processor. This must be the same machine on which the application is running (i.e., the Action Processor and the application must be running on the same machine).
    • Port is the port number used by the ActiveMatrix WebApp Implementation Type to communicate with web applications.
    • processName identifies the business service to start.
    • moduleName (optional) is the path to the XPDL file that defines the “process package”. Probably the easiest way to obtain this path would be to use the Workspace application and observe the Post and Response while navigating through the available business services. The response will include the <ap:ModuleName> element, which contains the path to the module (for example: <ap:ModuleName>/Acme-Contact/Process Packages/ProcessPackage.xpdl</ap:ModuleName>). If omitted, the moduleName is retrieved from the server.
    • versionNumber (optional) is the version of the process template from which the business service is to be started. If omitted, the current versionNumber is used.
    • dataFeed (optional) is data (formal parameters) used when starting the business service. This must be in JSON format.
    • description (optional) is a description that is displayed on the form caption bar.

    The following are examples of starting a business service with the openworkitem application:

    • http://MyServer:8080/workspace/openworkitem.html?ProcessName=CSCallbackStart&ModuleName=%2FCSCallback%2FProcess%20Packages%2FCSCallback.xpdl&Version=1.0.0.201101101507
    • http://MyServer:8080/workspace/openworkitem.html?ProcessName=CSCallbackStart&ModuleName=%2FCSCallback%2FProcess%20Packages%2FCSCallback.xpdl&Version=1.0.0.201101101507&Description=My%20business%20service%20description
    • http://MyServer:8080/workspace/openworkitem.html?ProcessName=HelpDeskStart&ModuleName=%2FHelpDesk%2FProcess%20PackagesformalFHelpDesk.xpdl&Version=1.0.0.201101101430&DataFeed={ "items":[{"$param":"myText", "mode":"INOUT", "type":"STRING", "$value":"abc"}, {"$param":"myInt", "mode":"INOUT", "type":"NUMBER", "$value":"123"}]}
    Note: Spaces and slashes in the parameters passed on the URL must be URL encoded (space = %20, forward slash = %2F).