IBM FileNet P8, Version 5.2.1            

Receive system function

Use the Receive system function to provide a Web Service that can be invoked. The Receive step can be at any location in the workflow.

Before you begin
Workflow properties - Web Services. Specify the partner links in the workflow properties. Here are some properties that might need to be configured:
  • Data fields and attachments that are required for input to the services
  • Any data fields or XML fields that are required for returned values
  • The default folder in your object store or library where returned attachments are to be stored

Under the following conditions, a workflow with a Receive system function launches automatically in response to an Invoke system function:

To specify a Receive system function:

  1. From the Web Services Palette, drag a Receive step onto the workflow map where you want to provide a Web Service operation.
  2. On the Receive General tab, select a previously defined Partner Link that specifies the Web Service. For more information, see Workflow properties - Web Services.
  3. Enter an operation name.
  4. Under Message Type, select Parameters or XML.

    Parameters

    Use workflow data fields for input and output. Use this message type for simple parameters or for schemas up to two levels deep. Schemas cannot contain duplicate element names.

    For each input parameter for this Web Service, specify a parameter name and data type. The parameters display in the Invoke step to indicate the appropriate input.

    For more information, see Specify operation parameters.

    Restriction:
    • The name of a parameter cannot contain numbers, special characters, or spaces.
    • The parameter type determines the processes that can communicate with a P8 web service. If you set the parameter type to be attachment by value, a web service can communicate with another P8 workflow process only. That is, the other participant in the conversation cannot be an external web service. For an example of setting the parameter type, see Using Web Services: Parameter example.

    XML

    Use XML schema for input and output. You must use this message type when parameters are nested more than two levels deep.

    • Incoming XML data field. Select a previously defined XML data field to hold the incoming message. For information about defining XML data fields and XML schemas, see Workflow Properties - Web Services.
    • Schema. Select a previously defined XML schema for the Web Service. The elements in the schema display in the Invoke step to prompt for the appropriate input.
    • Element. Specify either the root element of the schema or some other element, as appropriate.
  5. Optional: Set a time limit for receiving messages.
    1. On the Advanced tab under Timeout Expression, enter an expression that specifies a time limit for the Receive system function to wait. For example, you can enter a time function such as addminutes(systemtime(), 30). This example allows the step to wait 30 minutes before it goes to the specified timeout map.
    2. Select an appropriate submap to be executed if the timeout condition occurs. You can choose one of the default maps (Terminate or Malfunction), or you can create your own submap to provide custom processing.
  6. Optional: Set authentication.
    1. To require logon and password in order to use the Web Service provided by the Receive system function, select Yes under Authentication.
    2. If you choose Yes (Authentication is required), for Accept Messages From, specify a user or group as the valid requester.
    In the workflow that invokes a Receive step that requires authentication, the appropriate user name and password values must be in the Partner Link message header. In FileNet® workflows, the header of the invoking message includes a Security section that contains placeholders for the user name and password. For an example of implementing authentication in both the receiving and invoking processes, see Web Services Authentication example.
  7. Optional: Correlating web conversations. If a Receive step is not the first step in the workflow, the step must include a correlation set. The correlation set provides a way to identify an appropriate instance of an invoke message.
  8. Make the web service available:

    For other FileNet workflows

    Transfer the workflow with the web service to the workflow system.

    For processes that are external to FileNet P8

    Publish the web service to a UDDI registry or WSRR registry. For more information, see the following topics:


Last updated: March 2016
bpfdh108.htm

© Copyright IBM Corporation 2016.