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

Creating the Automated Step Service Descriptor

Creating the Automated Step Service Descriptor

In earlier releases, a service call step was called an automated step.
You must add a services.xml file to the deployment package for a service call step. This file contains the configuration details added to Process Designer that make the service call available and describe how data is used.
The file is based on the
avosServiceDiscovery.xsd
schema located in the
com.activevos.socrates.repository.services\schema
plugin.
The elements you need to define are shown in the following table:
Schema element
Description
description
Description of what the service call does. It also provides instructions about required input. You can write an extensive description, if desired, to help a guide or process designer understand what the service call step does.
displayName
Name that appears in the list of service calls steps in the guide and process designers.
iconLocation
Project path to an icon file that appears in the service call step in the guide. The size should be 32 x 32 pixels.
input parameters
The data used by this service.
largeIconLocation
Project path to an icon file that appears in the service call step properties dialog, if available. Otherwise, the smaller icon or default is used.
output fields and options
Output fields are name/value pairs where name is in the attribute name and value is the data under the element.
service name
The name of the service, which can be the real service name of a deployed process. If it is different, define an
avosServiceName
value.
showForObject
For future implementation.
Here is an example of a services.xml file
<tns:screenflowContribution xmlns:tns="http://schemas.active-endpoints.com/ appmodules/screenflow/2010/10/avosServiceDiscovery.xsd"> <tns:service name="HelloWorldAutomatedStep"> <tns:displayName>Hello World</tns:displayName> <tns:description>Service Call step that accepts a user name and replies with a complex type value to greet the user. </tns:description> <tns:input> <tns:parameter name="Hello Name" type="string" required="true"/> </tns:input> <tns:output> <tns:field name="Greeting" type="TimeOfDayGreeting" /> </tns:output> </tns:service> </tns:screenflowContribution>