Bookshelf Home | Contents | Index | Search | PDF |
Siebel eFinance for Teller Connector to IBM WebSphere Business Component Composer Guide > Teller IFX XML Connector >
Teller IFX XML Workflow Processes
The Siebel Connector for Teller consists of three layers of workflows. Table 29 shows the layers and example workflows.
Each layer calls the workflows of the next layer down as a subprocess. Each call to a subprocess passes parameters into the subprocess to control the workflow.
Business Object-Dependent Workflow Layer
The workflows in this layer are the first point of entry for sending a message. They are usually initiated from either a Runtime Event or from a Command Object. See Initiating Messages for more information on Runtime Events and Command Objects. Modify this workflow layer to add a new message to an existing screen.
These workflows are called business object-dependent because they specify the business object that must be active at the time the workflow is initiated. If the active business object in the UI does not match the business object of the workflow that is being called, the workflow will produce an error. When configuring your workflows, you will need at least one workflow in this layer per business object in the UI that you want to generate messages for.
If you want to add a message to a business object that already has a workflow process defined at this layer, add support for that message into the workflow that is already defined instead of creating a new workflow. For example, if you wanted to add another message to the FINS Teller Session business object, you would edit the existing FINS Teller Session Connector workflow to add the logic for the message rather than creating a new workflow process.
Table 30 displays typical properties of a business object-dependent workflow.
Outbound Teller Connector Workflow Layer
There is only one workflow in this layer, called FINS IFX Connector Outbound. It is called by all of the business object-dependent workflows to initiate the sending of a message. In general, you do not need to update or create a workflow in this layer.
This workflow binds the request, transport, and response cycles together and implements the IFX session key signon protocol. The IFX session key signon protocol defines how the Siebel Connector for Teller authenticates to the external host.
Within each Siebel Object Manager session, the Siebel Connector for Teller maintains an IFX session key. The first time a Siebel user logs on, this session key is undefined. The first time a user attempts to send a Teller message, this workflow checks the IFX session key. If it is undefined, a signon request message is sent to the middleware to authenticate the user with the Siebel user name and password. Within the signon request message, the <GenSessKey> flag is set to 1 to request that the middleware respond with a session key. If this authentication is successful, the middleware is expected to respond with a session key. This session key is stored internally in the Siebel object manager session and is used for all subsequent messages to the middleware. Using a session key in this way saves time because the middleware does not have to re-authenticate the user with every message.
Conceptually, this is the algorithm implemented by the Outbound Teller Connector:
- Check IFX session key.
- If it is undefined, then
- Send a signon message with the Siebel username and password. Set the GenSessKey element in the SignonPswd IFX element to request a new session key.
- Receive the signon response from the middleware.
- If the signon response was successful, the Converter business service will store the session key in the signon response in the object manager memory for future messages.
- Check the IFX session key again. If the original signon request and response was successful, it should be set.
- Send the message using the IFX session key.
This workflow handles the session key protocol. Most of the work is handled by calling subprocesses. The process properties in this workflow are usually passed into or received from subprocess calls.
Table 31 displays the process properties of the FINS IFX Connector outbound process.
Table 31. FINS IFX Connector Outbound Process Properties Name Typical Value Source Description Application SearchSpecApplication SearchSpec%1Application SearchSpec%2Application SearchSpec%3 Business Object-Dependent workflow layer See Business Object-Dependent Workflow Layer for details. Application Siebel FINS Operation SAQuery Business Object-Dependent workflow layer This value tells the FINS IFX XML Transaction Manager which service to call. This value will match a user property in the business service definition. This user property contains a field that identifies which business service to call to extract data from Siebel. By default, SAQuery will call the eAI Siebel Adapter. However, it can be configured to call any business service you want to generate an internal integration object instance.See Business Object-Dependent Workflow Layer for details on this business service. Child Object Id 1-ABC Business Object-Dependent workflow layer This is the row Id of the second level of the integration object hierarchy.The row Id of the primary business component in the root of the integration object hierarchy is stored in the Object Id process property.This process property stores the row Id of the child business component of the primary business component. Error Code 0 FINS IFX Connector Incoming workflow process A standard workflow process property that identifies the error code of the last operation in the workflow.In addition, if there is an error in the incoming XML document, this will be the <StatusCode> value of the <Status> aggregate. Error Location FINS IFX Connector Incoming workflow process Identifies the location of the error in the incoming XML - either the Signon part of the message or the Body part of the message. Error Message Success FINS IFX Connector Incoming workflow process The message to be presented to the user if this workflow stops with an error status. Error Severity Info FINS IFX Connector Incoming workflow process Indicates if the error in the received IFX message has a status of Error, Warn, or Info. Maps to the <Severity> element of the <Status> aggregate. This is extracted from the incoming XML propset by the Parse Status method of the FINS Teller Converter Extensions business service. Exception Status <Hierarchy> FINS IFX Connector Incoming workflow process A hierarchy that contains all the <Status> aggregates from the incoming message.The value of this process property is just passed up to the Business Object-dependent workflow layer. IFX Application Business Service Name FINS Teller Converter Extensions Business Object-Dependent workflow layer. Contains the value passed in from the Business Object-dependent workflow layer from the Teller IFX Application Business Service Name process property. IFX Client Application Name Siebel Business Object-Dependent workflow layer. Passed on to the FINS IFX Connector Outgoing sub process. IFX Client Application Organization Siebel Business Object-Dependent workflow layer. Passed on to the FINS IFX Connector Outgoing sub process. IFX Client Application Version 1.0 Business Object-Dependent workflow layer. Passed on to the FINS IFX Connector Outgoing sub process. IFX DOCTYPE <!DOCTYPE IFX SYSTEM "http://www.siebel.com/teller.dtd"> Business Object-Dependent workflow layer. Passed on to the FINS IFX Connector Outgoing sub process. IFX DispMap Integration Object Name FINSTlrDrwrDispMap Business Object-Dependent workflow layer. Passed on to the FINS IFX Connector Outgoing sub process. IFX Envelope Integration Object Name FINS IFX Envelope v101 Business Object-Dependent workflow layer. Passed on to the FINS IFX Connector Outgoing sub process. IFX IsSignoff FALSE Business Object-Dependent workflow layer. Passed on to the FINS IFX Connector Outgoing sub process. IFX Outgoing Message Lookup Key IFX/tllr.TlrSvcRs/tllr.EndOfDayRs Business Object-Dependent workflow layer. Passed on to the FINS IFX Connector Outgoing sub process. IFX Service Provider Name Legacy System Business Object-Dependent workflow layer. Passed on to the FINS IFX Connector Outgoing sub process. IFX Session Key WLAEJFKCREIDJSKLAL GetSessionID method of the FINS Teller Converter Extensions business service. The session key assigned to the current session. Used to check if a session key has been received from the middleware. Object Id 1-ABC Workflow Engine The object Id of the primary business component in the active business object. Override Approval CommentsOverride UserNameOverride PasswordOverrideId Approved by Bob SmithSADMINDb21-ABC Business Object-Dependent workflow layer All these process properties are passed in from the Business Object-dependent workflow layer. Process Instance Id 1-ABC Workflow engine A standard workflow process property that identifies the running instance of this process. See Siebel Business Process Designer Administration Guide for more information. Root Object Id 1-ABC Business Object-Dependent workflow layer The row Id of the root of the integration component tree. This value is passed in from the Object Id value in the calling workflow process. Siebel Operation Object Id 1-ABC Workflow engine A standard workflow process property that identifies the row Id of the last row affected by a Siebel Operation step. See Siebel Business Process Designer Administration Guide for more information. Transport Connect Information http://middleware_ip_address/servlet /com.ibm.dse.cs.ifx.IfxRequestServlet Business Object-Dependent workflow layer Contains the value passed in from the Business Object-dependent workflow layer from the Transport Connect Information process property. Transport Logging Flag Passed in to the FINS IFX Connector Outgoing subprocesses to enable or disable logging.Setting this flag to Y will cause the outgoing and incoming messages to be logged to the default logging file defined in the FINS IFX Connector Outbound workflow process. The file name is specified in the steps that call the FINS IFX Connector Transport Manager sub processes.By default, this flag will be set to N. Before setting it to Y, examine the default logging directory to make sure it is valid for your system. VBC Business Component Name FINS Teller Electronic Journal Business Object-Dependent workflow layer This value contains the name of the business component that is the VBC. It is set by the calling workflow process. Ignore this process property when you are not using VBC. VBC IsVBC true Business Object-Dependent workflow layer If this value is true, it indicates that the business component that the Transaction Manager is querying is a VBC. VBCFieldMap <Hierarchy> This process property contains the field-value map of the values in the VBC. Its value is set by the FINS IFX Connector Outgoing subprocess. XML Document Request FINS IFX Connector Outgoing workflow process The generated XML request that is sent to the middleware. This is passed as input to the FINS IFX Connector Transport Manager workflow. XML Document Response FINS IFX Connector Transport Manager workflow process The response XML request that is received from the middleware. This is passed as input to the FINS IFX Connector Incoming subprocess.Low-Level Teller Connector Workflow Layer
Table 32 displays the three Siebel Connector for Teller workflows at this level.
Table 33 displays the properties for the FINS IFX Connector Outgoing Process.
Table 34 displays the properties for the FINS IFX Connector Transport Manager process.
Table 35 displays the properties for the FINS IFX Connector Incoming process.
Bookshelf Home | Contents | Index | Search | PDF |
Siebel eFinance for Teller Connector to IBM WebSphere Business Component Composer Guide Published: 18 April 2003 |