Table of Contents

Search

  1. Preface
  2. Overview, Downloading, and Installing
  3. Administration API
  4. Identity Service API
  5. Screenflow Programming and SDK
  6. ActiveVOS WSHT API
  7. Embedding Request Forms in Standalone Web Pages
  8. XML-JSON for Process Central

7. APIs, SDKs, and Services

7. APIs, SDKs, and Services

Request Message

Request Message

In earlier releases, service call steps were called automated steps.
The following sample data shows an example of the request message:
<xsd1:automatedStepRequest xmlns:xsd1="http://schemas.active-endpoints.com/appmodules/ screenflow/2010/10/avosScreenflow.xsd"> <xsd1:userId>string</xsd1:userId> <xsd1:correlationId>string</xsd1:correlationId> <xsd1:serviceName>string</xsd1:serviceName> <!--Optional:--> <xsd1:avosServiceName>string</xsd1:avosServiceName> <!--Optional:--> <xsd1:avosStepTitle>string</xsd1:avosStepTitle> <!--Optional:--> <xsd1:hostContext> <!--Optional:--> <xsd1:arg name="string"/> </xsd1:hostContext> <!--Optional:--> <xsd1:parameters> <!--Optional:--> <xsd1:parameter name="string"/> </xsd1:parameters> <!--Optional:--> <xsd1:guideData> <!--Optional:--> <xsd1:parameter name="string"/> </xsd1:guideData> </xsd1:automatedStepRequest>
The elements of the message are as follows:
automatedStepRequest input element
Description
avosServiceName
The actual Process Server service name that is used to call the service. Except for advanced cases, this name is usually the same as
serviceName
. This element is usually not needed by service call steps.
avosStepTitle
The title given by the user when creating a step that executes this service call. This is useful for formatting error messages.
correlationId
Generated ID for the running guide instance. You can also create parameters that can be added for the URL for a running guide.
guideData
Contains the complete set of input and output fields in the running guide. It is only passed if the service call describes itself as wanting it by setting the attribute
passAllData="true"
in the service element for the service call in the
services.xml
file. Additionally when using
passAllData
, the service can modify the data and return changes in the
guideData
element of the response.
hostContext
Provides information used when the Process Designer system is operating in a host data mode. This is normally not used by service call steps.
parameter
Contains the name/value pairs for the input parameters that describe this service call in
services.xml
.
parameters
This is the most important part of the code. It has name/values pairs that were described as input to this service call in
services.xml
.
serviceName
The service name used to describe this service in the
services.xml
file. This name can be different than the Process Server service name. This lets you reuse the same service, presenting different service call step information to the user. This is an advanced capability not used by most service call steps.
userId
Process Central login name of the user running the guide calling this step.