Using Web Services

The following topic covers both inbound and outbound web services.

Procedure

Map a Web Service to a Process Definition

1. Navigate to "Definitions > Processes".
2. Choose Edit from the process definition you want to map to a web service.
3. On the Published Web Services tab, choose Add.
4. Optionally change any field.
5. Choose Save & Close.

Create an UpdateJob1 Web Service

1. Navigate to "Definitions > Processes".
2. Choose New Process Definition and Select Web Service.
3. Fill http://<host>:<port>/<context>/api-soap/update/Job/UpdateJob1?WSDL into the WSDL URL field.
4. Choose Next.
5. Select UpdateJobPortType -> UpdateJob1.
6. Choose Next.
7. Optionally, if you want to test your settings, fill a valid ID into the JobIdentifierIn field and choose Test.
8. Optionally, if this process definition is used to update the status of an asynchronous process, select StatusIn.
9. Choose Save.
10. In the Process Definition Editor, choose Save & Close.

Create a Process Definition for Asynchronous Processes

1. Navigate to "Definitions > Processes".
2. Choose New Process Definition and Select RedwoodScript.
3. Fill the code under section Asynchronous Process Definition Source below into the Source field.
4. Fill a name into the Name field.
5. On the Published Web Services tab, choose Add.
6. Choose Save & Close.

Asynchronous Process Definition Source

import com.redwood.scheduler.api.model.enumeration.CompletionStrategyType;
{
jcsJobContext.setCompletionStrategy(CompletionStrategyType.External);
}

Values

Published Web Services Tab

Field	Description
Name	The name of the web service, usually WS_ followed by the process definition name.
Description	An optional description.
Documentation	An optional comment for the web service.
Add Note	Should a note be added to the process when this process definition is submitted by a web service.
WSURL	Web service URL, default is http://<server>:<port>/<context>/submit/WS_<Process_definition>.

Example

The following examples use the inbound and outbound Redwood Server web services for illustration purposes. It does not make much sense to create an asynchronous process in Redwood Server and update it via a Redwood Server web service with a third Redwood Server web service process definition.

Create the Asynchronous Process Definition

1. Navigate to "Definitions > Processes".
2. Choose New Process Definition and Select RedwoodScript.
3. Fill the code under section Asynchronous Process Definition Source into the Source field.
4. Fill a MSLN_ANSYC_JOB into the Name field.
5. On the Published Web Services tab, choose Add.
6. Choose Save & Close.

Create the UpdateJob1 Web Service

1. Navigate to "Definitions > Processes".
2. Choose New Process Definition and Select Web Service.
3. Fill http://pr1.example.com:50000/redwood/api-soap/update/Job/UpdateJob1?WSDL into the WSDL URL field.
4. Choose Next.
5. Select UpdateJobPortType -> UpdateJob1.
6. Choose Next.
7. Select StatusIn.
8. Choose Save.
9. In the Process Definition Editor, choose Save & Close.

Create a Web Service Process Definition to Submit MSLN_ANSYC_JOB

1. Navigate to "Definitions > Processes".
2. Choose New Process Definition and Select Web Service.
3. Fill http://pr1.example.com:50000/redwood/api-soap/submit/WS_MSLN_ANSYC_JOB?wsdl into the WSDL URL field.
4. Select SubmitMSLN_ANSYC_JOBPortType -> SubmitJob.
5. Choose Next.
6. Choose Save.
7. Choose Save & Close.

Submit MSLN_ANSYC_JOB from a Web Service and update its Status

1. Navigate to "Definitions > Processes".
2. Choose Submit from the context-menu of SOAP_SubmitWS_MSLN_ANSYC_JOBPortType_SubmitJob.
3. Choose Submit.
4. Navigate to "Monitoring > Processes".
5. Locate the process for MSLN_ANSYC_JOB, check its status is Running and write down the ID.
6. Navigate to "Definitions > Processes".
7. Choose Submit from the context-menu of SOAP_UpdateJobPortType_UpdateJob1.
8. Fill the ID of the MSLN_ANSYC_JOB process into the JobIdentifierIn field.
9. Choose Submit.
10. Navigate to "Monitoring > Processes".
11. Locate the process for MSLN_ANSYC_JOB, check its status is Completed.

webservice