Orchestration Tasks for OS 2200 TIP Projects

The following tasks are unique to OS 2200 TIP projects.

Connecting to a Server

You must connect to the OS 2200 server, using the configured CITA port number, before you can exchange messages with a TIP application.

By default, the initial orchestration for an OS 2200 TIP data source project already includes the necessary Connect activity in the On Client Session Start event handler, so, by default, you do not need to do anything. However, the procedure below outlines the steps for explicitly adding a connection if you removed the default Connect activity or need to add a connection in another location.

When an OS 2200 TIP data source project is created, the following server message is supplied automatically.  This message can be used if TIP Session Control is active on your OS 2200 server.

Server MessageProvided FieldsExplanation
connect_BasicUserID (Required)Connection is valid only if the identified user ID matches a user ID on the OS 2200 server.
Password (Required)

Connection is valid only if the password is appropriate for the specified user ID.

This field is case-sensitive and represents log on credentials.

ClearanceLevel (Optional)Use if a clearance level is required to establish a connection.
AccountNumber (Optional)Use if an account number or an account number index is required to establish a connection. 
ProjectID (Optional)Use if a project ID or a project ID index is required to establish a connection.
LastMessageThe final text received from the OS 2200 server that indicates a connection has been successfully established.

Adding a connection when TIP Session Control is not in use

  1. Open the On Client Session Start event handler or any On <client message name> event handler that needs the connection.

  2. Drag the Connect activity from the Toolbox to the Start node of an event handler.

  3. Do not specify any value for the Message property; leave it blank.

Adding a connection when TIP Session Control is in use

  1. Open the On Client Session Start event handler or any On <client message name> event handler that needs the connection.

  2. Drag the Connect activity from the Toolbox to the Start node of an event handler.

  3. In the Properties window, do the following:

    1. Select the special connect_Basic server message for the Message property. The server message appears in the Server Messages node of the event.

    2. Click the MessageData property, and click the selection button on the right. Make any necessary changes using the Assign Data dialog box and click OK. Refer to Assign Data for Message Dialog Box for details.

Example 1: Adding a connection with pre-set values using connect_Basic

  1. Open the On Client Session Start event handler or any On <client message name> event handler that needs the connection.

  2. Drag the Connect activity from the Toolbox to the Start node of the new event handler.

  3. In the Properties window, do the following:

    1. Set the Message property to connect_Basic.

    2. Click the MessageData property, and click the selection button on the right.

    3. In the Assign From column for UserID, select Literal.

    4. In the Data Value column, type the user ID that is to be used on the OS 2200 server.

    5. In the Assign From column for Password, select Literal.

    6. In the Data Value column, type the password for the supplied user ID.

    7. Optionally, supply data values for ClearanceLevel, AccountNumber, and ProjectID.

  4. Click OK.

  5. Add activities to the Start node that initiate the sending and receiving of data to and from the OS 2200 TIP application.

Example 2: Adding a connection with user-solicited values using connect_Basic

  1. Create a client message that includes the necessary fields of the connect_Basic server message. Refer to Creating Client Messages.

  2. In the ePortal Message window, select the client message created in step 1, and drag it to the On Client Session Start event handler. This creates a ReplyToClient action. If a Connect activity already appears in the On Client Session Start event handler, delete it.

  3. In the ePortal Message window, select the client message created in step 1, again, and drag it to the root of the orchestration tree. The On <client message name> node is added to the tree and the client message appears in the Client Messages node of the event.

  4. Drag the Connect activity from the Toolbox to the Start node of the new event handler.

  5. In the Properties window, do the following:

    1. Set the Message property to connect_Basic.

    2. Click the MessageData property, and click the selection button on the right.

    3. In the in the Assign From column for both UserID and Password, select Variable. The Data Value columns for the fields are preset to the clientMessage.UserId and clientMessage.Password, respectively.

    4. Optionally, repeat step c for ClearanceLevel, AccountNumber, and ProjectID, as necessary.

  6. Click OK.

  7. Add activities to the Start node that initiate the sending and receiving of data to and from the OS 2200 TIP application.

Handling DPS Server Messages

When an OS 2200 TIP data source project is created, the following server messages are supplied automatically. These messages can be used to handle DPS messages sent from the OS 2200 server.

Server Message

Provided Fields

Explanation

_dps_error_message

MESSAGE_TEXT

Contains the text sent by a DPS Messaging function, such as D$ERRMSG or D$DISPLAYERR.

_dps_message

MESSAGE_TEXT

Contains the text sent by a DPS Messaging function, such as D$USERMSG or D$ENDMSG.

_dps_senderr_message

ERROR_Y

Contains the Y-coordinate sent by a DPS Messaging function, such as D$SENDERR, D$USERERR, or D$FLDERR.

ERROR_X

Contains the X-coordinate sent by a DPS Messaging function, such as D$SENDERR, D$USERERR, or D$FLDERR.

ERROR_TEXT

Contains the error text sent by a DPS Messaging function, such as D$SENDERR, D$USERERR, or D$FLDERR.

If ePortal receives a _dps_error_message or _dps_senderr_message server message, the default action is to redisplay the previous DPS form output, along with any input data that was entered and the error text returned in the server message. You can disable the default handling of these server messages by setting the dpserrorhandling__ metadata field to False before sending input to a DPS application.

If you need to handle information sent from one of the DPS messaging functions, perform the following steps to include these server messages in an orchestration immediately after an InvokeServer, or ReceiveServer activity:

  1. Either create a new client message, or modify an existing client message to define a place where the DPS message will be displayed. The client message should contain a string field that can accept at least 80 characters. Refer to Creating Client Messages, or Modifying Client Messages.

  2. Open the On <client message name> event handler where a DPS message needs to be handled.

  3. Drag a PickMessage activity from the Toolbox to the On <client message name> event handler.

  4. Drag an IsMessage activity from the Toolbox to the On <client message name> event handler.

  5. In the Properties window, select _dps_error_message, _dps_message, or _dps_senderr_message for the Message property.

  6. Drag the client message from step 1 to the On <client message name> event handler. This creates a ReplyToClient action.

  7. In the Properties window, do the following:

    1. Click the MessageData property, and click the selection button on the right.

    2. Locate the string field added in Step 1 and under Assign From select Variable.

    3. In the Data Value column, click the selection button on the right.

    4. In the Source dialog, select Server._dps_error_message.MESSAGE_TEXT, Server._dps_message.MESSAGE_TEXT, or Server._dps_senderr_message.ERROR_TEXT.

  8. Click OK.

User-Defined Input

When an OS 2200 TIP data source project is created, the following server message is supplied automatically. This message can be used to provide user-defined input to the OS 2200 server.

Server Message

Provided Fields

Explanation

_user_defined_input

input_text

Optional input for a TIP application

tiptrancode_

Transaction code for the TIP application to invoke

Typically, this server message is used to initiate a TIP application that uses DPS forms. In this case, you would perform the following steps:

  1. Open the On Client Session Start event handler or any On <client message name> event handler that contains a Connect activity.

  2. Drag an InvokeServer activity from the Toolbox to the event handler.

  3. In the Properties window, do the following:

    1. Select _user_defined_input for the Send property.

    2. Click the MessageData property, and click the selection button on the right.

    3. In the Assign From column, select Literal for the tiptrancode__ field.

    4. In the Data Value column, enter the TIP transaction code value.

  4. Click OK.