4Configuration Roadmap

Configuration Roadmap

This chapter provides an illustrative example of configuring the ACORD XML connector.

The Siebel Connector for ACORD XML is made up of four pre-built business services:

  • FINS ACORD XML Transaction Manager

  • FINS ACORD XML Data Transformation Engine

  • FINS ACORD XML Converter

  • FINS ACORD XML Dispatcher

The Siebel Connector for ACORD XML can be configured to support several types of IFX Business Object Model packages. The following illustrates the main steps in configuring the Siebel Connector for ACORD XML, which are as follows:.
  • FINS ACORD Wizard. Use FINS IAA Wizard to build an integration object, then external/internal/envelope integration objects, then build a data transformation map, then map external integration object to an internal integration object, then configure the workflow process, then instantiation.

  • Data Mapper. Use to build a data transformation map, then map external integration object to an internal integration object, then configure the workflow process, then instantiation.

  • Workflow Manager. Use to configure the workflow process, then instantiation.

Main Steps to Configure the Siebel Connector for ACORD XML. This image is described in surrounding text.

This chapter presents the scenario of adding a new Auto Policy through a Siebel front-end application for outbound communication and receiving a request to add an auto policy during inbound communication. This operation corresponds to <PersAutoPolicyAddRq> and <PersAutoPolicyAddRs> commands in ACORD XML. The example uses the MQSeries Server Transport mechanism, though there is no specific transport mechanism required for Siebel Connector for ACORD XML.

The following checklist shows the high-level procedure for configuring your system to use the Siebel Connector for ACORD XML.

Checklist

Create the integration objects in Siebel Tools.

For details, see Creating Integration Objects in Siebel Tools.

Configure the ACORD XML business services in Siebel Tools.

For details, see Configuring the Connector Components.

Configure the transformation maps in Siebel Client.

For details, see Configuring the Data Transformation Maps.

For outbound communication, configure the outbound Siebel Connector for ACORD XML for sending an ACORD XML message.

For details, see Configuring an Outbound Siebel Connector for ACORD XML.

For inbound communication, configure the inbound Siebel Connector for ACORD XML for receiving an ACORD XML message.

For details, see Configuring an Inbound Siebel Connector for ACORD XML.

For outbound communication, configure events to trigger the workflow process in real time according to user input using Runtime Event Manager.

For details, see Configuring Runtime Events.

For inbound communication, configure server tasks to dispatch the message to the workflow.

For details, see Configuring Server Tasks.

Note: When generating integration objects, be certain to use the appropriate version of the ACORD DTD, version 1.0.0. It is available from www.acord.com.

Creating Integration Objects in Siebel Tools

Integration objects define the intermediate format of the data so that it can be used by the connector components to translate between Siebel data formats and ACORD XML data formats.

You use the FINS ACORD Wizard to create the envelope, internal, and external integration objects, as well as the dispatcher map.

The following table shows the pre-setup user properties for the FINS ACORD Wizard.

Name Value Comments

DispatcherMapName

ACORDDispMap

The Dispatcher Map Name. The wizard will use this map to update the key and value.

HasUIControl

Y

Internal use.

Integration Object Wizard

Y

Internal use.

Integration Object Base Object Type

Siebel Business Object

Internal use.

Operation KeyWord Match:0

Add/SAUpsert

Internal use. This means that when the wizard generates an external integration object for an Add message, it defines the operation in the transaction manager as SAUpsert. The operation name will be recorded in the dispatcher map.

Operation KeyWord Match:1

Inq/SAQuery

Internal use. This means that when the wizard generates an external integration object for an Inq message, it defines the operation in the transaction manager as SAUpsert. The operation name will be recorded in the dispatcher map.

Default Envelope Tag

ACORD

Value for Envelope Tag.

