Web Services Usage

In general, the sequence of tasks necessary to use Process Engine Web Service is as follows:

Specify the appropriate SOAP header elements.
Generate Java™ source from the Process Engine Web Service WSDL file by using your web services toolkit.
Design your code to set the endpoint dynamically. The endpoint for your development environment might be different from the endpoint for the production environment.
Implement your business logic.

SOAP Header Elements

The SOAP header element data that is necessary for your application can vary, but at a minimum it must include the following required elements:

Elements

Security

User Token

Namespaces

http://schemas.xmlsoap.org/ws/2002/04/secext

http://schemas.xmlsoap.org/ws/2002/07/secex

http://schemas.xmlsoap.org/ws/2002/12/secext

http://schemas.xmlsoap.org/ws/2003/06/secext

http://www.docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd

http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd

Example


<wsse:Security xmlns:wsse="="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
    <wsse:UsernameToken>
        <wsse:Username>User_1</wsse:Username>
        <wsse:Password>Psiadmin1</wsse:Password>
    <wsse:UsernameToken>
</wsse:Security>

For more information, see Creating the WS-Security Header .

The following optional elements can be specified, and at a minimum, are to include:

Router Information

Note: The Router element refers to a connection point. If the Router element is not specified, the default Router element value is PEWSConnectionPoint.

Element: Router

Namespace: http://www.filenet.com/ns/fnpe/2004/06/ws/schema

Schema


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.filenet.com/ns/fnpe/2004/06/ws/schema" targetNamespace="http://www.filenet.com/ns/fnpe/2004/06/ws/schema">
    <xs:element name="Router"/>
</xsd:schema>

Example


<Router xmlns="http://www.filenet.com/ns/fnpe/2004/06/ws/schema">PECP</Router>

Localization Information

Note: The Locale element value is per ISO 639.

Elements: Localization; Locale

Namespace: http://www.filenet.com/ns/fnpe/2006/07/ws/schema

Schema


<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.filenet.com/ns/fnpe/2006/07/ws/schema" targetNamespace="http://www.filenet.com/ns/fnpe/2006/07/ws/schema">
    <xsd:element name="Localization">
        <xsd:complexType>
            <xsd:sequence>
                <xsd:element name="Locale" type="xsd:string"/>
                <xsd:element name="Timezone" type="xsd:string" minOccurs="0"/>
            </xsd:sequence>
        </xsd:complexType>
    </xsd:element>
</xsd:schema>

Example


<Localization xmlns="http://www.filenet.com/ns/fnpe/2006/07/ws/schema">
    <Locale>en_US</Locale>
</Localization>

For more information, see Using Multiple Regions and Creating the Localization Header.

Use Cases

Process Engine Web Service is designed to support the following use cases (links are to reference information):