Setting Up Metadata

This section discusses how to set up metadata for the examples presented in this topic and discusses how to:

  • Create queues, request messages, response messages, services, service operations and pages.

  • Create nodes and routing definitions.

  • Create a test record and page.

  • Set up integration gateway logging.

Before you use the examples in this topic you must set up metadata as described in this section.

Note: The examples presented in this topic demonstrate the use of one type of connector at a time. The examples share the same basic definitions for the service operation, request message, response message, routings, and the test page. As a result, you should attempt to run only one example at a time, since the underlying metadata and objects are shared.

The exact requirements for setting up the listening and target connectors do differ somewhat, but since the differences are fairly minor the steps are combined in this section.

Before you begin the set up data for the examples configure and start the integration gateway.

This section describes creating services, service operations, queues, and request and response messages for use in running the connector examples presented in this topic.

Unless otherwise noted, use the appropriate PeopleSoft Pure Internet Architecture pages to complete these tasks.

To create services, service operations, queues, and messages:

  1. Create a new request message.

    Create a Nonrowset-based message with message name as EXAMPLE_REQUEST_MSG and message version as VERSION_1.

  2. Create a new response message.

    Create a Nonrowset-based message with message name as EXAMPLE_RESPONSE_MSG and message version as VERSION_1.

  3. Create a new Service

    Name the service EXAMPLE_SERVICE.

  4. Create new synchronous Service operation.

    1. Add a service operation of type synchronous to the EXAMPLE_SERVICE service and name it EXAMPLE_SERVICE_OPR.

    2. Complete the field definitions for service operation as follows:

      Field

      Value

      Operation Description

      Test service operation

      Request Message.Version

      EXAMPLE_REQUEST_MSG.VERSION_1

      Response Message Name.Version

      EXAMPLE_RESPONSE_MSG.VERSION_1

    3. Configure the Service Operation Security for this service operation.

  5. Create a new asynchronous Service Operation

    1. Add a service operation of type Asynchronous — one way to the EXAMPLE_SERVICE and name it EXAMPLE_SERVICE_ASYNC_OPR

    2. Complete the field definitions for the service operation as follows:

      Field

      Value

      Operation Description

      Test service operation

      Request Message.Version

      EXAMPLE_REQUEST_MSG.VERSION_1

      Queue Name

      EXAMPLE_QUEUE

    3. Configure the Service Operation Security for this service operation.

  6. Create a new queue.

    1. Name the queue EXAMPLE_QUEUE

    2. Verify that the Queue Status is set to Run.

    3. Use the Integration Broker Service Operations Monitor Administration to verify that the EXAMPLE_QUEUE is running.

This section discusses how to use PeopleSoft Application Designer to:

  • Create a test record.

  • Create a test page.

Creating the Test Record

You must create a work record that will be used on the Test Page.

Create a new record:

  1. Insert the character field TEST into the record.

  2. Select Derived/Work as the Record Type.

  3. Save the record as EXAMPLE_WORKREC.

Creating the Test Page

You must create a test page. This page will be used in some of the target connector examples.

Create a new page with a single push button on it:

  1. Create the page.

  2. Add a push button with the following properties:

    Property

    Value

    Destination

    PeopleCode Command

    RecordName

    EXAMPLE_WORKREC

    Field Name

    TEST

  3. Re-size the button and label it Test target connector.

  4. Save the page as EXAMPLE_PAGE.

  5. Add the page to a component. This may be an existing component or a new one. Ensure that the security settings for the component allow the new page to be accessed.

Use the PeopleSoft Pure Internet Architecture to complete the following tasks.

Creating Source Nodes and Inbound Routing for Service Operations

You must create a node that will be the source of all requests to the listening connectors.

To create a source node and a inbound routing:

  1. Add a new node called SOURCENODE. Enter in appropriate values for the description and the default user ID. Verify that the Active Node check box has been selected. Save this node.

  2. Add a new inbound routing to the EXAMPLE_SERVICE_OPR service operation and name it EXAMPLE_SERVICE_IN_RTN.

    1. Set the Sender Node field value to SOURCENODE and the Receiver Node field value to the local node's value.

    2. Check the Active check-box for routing .

    3. Set the Logging Details field value to Header and Detail .

    4. Save the routing.

Adding Target Nodes and Outbound Routing

You must create a target node and an outbound routing for all outgoing requests for the target connectors.

To add a target node and an outbound routing:

  1. Add a new node called TARGETNODE. Enter in the appropriate values for the description and default user ID. Verify that the Active Node check box has been selected. Save this node.

  2. Add a new outbound routing to the EXAMPLE_SERVICE_OPR service operation and name it EXAMPLE_SERVICE_OUT_RTN.

    1. Set the Sender Node field value to the local node's value and the Receiver Node field value to TARGETNODE.

    2. Verify that the Status is set to Active.

    3. Verify that Logging Details field value is set to Header and Detail.

    4. Save the routing.

  3. Add a new outbound routing to the service operation EXAMPLE_SERVICE_OPR_ASYNC and name it EXAMPLE_SERVICE_ASYNC_RTN.

    1. Set the Sender Node field value to the local node's value and the Receiver Node field value to TARGETNODE.

    2. Verify that the Status is set to Active.

    3. Verify that Logging Details field value is set to Header and Detail.

    4. Save the routing.

The integration gateway has message and error logging capabilities. If problems arise while trying the examples, these logs can be invaluable in determining where problems are occurring.

See Managing Integration Gateway Message and Error Logging.