Note: You can define a new Operation KeyWord Match:X if you need to. For example, if the ACORD DTD in the future supports the delete operation, you can define Operation KeyWord Match:2 as Delete/SADelete.

    Locking the Project and Selecting the DTD File

    Whenever you create integration objects, you must lock the project you are working with and associate the appropriate DTD file with the object.

    To lock the project and select the DTD file

    1. Start Siebel Tools.

    2. Lock the appropriate project.

      The FINS ACORD XML Wizard requires a locked project.

    3. From the application-level menu, choose File, and then New Object.

      The New Object Wizards dialog box appears.

    4. Select the EAI tab and double-click Integration Object.

      The Integration Object Builder wizard appears.

    5. Fill in the two fields.

      1. Select the project you have locked.

      2. Select FINS ACORD Wizard Service from the Business Service list.

        This image is described in surrounding text.
    6. Click Next.

      You may receive a warning about a missing dispatcher map.

      This warning offers to write to a temporary dispatcher map, which you can merge with the connector dispatcher map later on.

    7. Choose the DTD file you want to use, and then click Next.

      If you are using the file received from the ACORD Web site, the filename is ACORD_PC_XML_V1_0_0.dtd. This filename indicates that this is version 1.00 of ACORD DTD.

      It takes some time for the wizard to parse the DTD file and to display the next page.

      Creating an Envelope Integration Object

      An envelope integration object provides the envelope and header information needed by the ACORD XML hierarchy.

      The following procedure shows how to create an envelope integration object that works with external and internal integration objects. Note that the wizard provides the option of creating an envelope integration object that stands alone, which can be used for authentication.

      The example provides the steps for creating a user-defined envelope, which allows you to create a customized authentication mechanism. You can also create a default envelope from the wizard. The default envelope provides the user name, password, and session key authentication mechanism that conforms to the ACORD standard.

      To create an envelope integration object

      1. Lock the project and select the DTD file for the object.

        As described in the previous section, you select the ACORD_PC_XML_V1_0_0.dtd file.

        After the wizard parses the DTD file, it displays the next page so that you can create an envelope integration object.

      2. For this example, select the Create user defined envelope check box, fill in the name of the integration object, and click Next.
        FINS ACORD Wizard Service. In this image, the check box next to the following option is selected: Create user defined envelope integration object.

        If you wanted to create a standalone envelope, you would select the Create envelope integration object only check box. A standalone envelope integration object can be used by any integration objects later on.

      3. Click Next.

        The wizard displays a visual selection hierarchy so that you can select the elements you want to include in the header.

        These elements include <Signon> and <Signoff> elements for both request and response.

        For the example, deselect PendingResponseInfo and SuppressNotification.


        This is an image of the FINS ACORD Wizard Service. In this image, check boxes next to the following options are selected: ACORD, SignoffRq, Status, SignonRs, SignonRq, SignoffRs.
      4. Verify that the required check boxes are selected, and click Next.

        The wizard displays the first screen in the sequence to create an external integration object.

        Creating External Integration Objects

        An external integration object establishes the hierarchy for an ACORD XML message. Each type of message under a service needs its own integration object that defines the body portion of the XML document.

        When you create an external integration object, you create a pair of such objects, one for the request portion of the cycle and one for the response portion of the cycle.

        Each external integration object is paired with an internal integration object when you configure the DTE map.

        To create an external integration object

        1. Lock the project and select the DTD file for the object.

          You select the ACORD_PC_XML_V1_0_0.dtd file.

        2. Create a default or user-defined envelope integration object.

          The steps are described in the preceding section.

        3. Choose a Request Service and Response Service pair.

          This image is described in surrounding text.

          For an external integration object, you need to specify a request service and a response service, for example <InsuranceSvcRq> and <InsuranceSvcRs>. These are the service aggregate elements.

        4. Click Next, and then choose the Request Command and Response Command you want to use.


          This image is described in surrounding text.

          This screen uses Request Command to identify the ACORD request message. The request message you select is automatically paired with an appropriate response message. For this example, you choose <PersAutoPolicyAddRq>; it is automatically paired with <PersAutoPolicyAddRs>.

          Note: Make a note of the integration object names. You will need to know the names when you configure the DTE map.

          You can change the Integration Object Name for the request and response integration objects for administrative convenience. You should consider establishing a set of naming conventions to make groups of objects easy to recognize. This example uses the default names.

        5. Click Next to display the integration components screen in which you select the message elements to include.

          You will select message elements for the request integration object in this screen, and you will select the message elements for the response integration object in the next screen.

        6. Click the plus symbol (+) to display the message elements.


          This is an image in the FINS ACORD Wizard Service. The following check boxes are selected: PersAutoPolicyAddRq, Location, PersAutoLineBusiness, CodeList, InsuredOrPrincipal, FileAttachmentInfo, TransactionRequestDt, ConversionRate, PersPolicy, TransacationEffectiveDt, Remark Text, CurrCd, RqUID.

          This screen displays a visual hierarchy of the message structure. It provides all the available aggregates and elements for the message. The screen starts with all of these selected (included).

        7. Choose the ACORD message components that you want to activate for this integration object.

          Click to select each item. Notice that if you deselect the parent, all the child items are deselected. Reselecting the parent does not reselect the child items, so you can select just a subset of child items.

        8. Click Next to display the second integration components screen, and choose the ACORD message components you want to activate for the response integration object.

        9. Click Next to display the Select Internal Integration Object screen.


          This is an image of the FINS ACORD Wizard Service. This image is described in surrounding text.

          Creating Internal Integration Objects

          An internal integration object creates a structure that matches the data structure of a Siebel business object.

          You can choose an already-created internal integration object, if one has been created. Siebel integration objects are interfaces for outside systems to interact with internal Siebel data.

          This example uses the FINS ACORD Wizard to create a new internal integration object, as shown in the following procedure.

          To create an internal integration object

          1. Lock the project and select the DTD file for the object.

            You select the ACORD_PC_XML_V1_0_0.dtd file.

          2. Create an envelope integration object and a pair of external integration objects.

            The steps are described in the preceding sections.

          3. In the Select Internal Integration Object screen, do not select either check box, and click Next to display the New Integration Object screen.

          4. In the Internal Request Integration Object area, choose the business object that contains the information that the connector will exchange, and enter the name of the integration object.

            This is an image of the FINS ACORD Wizard Service. This image is described in surrounding text.
          5. For the Internal Response Integration Object, select the Use the same integration object as request check box.

            The entry boxes are not available for selection.


            This is an image of the FINS ACORD Wizard Service. The following check box is selected: Use the same integration object as request.
          6. Click Next to display the integration components available from the business object you selected on the previous screen.


            This is an image of the FINS ACORD Wizard Service. Check boxes next to the following options are selected: INS Policy, INS Policy_Position, INS Policy_INS Driver, INS Policy_INS Policy Note, INS Policy Opportunity, INS Policy_INS Pay Plan, INS Policy_INS Prior Claims, Action, Action-Simplified Version for Deep Copy, FINS MultiVehicle VBC, INS Claims, INS Coverage, INS Discount.

            This screen displays a visual hierarchy of the business object structure. It provides all the available aggregates and elements for the message.

          7. Deselect the elements you do not want to include, and then click Next.

            The screen displays a warning telling you that it may take some time to create the integration objects.

          8. Click Yes to create the integration objects.

            After the wizard creates the integration objects, it shows the objects that have been created.

          9. Click Finish.

            The wizard guides you to the Integration Objects view, which displays a list of integration objects that includes the ones you have just created.

            Viewing the Dispatcher Map

            When it creates the paired external and internal integration objects, the FINS ACORD Wizard creates a pair of new or updated entries in the dispatcher map.

            The FINS ACORD XML dispatcher map is an integration object that contains the rule sets used by the FINS ACORD XML Dispatcher. The default ACORD dispatcher map is ACORDDispMap. If you have the correct project locked, the wizard updates the user properties of the default ACORD dispatcher map. Otherwise, the wizard creates a new ACORD dispatcher map with the following name format and updates its user properties:

            ACORDDispMap_<currently locked project name>

            To view the Dispatcher Map user properties

            1. From Siebel Tools, choose Object Explorer, and then Integration Object.

            2. Query for the dispatcher map name, for example ACORDDispMap.

            3. Navigate to the user properties of the dispatcher map to see its user properties.

              The following table shows the rule sets created by the wizard for the Add Policy scenario.

              Name Value
              ACORD/
              InsuranceSvcRq/
              PersAutoPolicyAddRq
              ACORD/InsuranceSvcRq/
              PersAutoPolicyAddRq;PersAutoPolicyAddRq_ERqIRqMapIn;PersAutoPolicy
              AddRq_IRsERsMapOut;PersAutoPolicyAddRq;AcordPolicy;SAUpsert
              ACORD/
              InsuranceSvcRs/
              PersAutoPolicyAddRs
              ACORD/InsuranceSvcRs/
              PersAutoPolicyAddRs;PersAutoPolicyAddRs_ERsIRsMapIn;PersAutoPolicy
              AddRs_IRqERqMapOut;PersAutoPolicyAddRs;AcordPolicy;SAUpsert
              The name of the user property represents the rule the dispatcher tries to match and the value represents the value the dispatcher needs to insert. For example, the name:
              ACORD/InsuranceSvcRq/PersAutoPolicyAddRq
              is the path the dispatcher uses to locate the message received, and if it finds the match then it uses the information in the value column,
              ACORD/InsuranceSvcRq/PersAutoPolicyAddRq;PersAutoPolicyAddRq_ERqIRqMapIn;
              PersAutoPolicyAddRq_IRsERsMapOut;PersAutoPolicyAddRq;AcordPolicy;SAUpsert
              to determine the action it needs to take.

              The following is a description of the meaning of each of the parts of the information in the value column.

              Each value is made up of six tokens that are separated by semicolons (;), and each token represents specific information.

              • The first token is the location to insert the remaining five tokens at runtime. For example, ACORD/InsuranceSvcRq/PersAutoPolicyAddRq.

              • The second token is the name of the data transformation map for mapping the external request integration object indicated by ERq to the internal request integration object indicated by IRq. For example, PersAutoPolicyAddRq_ERqIRqMapIn.

              • The third token is the name of the data transformation map for mapping the internal response integration object IRs to the external response integration object ERs. For example, PersAutoPolicyAddRq_IRsERsMapOut.

              • The fourth token is the external request integration object. For example, PersAutoPolicyAddRq.

              • The fifth token is the internal response integration object. For example, AcordPolicy.

              • The sixth token is the operation corresponding to the <PersAutoPolicyAddRq> message, for example SAUpsert. This token will be used as the key to operation for FINS ACORD XML Transaction Manager.

              The data transformation map names must be used when configuring the transformation maps. For details, see Configuring the Data Transformation Maps. The map names have to be unique and you need to modify the dispatcher map entries to reflect the new name. The same principle applies to all the tokens.

              Note: Deliver the changes to the integration branch.

              Configuring the Connector Components

              Siebel Connector for ACORD XML provides four prebuilt business services that you can configure for your specific use:

              • FINS ACORD XML Transaction Manager

              • FINS ACORD XML Data Transformation Engine

              • FINS ACORD XML Converter

              • FINS ACORD XML Dispatcher

              Each business service has its own user properties. The values of these user properties are decided by configuration time. However, you can also override those values in the workflow by entering a run-time value. The meanings of the user properties are described in Siebel Connector for ACORD XML This section shows the configuration of the user properties for each of these business services.

                FINS ACORD XML Transaction Manager

                Several prebuilt operations have been defined in the transaction manager. These operations are sufficient to support most needs in Oracle’s Siebel Connector for ACORD XML. It is recommended that you not change these values unless you want to add new operations.

                Operation Name Value

                SAQuery

                EAI Siebel Adapter/Query/

                SARowIdQuery

                EAI Siebel Adapter/Query/PrimaryRowId;!SiebelMessage;

                SASynchronize

                EAI Siebel Adapter/Synchronize/

                SAUpsert

                EAI Siebel Adapter/Upsert/

                SAUpsert_ROLL_BACK

                EAI Siebel Adapter/Delete/RollbackOnSame;

                SAOperation_FIND

                FINS Industry BC Facility- Service/HierarchySearchSpec/!SiebelMessage;IntObjectName=>SiebelFINSRespIntObjName;

                The following are examples of how the values in the table are interpreted:

                • SAQuery means the operation will execute the EAI Siebel Adapter’s Query method.

                • SAUpsert means the operation will execute the EAI Siebel Adapter’s Upsert method.

                The basic format for the value entry is as follows:

                • Service/Method/Argument;Argument;

                • /Method/Argument;Argument;

                • Service, method, and argument are separated by a slash (/).

                • Each argument ends with a semicolon (;).

                • The default Service name is EAI Siebel Adapter.

                • The default argument name is SiebelMessage.

                  FINS ACORD XML Data Transformation Engine

                  You do not have to provide any new values in the pre-built business service.

                    FINS ACORD XML Converter

                    Please set the user property values according to the following table. These values will appear in the pre-header section of an ACORD message.

                    Name Value

                    XMLEnvIntObjectName

                    NewDefaultEnv (Just created by the Wizard)

                    EscapeNames

                    TRUE

                    PI_Parameter:version

                    v1.0.0 (ACORD version)

                    PI_Parameter:newfileuid

                    (default empty)

                    PI_Parameter:oldfileuid

                    (default empty)

                    PI_Type

                    ACORD

                      FINS ACORD XML Dispatcher

                      Two user properties need to be set to new values for your specific case, as listed in the following table. In the dispatcher user properties, fill in the names of the dispatcher map and envelope integration objects that are created by FINS ACORD Wizard.

                      Name Value

                      DispatcherMapName

                      ACORDDispMap

                      XMLEnvIntObjectName

                      NewDefaultEnv

                      XMLFaultObject_0

                      //IOI/MsgStatus/MsgErrorCd

                        Configuring the Data Transformation Maps

                        Configuring the integration objects associates the fields in an internal integration object with the message elements in an external integration object. The result is the creation of the DTE map that will be used by the data transformation engine.

                        All entries created by the wizard are stored in the Integration Object User Properties of the Dispatcher Map.

                        In the example, there are four maps that need to be configured to have a complete outbound/inbound transaction route available. Each one can be found in the user properties entry in the ACORDDispMap dispatcher map integration object.

                        The integration object for the server entry is ACORD/InsuranceSvcRq/PersAutoPolicyAddRq, and it has two maps, as follows:

                        • PersAutoPolicyAddRq_ErqIRqMapIn (server receiving an inbound request)

                        • PersAutoPolicyAddRq_IrsERsMapOut (server sending an inbound response)

                        The integration object for the client is ACORD/InsuranceSvcRs/PersAutoPolicyAddRs, and it has two maps, as follows:

                        • PersAutoPolicyAddRs_IRqERqMapOut (client sending an outbound request)

                        • PersAutoPolicyAddRs_ErsIRsMapIn (client receiving an outbound response)

                        If you wish, you can change the map name in the Dispatcher Map list, then use the new name for the DTE map.

                        To configure the DTE map

                        1. Start Siebel Financial Services.

                        2. Navigate to the Administration - Integration screen, then Data Map Editor, and then Integration Object Map view.

                        3. In the Integrated Object Map applet, create a new map.

                          • Name. This name must be the same as the DTE map name created by the wizard and stored in the Dispatcher Map list.

                        4. Select the Internal Integration Object and the External Integration Object.

                          These objects have been created during the process of creating the integration objects with the wizard. Keep the following definitions in mind:

                          • Source Object. For an message that will be sent out, the source object is the internal integration object; for a message that will be received, the source object is the external integration object.

                          • Target Object. For a message that will be sent out, the target object is the external integration object; for a message that will be received, the target object is the internal integration object.

                        5. Map the source components and the target components.

                        6. Map fields to fields.

                          For detailed information, see the following Siebel EAI documents: the chapter on creating and using dispatch rules in Siebel Financial Services Enterprise Application Integration Guide, and the chapter on data mapping and the data mapper in Business Processes and Rules: Siebel Enterprise Application Integration.

                        Configuring the Workflow Process

                        The example in this section shows how to create an outbound workflow and an inbound workflow that handle an ACORD XML message.

                          Configuring an Outbound Siebel Connector for ACORD XML

                          The following procedure shows how to construct a workflow to handle an outbound message.

                          To create an outbound connector

                          1. Start Siebel Financial Services.

                          2. Navigate to the Administration - Business Process screen, then Workflow Processes, and then Workflow Processes view.

                          3. Create a new record in the Workflow Processes view.

                            The keyboard shortcut is CTRL+N.

                          4. Give the workflow a name.

                            The name must be unique within the project. The other values are optional, so for this example, they remain blank.

                            In the example, the name is ACORD Add Auto Policy Outbound Workflow. The complete workflow is included in Sample Workflows.

                          5. Click the Process Designer tab.

                            The Process Designer provides a blank working space onto which you will move the step symbols and connectors that create the workflow.

                            For complete details about using this working space, and information about workflows in general, see Siebel Business Process Framework: Workflow Guide.

                          6. Move Start, Stop, and Business Service steps onto the work area, and name them appropriately.

                          7. Use connector arrows to connect the Start and Business Service steps.

                            Continue until you have created a workflow with the required components. The following image shows the structure of the finished workflow: FINS ACORD XML Transaction Manager, FINS ACORD XML DTE, FINS ACORD XML Converter, XML Hierarchy Converter.

                            ACORD Add Auto Policy Outbound Workflow. This image is described in surrounding text.

                            Adding Process Property Values

                            You need to create Process Property values for the workflow, to be used in later configurations.

                            To create process properties
                            1. Click the Process Properties tab.

                            2. Enter the values shown in the following table.

                            Name Data Type Default String

                            ACORD Client Application Name

                            String

                            Siebel Financial Services

                            ACORD Client Application Operation

                            String

                            Oracle

                            ACORD Client Application Version

                            String

                            8.0

                            ACORD DOCTYPE

                            String

                            ACORD DispMap Integration Object Name

                            String

                            ACORDDispMap

                            ACORD Message Full Name

                            String

                            ACORD/InsuranceSvcRs/PersAutoPolicyAddRs

                            ACORD Service Provider Name

                            String

                            Siebel Partner

                            ACORD Signoff

                            String

                            FALSE

                            Error Code

                            String

                            Error Message

                            String

                            Object Id

                            String

                            PropSet Converter Out

                            Hierarchy

                            PropSet DTE Out

                            Hierarchy

                            PropSet TransMgr Out

                            Hierarchy

                            SiebelFINSOperation Out

                            String

                            SARowIdQuery

                            XML Document

                            String

                            initsignon

                            String

                            initsignon

                            sessionsignon

                            String

                            sessionsignon

                            signoffRq

                            String

                            signoffRq

                              Configuring the FINS ACORD XML Transaction Manager

                              Now that the workflow structure exists, you can configure the components. The first outbound component is the transaction manager.

                              To configure the transaction manager
                              1. Name the transaction manager appropriately (it must be unique within the workflow).

                              2. Choose the type of business service from the multi-value group (MVG) window.

                                For this component, choose the FINS ACORD XML Transaction Manager.

                              3. Choose the method.

                                The example uses the Execute Outbound method because the data is being sent out from the Siebel data source.

                              4. Establish the input and output arguments.

                                As for all Siebel business services, create a new record (CTRL+N) for a new argument. Select from the available input arguments. Add all required arguments first, then go on to any optional arguments. See Siebel Connector for ACORD XML for input and output specifications.

                                The following are the input argument settings for the example transaction manager configuration.

                                Input Arguments Type Value Property Name Property Data Type

                                DispatcherMapName

                                Process Property

                                ACORD DispMap Integration Object Name

                                String

                                IXMLMapPath

                                Process Property

                                ACORD Message Full Name

                                String

                                PrimaryRowId

                                Process Property

                                Object Id

                                String

                                SiebelFINSOperationOut

                                Process Property

                                SiebelFINSOperationOut

                                String

                                The following are the output argument settings for the example transaction manager configuration.

                                Property Name Type Value Output Argument

                                PropSet TransMgr Out

                                Output Argument

                                XML Hierarchy

                                Configuring the FINS ACORD XML Data Transformation Engine

                                The second component is the data transformation engine (DTE).

                                To configure the DTE
                                1. Name the DTE appropriately (it must be unique within the workflow).

                                2. Choose the type of business service from the multi-value group (MVG) window.

                                  For this component, choose the FINS ACORD XML DTE.

                                3. Choose the method.

                                  The example uses the Transform to External Hierarchy method because the data is moving from a Siebel internal system to an external system.

                                4. Set the input and output arguments.

                                  These arguments include the DTE map name, created during the configuration of the internal and external integration objects.

                                  The following are the input argument settings for the example DTE configuration.

                                  Input Arguments Type Value Property Name Property Data Type

                                  XML Property Set

                                  Process Property

                                  PropSet TransMgr Out

                                  Hierarchy

                                  The following are the output argument settings for the example DTE configuration.

                                  Property Name Type Value Output Argument

                                  PropSet DTE Out

                                  Output Argument

                                  XML Property Set

                                  Configuring the FINS ACORD XML Converter

                                  The third component is the converter.

                                  To configure the converter
                                  1. Name the converter appropriately (it must be unique within the workflow).

                                  2. Choose the type of business service from the multi-value group (MVG) window.

                                    For this component, choose the FINS ACORD XML Converter.

                                  3. Choose the method.

                                    The example uses PropSetToXMLPropSet because the converter is converting a property set from the DTE into a standard XML property set.

                                  4. Set the input and output arguments.

                                    The following are the input argument settings for the example converter configuration.

                                    Input Argument Type Value Property Name Property Data Type

                                    Client Application Name

                                    Process Property

                                    ACORD Client Application Name

                                    String

                                    Client Application Operation

                                    Process Property

                                    ACORD Client Application Operation

                                    String

                                    Client Application Version

                                    Process Property

                                    ACORD Client Application Version

                                    String

                                    Is Signoff

                                    Process Property

                                    ACORD Signoff

                                    String

                                    Service Provider Name

                                    Process Property

                                    ACORD Service Provider Name

                                    String

                                    XML Property Set

                                    Process Property

                                    PropSet DTE Out

                                    Hierarchy

                                    initsignon

                                    Process Property

                                    initsignon

                                    String

                                    sessionsignon

                                    Process Property

                                    sessionsignon

                                    String

                                    signoffRq

                                    Process Property

                                    signoffRq

                                    String

                                    The following are the output argument settings for the example converter configuration.

                                    Property Name Type Value Output Argument

                                    PropSet Converter Out

                                    Output Argument

                                    XML Property Set

                                    Configuring an XML Hierarchy Converter

                                    The fourth component is a hierarchy converter. For information about Siebel hierarchy converters, see XML Reference: Siebel Enterprise Application Integration.

                                    To configure an XML hierarchy converter
                                    1. Name the hierarchy converter appropriately (it must be unique within the workflow).

                                    2. Choose the type of business service from the multi-value group (MVG) window.

                                      For this component, choose the XML Hierarchy Converter.

                                    3. Choose the method.

                                      This example uses the XML Hierarchy to XML Document method because, for an outgoing message, the final conversion is from an XML hierarchy to an XML document that can be accepted by any XML-compliant converter at the external location.

                                    4. Set the input and output arguments, XML Hierarchy name, and XML document name.

                                      The following are the input argument settings for the example hierarchy converter configuration.

                                      Input Argument Type Value Property Name Property Data Type

                                      XML Header Text

                                      Process Property

                                      ACORD DOCTYPE

                                      String

                                      XML Hierarchy

                                      Process Property

                                      PropSet Converter Out

                                      Hierarchy

                                      The following are the output argument settings for the example hierarchy converter configuration.

                                      Property Name Type Value Output Argument

                                      XML Document

                                      Output Argument

                                      XML Document

                                      Configuring a Transport Mechanism (Optional)

                                      The fifth component is a transport mechanism. Although not shown on the diagram, this example uses the MQSeries transport. For information about transport mechanisms supported by Oracle, see Transports and Interfaces: Siebel Enterprise Application Integration.

                                      To configure an MQSeries transport
                                      1. Name the transport component appropriately (it must be unique within the workflow).

                                      2. Choose the type of business service from the multi-value group (MVG) window.

                                        For this component, choose the EAI MQSeries Server Transport.

                                      3. Choose the method.

                                        This example uses the Send method.

                                      4. Set the input and output arguments, including the Physical Queue Name, the Queue Manager Name, and the Message Text.

                                        The following are the input argument settings for the example MQSeries transport configuration.

                                        Input Argument Type Value Property Name Property Data Type

                                        Message Text

                                        Process Property

                                        XML Document

                                        String

                                        Physical Queue Name

                                        Literal

                                        TO_ACORD_QUEUE

                                        Queue Manager Name

                                        Literal

                                        SHAN

                                        This step completes the outbound workflow. The outbound ACORD XML connector can be used as the basis for any workflow that is used to send an outbound request message.

                                        Configuring an Inbound Siebel Connector for ACORD XML

                                        For an inbound message, one that originates in an external application, the following shows the structure of a workflow that receives a request and sends back a response. The example workflow is the ACORD Server Policy Package Workflow included in the sample workflows.

                                        ACORD Server Policy Package Workflow. This image is described in surrounding text.

                                        The steps in this workflow are as follows:

                                        1. Convert XML Hierarchy (Dummy Conv Req ErrHdl)
                                          • FINS ACORD XML Dispatcher (Incoming). (Dispatch Err Handler)

                                          • FINS ACORD XML Converter (Incoming) (Conv Inside ErrHdl)

                                          • FINS ACORD XML DTE (Incoming) (DTE InsideErrHdl)

                                          • FINS ACORD XML Transaction Manager (TraMgrErrHdl)

                                        2. FINS ACORD XML DTE (Outgoing) (DTE RespErrHdl)

                                          • FINS ACORD XML Converter (Outgoing) (ConvResp ErrHdl)

                                          • XML Hierarchy Converter (Outgoing) Dummy ConvRespErrHdl

                                        3. ErrorHandler

                                        4. ErrorCnv

                                        Note: The error handling conditions and business services (for example ErrorHandler and ErrorCnv) on the side of the diagram are necessary to handle any rare processing errors. The sample workflow provides information about how they are configured.

                                          Adding Process Property Values

                                          You need to create Process Property values for the workflow, to be used in later configurations.

                                          To create process properties
                                          1. Click the Process Properties tab.

                                          2. Enter the values shown in the following image.

                                            Name Data Type Default String

                                            <Value>

                                            String

                                            <Value>

                                            ACORD Client Application Name

                                            String

                                            Siebel Financial Services

                                            ACORD Client Application Operation

                                            String

                                            Oracle

                                            ACORD Client Application Version

                                            String

                                            8.0

                                            ACORD DOCTYPE

                                            String

                                            ACORD DispMap Integration Object Name

                                            String

                                            ACORDDispMap

                                            ACORD Envelope Integration Object Name

                                            String

                                            Newdefault

                                            ACORD Service Provider Name

                                            String

                                            Siebel Partner

                                            ACORD Signoff

                                            String

                                            FALSE

                                            Error Code

                                            String

                                            Error Message

                                            String

                                            IsClient

                                            String

                                            FALSE

                                            Object Id

                                            String

                                            PropSet Converter Out (Incoming)

                                            Hierarchy

                                            PropSet Converter Out (Outgoing)

                                            Hierarchy

                                            PropSet DTE Out (Incoming)

                                            Hierarchy

                                            PropSet DTE Out (Outgoing)

                                            Hierarchy

                                            PropSet Dispatcher Out (Incoming)

                                            Hierarchy

                                            PropSet TransMgr Out (Outgoing)

                                            Hierarchy

                                            PropSet XML Converter Out (Incoming)

                                            Hierarchy

                                            SiebelFINSOperation

                                            String

                                            SignonRsEcho

                                            Hierarchy

                                            XML Document Response

                                            String

                                            Configuring an XML Hierarchy Converter (Incoming)

                                            The first connector component in the inbound sequence is a hierarchy converter. For information about Siebel hierarchy converters, see XML Reference: Siebel Enterprise Application Integration.

                                            To configure an XML hierarchy converter
                                            1. Name the hierarchy converter appropriately (it must be unique within the workflow).

                                            2. Choose the type of business service from the multi-value group (MVG) window.

                                              For this component, choose the XML Hierarchy Converter.

                                            3. Choose the method.

                                              This example uses the XML Document to XML Hierarchy method because, for an incoming message, the conversion is from an XML document to an XML hierarchy that can be used by the FINS ACORD XML Dispatcher.

                                            4. Set the input and output arguments, XML Hierarchy name, and XML document name.

                                              The following are the input argument settings for the example hierarchy converter incoming configuration.

                                              Input Argument Type Value Property Name Property Data Type

                                              XML Document

                                              Process Property

                                              <Value>

                                              String

                                              The following are the output argument settings for the example hierarchy converter incoming configuration.

                                              Property Name Type Value Output Argument

                                              PropSet XML Converter Out (Incoming)

                                              Output Argument

                                              XML Hierarchy

                                              Configuring the FINS ACORD XML Dispatcher (Incoming)

                                              The second connector component is the dispatcher.

                                              To configure the dispatcher
                                              1. Name the dispatcher appropriately (it must be unique within the workflow).

                                              2. Choose the type of business service from the multi-value group (MVG) window.

                                                For this component, choose the FINS ACORD XML Dispatcher.

                                              3. Choose the method.

                                                The example uses the Dispatch Message method.

                                              4. Set the input and output arguments.

                                                The following are the input argument settings for the example dispatcher incoming configuration.

                                                Input Argument Type Value Property Name Property Data Type

                                                DispatcherMapName

                                                Process Property

                                                ACORD DispMap Integration Object Name

                                                String

                                                XMLEnvIntObjectName

                                                Process Property

                                                ACORD Envelope Integration Object Name

                                                String

                                                XML Property Set

                                                Process Property

                                                PropSet XML converter Out (Incoming)

                                                Hierarchy

                                                The following are the output argument settings for the example dispatcher incoming configuration.

                                                Property Name Type Value Output Argument

                                                PropSet Dispatcher Out (Incoming)

                                                Output Argument

                                                XML Property Set

                                                Configuring the FINS ACORD XML Converter (Incoming)

                                                The third connector component is the converter.

                                                To configure the converter
                                                1. Name the converter appropriately (it must be unique within the workflow).

                                                2. Choose the type of business service from the multi-value group (MVG) window.

                                                  For this component, choose the FINS ACORD XML Converter.

                                                3. Choose the method.

                                                  The example uses XMLPropSetToPropSet, because the converter is converting an XML property set from the dispatcher into a Siebel-hierarchy-based property set.

                                                4. Set the input and output arguments.

                                                  The following are the input argument settings for the example converter incoming configuration.

                                                  Input Argument Type Value Property Name Property Data Type

                                                  IsClient

                                                  Process Property

                                                  IsClient

                                                  String

                                                  XMLEnvIntObjectName

                                                  Process Property

                                                  ACORD Envelope Integration Object name

                                                  String

                                                  XML Property Set

                                                  Process Property

                                                  PropSet Dispatcher Out (Incoming)

                                                  Hierarchy

                                                  The following are the output argument settings for the example converter incoming configuration.

                                                  Property Name Type Value Output Argument

                                                  PropSet Converter Out (Incoming)

                                                  Output Argument

                                                  XML Property Set

                                                  SignonRsEcho

                                                  Output Argument

                                                  SignonRsEcho

                                                  Configuring the FINS ACORD XML Data Transformation Engine (Incoming)

                                                  The fourth connector component is the data transformation engine (DTE).

                                                  To configure the DTE
                                                  1. Name the DTE appropriately (it must be unique within the workflow).

                                                  2. Choose the type of business service from the multi-value group (MVG) window.

                                                    For this component, choose the FINS ACORD XML DTE.

                                                  3. Choose the method.

                                                    The example uses the Transform to Siebel Hierarchy method because the data is moving from an external system to a Siebel internal system.

                                                  4. Set the input and output arguments.

                                                    The following are the input argument settings for the example DTE incoming configuration.

                                                    Input Argument Type Value Property Name Property Data Type

                                                    XML Property Set

                                                    Process Property

                                                    PropSet Converter Out (Incoming)

                                                    Hierarchy

                                                    The following are the output argument settings for the example DTE incoming configuration.

                                                    Property Name Type Value Output Argument

                                                    PropSet DTE Out (Incoming)

                                                    Output Argument

                                                    XML Property Set

                                                    Configuring the FINS ACORD Transaction Manager

                                                    The fifth connector component is the transaction manager.

                                                    To configure the transaction manager
                                                    1. Name the transaction manager appropriately (it must be unique within the workflow).

                                                    2. Choose the type of business service from the multi-value group (MVG) window.

                                                      For this component, choose the FINS ACORD XML Transaction Manager.

                                                    3. Choose the method.

                                                      The example uses the Execute Transaction method because the data is being received from the external data source and must be delivered to the Siebel application.

                                                    4. Establish the input and output arguments.

                                                      The following are the input argument settings for the example transaction manager configuration. Notice that the data flow within the connector changes direction at this point from incoming to outgoing.

                                                      Input Argument Type Value Property Name Property Data Type

                                                      Only product Integration Object Instance

                                                      Literal

                                                      true

                                                      Report Error in Message

                                                      Literal

                                                      true

                                                      Rollback In Error

                                                      Literal

                                                      false

                                                      SiebelFINSOperationOut

                                                      Process Property

                                                      Siebel FINS Operation

                                                      String

                                                      Status Object

                                                      Literal

                                                      true

                                                      XML Property Set

                                                      Process Property

                                                      PropSet DTE Out (Incoming)

                                                      Hierarchy

                                                      The following are the output argument settings for the example transaction manager configuration.

                                                      Property Name Type Value Output Argument

                                                      PropSet TransMgr Out (Outgoing)

                                                      Output Argument

                                                      XML Property Set

                                                      Configuring the FINS ACORD XML Data Transformation Engine (Outgoing)

                                                      The sixth connector component is the data transformation engine (DTE).

                                                      To configure the DTE
                                                      1. Name the DTE appropriately (it must be unique within the workflow).

                                                      2. Choose the type of business service from the multi-value group (MVG) window.

                                                        For this component, choose the FINS ACORD XML DTE.

                                                      3. Choose the method.

                                                        The example uses the Transform to External Hierarchy method because the data is moving from the Siebel internal system to an external system.

                                                      4. Set the input and output arguments.

                                                        The following are the input argument settings for the example DTE outgoing configuration.

                                                        Input Argument Type Value Property Name Property Data Type

                                                        XML Property Set

                                                        Process Property

                                                        PropSet TransMgr Out (Outgoing)

                                                        Hierarchy

                                                        The following are the output argument settings for the example DTE outgoing configuration.

                                                        Property Name Type Value Output Argument

                                                        PropSet DTE Out (Outgoing)

                                                        Output Argument

                                                        XML Property Set

                                                        Configuring the FINS ACORD XML Converter (Outgoing)

                                                        The seventh connector component is the converter.

                                                        To configure the converter
                                                        1. Name the converter appropriately (it must be unique within the workflow).

                                                        2. Choose the type of business service from the multi-value group (MVG) window.

                                                          For this component, choose the FINS ACORD XML Converter.

                                                        3. Choose the method.

                                                          The example uses PropSetToXMLPropSet because the converter is converting a property set from the DTE into a standard XML property set.

                                                        4. Set the input and output arguments.

                                                          The following are the input argument settings for the example converter outgoing configuration.

                                                          Input Argument Type Value Property Name Property Data Type

                                                          Client Application Name

                                                          Process Property

                                                          ACORD Client Application Name

                                                          String

                                                          Client Application Organization

                                                          Process Property

                                                          ACORD Client Application Organization

                                                          String

                                                          Client Application Version

                                                          Process Property

                                                          ACORD Client Application Version

                                                          String

                                                          Is Client

                                                          Process Property

                                                          IsClient

                                                          String

                                                          Is Signoff

                                                          Process Property

                                                          ACORD Signoff

                                                          String

                                                          Service Provider Name

                                                          Process Property

                                                          ACORD Service Provider Name

                                                          String

                                                          SignonRsEcho

                                                          Process Property

                                                          SignonRsEcho

                                                          Hierarchy

                                                          XMLEnvIntObjectName

                                                          Process Property

                                                          ACORD Envelope Integration Object

                                                          String

                                                          XML Property Set

                                                          Process Property

                                                          PropSet DTE Out (Outgoing)

                                                          Hierarchy

                                                          The following are the output argument settings for the example converter outgoing configuration.

                                                          Property Name Type Value Output Argument

                                                          PropSet Converter Out (Outgoing)

                                                          Output Argument

                                                          XML Property Set

                                                          Configuring an XML Hierarchy Converter (Outgoing)

                                                          The eighth connector component is a hierarchy converter. For information about Siebel hierarchy converters, see XML Reference: Siebel Enterprise Application Integration.

                                                          To configure an XML hierarchy converter
                                                          1. Name the hierarchy converter appropriately (it must be unique within the workflow).

                                                          2. Choose the type of business service from the multi-value group (MVG) window.

                                                            For this component, choose the XML Hierarchy Converter.

                                                          3. Choose the method.

                                                            This example uses the XML Hierarchy to XML Document method because, for an outgoing message, the final conversion is from an XML hierarchy to an XML document that can be accepted by any XML-compliant converter at the external location.

                                                          4. Set the input and output arguments, XML Hierarchy name, and XML document name.

                                                            The following are the input argument settings for the example hierarchy converter outgoing configuration.

                                                            Input Argument Type Value Property Name Property Data Type

                                                            XML Header Text

                                                            Process Property

                                                            ACORD DOCTYPE

                                                            String

                                                            XML Hierarchy

                                                            Process Property

                                                            PropSet Converter Out (Outgoing)

                                                            Hierarchy

                                                            The following are the output argument settings for the example hierarchy converter outgoing configuration.

                                                            Property Name Type Value Output Argument

                                                            <Value>

                                                            Output Argument

                                                            XML Document

                                                            This step completes the inbound workflow. The inbound ACORD XML connector can be used as the basis for any workflow that is used to receive an inbound request message.

                                                            Configuring Runtime Events

                                                            Oracle supports triggering workflows based on runtime events. Using a runtime event allows you to incorporate configured workflow functions into actual applications. For complete information about runtime events, see Siebel Events Management Guide.

                                                            The example in this section describes a runtime event that adds an auto policy when the Sub Status field changes in an INS Policy business component record. In the following procedure, a runtime event is defined and linked to an action that starts the example outbound workflow. It sends the active record as an ACORD XML message in the example connector.

                                                            To create a runtime event

                                                            1. Start the Siebel client.

                                                            2. Navigate to the Administration - Runtime Events screen, then Events, and then Events view.

                                                            3. Create a new event record, and enter the following values:

                                                              • Action Set Name = ACORDDemo

                                                              • Object Type = BusComp

                                                              • Object Name = INS Policy

                                                              • Event = SetFieldValue

                                                              • Subevent = Sub Status

                                                            4. Enter the following condition expression:

                                                              ([Sub Status] = LookupValue (‘INS_POLICY_SUBSTATUS’, ‘Submitted’))

                                                              This expression instructs the Siebel application to initiate the action set ACORDDemo when the Sub Status field value changes to Submitted. Typically, this will occur when the user selects Submitted from the value list.

                                                            5. Create a new record for Action Sets/Actions, with the following parameters:

                                                              • Actions Type = BusService

                                                              • Business Service Name = Workflow Process Manager

                                                              • Business Service Method = RunProcess

                                                              • Business Service Context = “ProcessName,” ACORD Add Auto Policy Outbound Workflow (the name of the configured workflow that handles outbound messages).

                                                            Configuring Server Tasks

                                                            A server task is an instantiation of a server component. To run a server task, you need to run a component request, which will request that one or more server tasks run.

                                                            The following example describes how to configure a server task for the EAI MQSeries Server Transport. The Siebel EAI MQSeries Server Transport is designed to provide a messaging solution to help you integrate data between Oracle’s Siebel Business Applications and external applications that can interface with the IBM MQSeries. The IBM MQSeries Server Transport transports messages to and from IBM MQSeries queues.

                                                            In order to run this server task successfully you need to first configure two named subsystems.

                                                            To configure named subsystems

                                                            1. Start the Siebel client.

                                                            2. Navigate to the Administration - Server Configuration screen, then Profile Configuration, and then Profile Configuration view.

                                                            3. Create a new record in the Component Profiles list and provide the required information.

                                                              • Name. Name of the named subsystem, for example ACORDMQConnSubsys

                                                              • Type. Type of the named subsystem, MQSeriesServerSubsys

                                                              Note: The subsystem type that you select should have a checkmark in the Is Named Enabled field.
                                                            4. Save the record.

                                                            5. In the Enterprise Profile Configuration list, modify parameters.

                                                              • MqPhysicalQueueName. <Queue name from which to receive inbound request message>

                                                              • MqQueueManagerName. <Name of the queue manager who owns the queues>

                                                              • MqRespPhysicalQueueName. <Queue name to which to send the response message>

                                                              • MqSleepTime. 100 <or longer if needed>

                                                            6. Save the record.

                                                            7. Create another Named Subsystem with the following name and parameters:

                                                              • Name. Name of the named subsystem, for example ACORDMQDataSubsys

                                                              • Type. EAITransportDataHandlingSubsys

                                                            8. Save the record.

                                                            9. In the Enterprise Profile Configuration list, modify the parameters.

                                                              • DispatchWorkflowProcess. ACORD Server Party Package Workflow

                                                            After creating and configuring the named subsystems, you need to configure MQSeries Receiver.

                                                            To configure MQSeries Receiver

                                                            1. Start the Siebel client.

                                                            2. Navigate to the Administration - Server Configuration screen, then Enterprises, and then Component Definitions view.

                                                            3. Query for MQSeries Server Receiver and set the following:

                                                              • Receiver Connection Subsystem. ACORDMQConnSubsys <the name from step 4 in the previous procedure>

                                                              • Receiver Data Handling Subsystem. ACORDMQDataSubsys <the name from step 8 in the previous procedure>

                                                              • Receiver Method Name. ReceiveDispatch <or ReceiveDispatchSend>

                                                              • Default Tasks. 1 <or number of tasks desired>

                                                            4. Restart the Siebel server and make sure that the MQSeries Server Receiver server component is running.

                                                            Note: For details on creating and configuring server tasks, see Siebel System Administration Guide and for details on configuring MQSeries, see Transports and Interfaces: Siebel Enterprise Application Integration.

                                                            Sample Workflows

                                                            This chapter has provided an example configuration roadmap. To demonstrate the entire process, the ACORD Policy Package is included in the sample database for Oracle’s Siebel Financial Services. The package contains all the workflows, integration objects and DTE Maps needed. The package supports the following functions:

                                                            • Sending out standard ACORD request messages from a Siebel client application to add (Add) or query (Inquiry) ACORD-compatible insurance policy records.

                                                            • The messages can be sent from the Auto Policies view, the Property Policies view, and the PUL Policies view.

                                                            • For a Siebel server receiving an ACORD request message (from step 1), executing the proper database transaction and sending back a standard ACORD response message.

                                                            • For a Siebel client application receiving an ACORD response message (from step 2), executing the proper database transaction.

                                                            The package includes the following integration objects:

                                                            • Data Transformation Maps (DTE maps)

                                                            • Including 24 Maps for Siebel ACORD Policy Messages

                                                            The package includes several workflows to minimize your custom configuration tasks. These workflows can be used as templates to customize or configure to become your own workflows.

                                                            Workflows are categorized as follows:

                                                            Clients: Ready for use

                                                            • ACORD Client Auto Policy Package Workflow (comprehensive)

                                                              • ACORD Add Auto Policy Outbound Workflow

                                                              • ACORD Inquiry Auto Policy Outbound Workflow

                                                            • ACORD Client Home Policy Package Workflow (comprehensive)

                                                              • ACORD Add Home Policy Outbound Workflow

                                                              • ACORD Inquiry Home Policy Outbound Workflow

                                                            • ACORD Client PUL Policy Package Workflow (comprehensive)

                                                              • ACORD Add PUL Policy Outbound Workflow

                                                              • ACORD Inquiry PUL Policy Outbound Workflow

                                                            • ACORD Policy Outbound Response Workflow No Rollback

                                                            • ACORD Policy Outbound Response Workflow With Rollback

                                                            Server: Ready for use

                                                            • ACORD Server Policy Package Workflow