11Installing SOA Composites and Configuring This Integration

Installing SOA Composites and Configuring This Integration

This chapter describes how to install Service-Oriented Architecture (SOA) composites for Siebel Field Service Integration to Oracle Real-Time Scheduler. It includes the following topics:

Preparing to Install SOA Composites

This task is a step in Process of Installing SOA Composites for This Integration.

You must first make sure your environment is prepared to install SOA composites for this integration.

To prepare to install SOA composites

  1. Make sure the following products or product suites are installed:

    • Oracle Fusion Middleware, version 11g, including Oracle SOA Suite PS4 and Oracle WebLogic Server.

      For more information, see Documentation Sources for Configuring Oracle Real-Time Scheduler.

    • Oracle Database versions that Siebel Business Applications and Oracle Real-Time Scheduler support.

      For more information, see the appropriate database installation documentation on Oracle Technology Network.

    • Siebel Business Applications, including Siebel Service. For more information, see the following resources:

      • Books that support your Siebel application. These books reside on the Siebel Bookshelf on Oracle Technology Network.

      • Installation documentation for all applicable patch releases on My Oracle Support.

    • Oracle Real-Time Scheduler, version 2.1 and 2.3.

      For more information, see Documentation Sources for Configuring Oracle Real-Time Scheduler.

  2. Make sure Oracle WebLogic Server is installed and running.

  3. Make sure the following items are installed and running:

    • Oracle SOA Server

    • (Optional) Oracle Business Activity Monitoring (BAM) Server

    Configuring Data Sources on the Oracle Web Logic Server

    You use the Oracle WebLogic Server to create the Java Database Connectivity (JDBC) data source for the Siebel database. To query the Siebel database in some of the integration processes, the DbAdapter server component uses this data source. Example processes include the service region migration to Oracle Real-Time Scheduler and retrieving geocodes for multiple addresses. SOA provides the DbAdapter server component as a way to connect to the Siebel database.

    To configure the data sources on the Oracle WebLogic Server Console

    1. Log in to the Oracle WebLogic server console.

    2. Navigate to Services, JDBC, and then Data Sources.

    3. To create a new data source, click New.

    4. Provide the following details:

      • Data Source Name

      • JNDI Name

      • Database Type

      • Database Driver

    5. Click Next.

    6. Make sure the Support Global Transactions option does not contain a check mark.

    7. Click Next, and then specify the following details for the Siebel data source:

      • Database Name

      • Host Name

      • Port

      • Database Table Owner User Name and Password

    8. Click Next, and then click Next again.

    9. Choose the relevant target servers to which you are deploying.

      For example, the administration server, BAM server, and the SOA server.

    10. Click Finish.

    11. Navigate to Services, JDBC, and then Data Sources.

    12. Choose the data source you created in Step 3.

    13. Click the Connection Pool tab.

    14. Change the maximum capacity from 15 to 100.

      Configuring the Database Adapter on the Oracle Web Logic Server

      This task is a step in Process of Installing SOA Composites for This Integration.

      To configure the database adapter on the Oracle WebLogic Server

      1. In the Oracle WebLogic Server Console, open the Application Server Navigator window.

      2. Create an outbound connection pool:

        1. Click Deployments under Domain Structure, and then click DbAdapter.

        2. Navigate to the Configuration Tab, and then Outbound Connection Pool.

        3. Click New.

        4. Click Connection Factory.

        5. Click Next.

        6. Specify the JNDI name as eis/DB/Siebel_DB.

        7. Click Finish.

          The Oracle WebLogic server console creates an outbound connection pool for the connection group.

        8. Save the plan into the Plan.xml file.

          It is strongly recommended that you store the Plan.xml file in a separate folder. For example, create a folder named DBPlan in the MiddlewareHome/OracleSOAHome/soa folder. Using this technique allows multiple files named Plan.xml to exist. For example, one file for JMS, one file for File, and one file for BAM.

      3. Configure the database adapter:

        1. Navigate to Deployments.

        2. Click DbAdapter.

        3. Navigate to Configuration, and then Outbound Connection Pool.

        4. Expand the Connection Factory tree.

        5. Click the Java Naming and Directory Interface (JNDI) name of the connection pool you created in Step 2.

        6. Navigate to Properties.

        7. In the Property Value for the dataSourceName property, enter the JNDI name of the Siebel data source.

        8. Save your changes and then update DbAdapter.

      4. Restart the Oracle WebLogic Server, the BAM server, and the SOA server.

        Configuring the BPEL Timeout Setting on the Oracle Web Logic Server

        This task is a step in Process of Installing SOA Composites for This Integration.

        In this topic, you set a BPEL timeout that supports this integration.

        To configure the BPEL timeout setting on the Oracle WebLogic Server

        1. In the Oracle WebLogic Server Console, navigate to Deployments.

        2. Expand the soa-infra tree, and then expand EJBs.

        3. Click BPELEngineBean.

        4. Click the Configuration tab.

        5. Change the transaction timeout from 30 to 3000 or higher.

        6. Click Save.

          Adding User Credentials to the Credential Store

          This task is a step in Process of Installing SOA Composites for This Integration.

          A credential store is a repository that includes security data. It can include user name and password combinations or the public key certificates that allow Oracle Fusion Middleware to access an external system, such as Siebel CRM.

          Some integration flows call Siebel Inbound Web Services, which are secured Web services. You must configure this integration so that it can authenticate with these services. Before calling them, the integration flow extracts credentials from the credential store and then adds them to the SOAP header in the request.

          To add Siebel user credentials to the credential store

          1. Log in to Oracle Enterprise Manager.

          2. Choose Farm from the drop-down list.

          3. Expand the Farm_soa_doman tree, expand the WebLogic Domain tree, and then click soa_domain.

          4. Right-click soa_domain, choose Security, and then choose the Credentials menu item.

            Oracle Enterprise Manager displays the Credentials page.

          5. In the Credentials page, create a credential map:

            1. In the Credential Store Provider section, click Create Map.

            2. In the Create Map dialog box, enter the following map name:

              oracle.wsm.security
              
            3. Click OK.

              Oracle Enterprise Manager displays the new credential map name. It includes a map icon.

          6. Add a key to the credential map that you created in Step 5:

            1. Click Create Key.
            2. In the Create Key dialog box, enter values using information from the following table.

              Field Description

              Select Map

              Choose oracle.wsm.security.

              Key

              Enter SBL_WS_USER.

              Type

              Choose Password.

              User Name

              Enter the name of the Siebel user who is authorized to call a Siebel Web service. For example, SADMIN.

              Password

              Enter the password of the Siebel user who is authorized to call a Siebel Web service.

              Click OK.

              Oracle Enterprise Manager displays the new key under the map icon that identifies the map you chose. For more information, see Administering a Credential Key.

          7. Add another key to the credential map that you created in Step 5:

            1. Click Create Key.
            2. In the Create Key dialog box, enter values using information from the following table.

              Field Description

              Select Map

              Choose oracle.wsm.security.

              Key

              Enter mwm.key.

              Type

              Choose Password.

              User Name

              Enter the name of the Oracle Real-Time Scheduler user who is authorized to call an Oracle Real-Time Scheduler Web service, for example, SYSUSER.

              Password

              Enter the password of the Oracle Real-Time Scheduler user who is authorized to call a Siebel Web service.

              Click OK.

              Oracle Enterprise Manager displays the new key under the map icon that identifies the map you chose. For more information, see Administering a Credential Key.

          8. On the Oracle Fusion Middleware Server, navigate to the Oracle Fusion Middleware configuration directory.

            For example:

            home/eng-sm/unixuser/Oracle/Middleware_11gPS1/user_projects/domains/soa_domain/
            config/fmwconfig
            
          9. Use an XML editor to open the following file:

            system-jazn-data.xml

          10. Add the following code to the system-jazn-data.xml file:

            <grant>
                       <grantee>
                          <principals>
                              <principal>
                                    
            <class>oracle.security.jps.internal.core.principals.JpsAnonymousUserImpl</class>
                                    <name>anonymous</name>
                               </principal>
                               <principal>
                                   
            <class>oracle.security.jps.internal.core.principals.JpsAnonymousUserImpl</class>
                                   <name>anonymous-role</name>
                                </principal>
                           </principals>
                       </grantee>
                       <permissions>
                            <permission>                    
            <class>oracle.security.jps.service.credstore.CredentialAccessPermission</class>
                                
            <name>context=SYSTEM,mapName=oracle.wsm.security,keyName=SBL_WS_USER</name>
                                <actions>read</actions>
                            </permission>
                       </permissions>
                        <permission-set-refs>
                       </permission-set-refs>
                    </grant>
            
          11. Save the system-jazn-data.xml file.

          12. Restart the Oracle Fusion Middleware Server.

            Administering a Credential Key

            You can administer a credential key.

            To administer a credential key
            1. In Oracle Enterprise Manager, navigate to the Credentials page.

            2. Do any of the following:

              • To remove a key or map, click Delete. If you delete a credential map, then Oracle Enterprise Manager deletes all keys in the map.

              • To view or modify the data in a key or map, click Edit.

              • To display credentials for a key, enter the key name in the Credential Key Name window and then click the arrow.

              • To refresh the list of credentials after you examine the results of a query, repeat Step 4 in Adding User Credentials to the Credential Store.

              Deleting Policies from WSM Policies

              Note: This topic is specific to only FMW 12C.

              Few policies must be removed to prevent failing of scenarios related to AdminDataManagement flow. These unrequired policies are getting added to AdminDataManagementFlow.

              To remove policies
              1. Log into Weblogic Enterprise Manager, expand the WebLogic domain, and right-click on your domain, select WebServices>WSM Policies.

              2. Delete the following two policies:

                • oracle/aia_wss_saml_or_username_token_service_policy_OPT_ON

                • oracle/aia_wss10_saml_token_client_policy_OPT_ON

                Granting Credential Map in System Policies

                Note: This topic is specific to only FMW 12C.

                This step is required because the SBL_WS_USER key that stores Siebel credentials is retrieved through Oracle BPEL Java Exec activity in FMW Composite flows for invoking Siebel webservices.

                To grant Credential Map
                1. Log into Weblogic Enterprise Manager, expand the WebLogic domain, and right-click on your domain, select Security>System Policies.

                2. Click on the Create button in System Policies.

                3. In Codebase, enter file:${domain.home}/servers/${weblogic.Name}/dc/- and click Add in Create System Grant.

                4. Select the checkbox Select here to enter details for a new permission.

                5. Enter the following properties:

                  • Permission Class: oracle.security.jps.service.credstore.CredentialAccessPermission

                  • Resource Name: context=SYSTEM, mapName=oracle.wsm.security,keyName=*

                  • Permission Actions: read

                6. Click Ok and Ok again.

                  Compiling and Deploying Oracle Fusion Middleware Artifacts

                  This task is a step in Process of Installing SOA Composites for This Integration.

                  This topic describes how to run scripts that compile and deploy Oracle Fusion Middleware artifacts for this integration.

                  To compile and deploy Oracle Fusion Middleware artifacts

                  1. Prepare to run the installation scripts:

                    1. Install Apache Ant on the computer that you use to run the installation scripts.

                      Apache Ant is a tool you can use to deploy composites on the Oracle Web Logic SOA Server. For more information, see http://ant.apache.org.

                    2. Make sure the PATH environment variable references the binary directory that Ant uses.

                    3. Unzip the SBL_ORS_INTRGv2.zip file.

                      This file is packaged as the Siebel-ORS Integration Connector. Make sure you use the same directory structure that is defined in the zip file.

                    4. Navigate to the SBL_ORS_INTRGv2\build folder.

                    5. Open the build.properties file, and then update the following parameters using values from the following table.

                      The build.properties file contains the properties for the Ant build. Note that all paths in the build.properties file must use the Unix forward slash (/) convention. For example, D:/home/bin.

                      Parameter Description

                      weblogic_admin_server_host

                      Set to the host name for the Oracle WebLogic Server.

                      weblogic_admin_server_port

                      Set to the port of the WebLogic Administration Server.

                      weblogic_soa_mgdserver_name

                      Set to the SOA Server name.

                      weblogic_soa_server_hostname

                      Set to the SOA Server host name.

                      weblogic_soa_server_portnumber

                      Set to the SOA Server port number.

                      weblogic_username

                      Set to the WebLogic User Name that Oracle WebLogic uses for authentication.

                      weblogic_password

                      Set to the WebLogic Password for the authorized user.

                      siebel.version

                      Set to 81, which is the Siebel Version.

                      siebel_server_host

                      Set to the host address of the server where the Siebel Server is installed.

                      java.passed.home

                      Set to the location of the JDK you will use.

                      src.location

                      Set to the location of the integration code. This location is the base directory where you extract the zip file. For example, C:SBL_ORS_INTEGRATION.

                      oracle_home

                      Set to the location of the Oracle Home directory.

                      mw_home

                      Set to the middleware installation base directory.

                  2. Open a command prompt, and then navigate to the SBL_ORS_INTRGv2\build folder.

                  3. At the command prompt, type deployAll, and then press ENTER.

                    This command deploys all the Oracle Fusion Middleware composites and Oracle Metadata Service artifacts. To deploy the composites but not the Oracle Metadata Service artifacts, type ant deployAllComposites at the command prompt.

                    To reverse a deployment, enter ant undeployAll. This command reverses the deployment for all composites and for all Oracle MDS artifacts. For more information, see Ant Commands You Can Use to Compile and Deploy Composites.

                    Ant Commands You Can Use to Compile and Deploy Composites

                    Command Descriptions
                    ant all
                    

                    Compiles and deploys all composites including Oracle Meta Data Services.

                    ant deployAll
                    

                    Deploys all composites including Oracle Meta Data Services.

                    Deploys custom composites according to the following value in the deployCustomExtensionsAlso parameter in the properties file:

                    • Y. Deploys the following composites:

                      • All composites that are listed in the customExtensions parameter

                      • Integration composites

                    • N. Deploys only predefined integration composites. Does not deploy custom composites.

                    ant deployAllComposites
                    

                    Deploys the same items that the deployAll command compiles and deploys except does not compile or deploy Oracle Meta Data Services.

                    ant updateMDS
                    

                    Deploys only the Oracle Meta Data Services artifacts. Does not deploy any composites.

                    ant deployComposite
                    

                    Deploys a specific composite according to the following information that you provide:

                    • Composite name

                    • Location of where the composite resides

                    • Full path of the deployment configuration plan

                    ant deployCompositeWithoutConfigPlan
                    

                    Same as the deployComposite command but you do not provide the path to the deployment configuration plan.

                    ant compileComposite
                    

                    Compiles a specific composite according to the following information that you provide:

                    • Composite name

                    • Location of where the composite resides
                    ant compileAndDeployComposite
                    

                    Compiles and deploys a specific composite according to the following information that you provide:

                    • Composite name

                    • Location of where the composite resides

                    • Full path to the deployment configuration plan

                    ant compileAllCustomComposites
                    

                    Compiles all custom composites according to the composites listed in the properties file.

                    ant deployAllCustomComposites
                    

                    Deploys all custom composites according to the composites listed in the properties file.

                    ant 
                    compileAndDeployAllCustomComposites
                    

                    Compiles and deploys all custom composites according to the composites listed in the properties file.

                    ant undeployAll
                    

                    Undeploys all composites including Oracle Meta Data Services.

                    ant undeployAllComposites
                    

                    Undeploys all composites. Does not undeploy Oracle Meta Data Services.

                    ant undeployMDS
                    

                    Undeploys only Oracle Meta Data Services.

                    ant undeployComposite
                    

                    Undeploys a specific composite according to the composite name that you provide.

                      Oracle Fusion Middleware Projects

                      Projects Descriptions

                      ActivityLatestStateRetrieval_EBF

                      Retrieves the latest status of the activity from Oracle Real-Time Scheduler to Siebel CRM.

                      AdminDataManagment_EBF

                      Provides real-time synchronization of administrative data, including the transfer of employee data records, employee leaves, employee skills, address records, holidays, and so forth.

                      AppointmentBookingSystemSBLORS_EBF

                      Used by the Appointment Booking System. It includes the following functionality:

                      • Book Appointment

                      • Confirm Appointment

                      • Cancel Appointment

                      • Contract Scheduling

                      • Rescheduling

                      • Booking Beyond Scheduling Horizon

                      • Insert Activity

                      • Activity Status Updates

                      BatchGeoCode_EBF

                      Uses the Geocode Server of the Oracle Real-Time Scheduler to retrieve geocodes for multiple addresses. It does the following:

                      • If Oracle Real-Time Scheduler returns a geocode, and if Oracle Real-Time Scheduler does not return multiple geocodes, then the BatchGeoCode_EBF project writes the geocode directly back to the Siebel database.

                      • If Oracle Real-Time Scheduler does not return a geocode, and if Oracle Real-Time Scheduler returns multiple geocodes, then the BatchGeoCode_EBF project writes an error in the Siebel database.

                      RealTimeSingleAddressGeoCoding

                      Allows the Geocode Server of the Oracle Real-Time Scheduler to retrieve a geocode for a single address from Siebel CRM.

                      If Oracle Real-Time Scheduler returns multiple geocodes, then the project displays these geocodes. The RealTimeSingleAddressGeoCoding flow does not directly update the Siebel database.

                      ServiceRegionRollbackFromORS_EBF

                      Reverts back scheduling to Siebel Scheduler for a service region that is scheduled in Oracle Real-Time Scheduler.

                      ServiceRegionCutoverToORS_EBF

                      Transfers a Service Region along with Employees and Activities to be scheduled inOracle Real-Time Scheduler.

                      ShiftWeeklyTemplateMaintenanceSBLORS

                      Provides real-time synchronization of Schedule data including Schedule Hours.

                      StatusUpdateSBLtoORS_EBF

                      Synchronizes the activity status from Siebel CRM to Oracle Real-Time Scheduler.

                      SyncbackDispatcherUpdates_EBF

                      Provides synchronization of Activity Status updates from Oracle Real-Time Scheduler to Siebel CRM.

                      SyncbackShiftBreakPOUDispatcherUpdates_EBF

                      Provides synchronization of Shift, POU, and Break updates from Oracle Real-Time Scheduler to Siebel CRM.

                      SyncbackInactiveDispatcherUpdates_EBF

                      Provides synchronization of Cancelled or Inactive Activity Status updates from Oracle Real-Time Scheduler to Siebel CRM.

                      WorkCalendarMaintenanceSBLORS_EBF:

                      Provides real-time synchronization of Schedule Exception data including Schedule Exception Hours.

                        Projects That the Installation Scripts Deploy

                        The installation scripts deploy the following projects:

                        • ActivityLatestStateRetrieval_EBF

                        • AdminDataManagment_EBF

                        • AppointmentBookingSystemSBLORS_EBF

                        • BatchGeoCode_EBF

                        • RealtimeSingleAddressGeocoding

                        • ServiceRegionRollbackFromORS_EBF

                        • StatusUpdateSBLtoORS_EBF

                        • ServiceRegionCutoverToORS_EBF

                        • ShiftWeeklyTemplateMaintenanceSBLORS_EBF

                        • SyncBackDispatcherUpdates_EBF

                        • SyncBackInactivesDispatcherUpdates_EBF

                        • SyncbackShiftBreakPOUDispatcherUpdates_EBF

                        • WorkCalendarMaintenanceSBLORS_EBF

                          Configuring Domain Value Maps

                          This task is a step in Process of Installing SOA Composites for This Integration.

                          This topic includes the following topics:

                          A domain value map operates on data values. These values transit through the infrastructure at run time. A DVM allows you to map data values that reside in a vocabulary in a given domain to a vocabulary that resides in a different domain.

                          For example, assume a domain represents a city with a long name, such as Los Angeles, while another domain represents a city with the short name for that same city, such as LA. You can use a domain value map to map Los Angeles to LA. A point-to-point mapping is a direct mapping of values between two or more domains. Mapping Los Angeles to LA is an example of a point-to-point mapping.

                            Mapping an Activity Status From Siebel CRM to Oracle Real-Time Scheduler

                            This topic describes how to edit the SBL_to_ORS_ActivityStatusMapping DVM. You can create and configure many different status values for activities in Siebel CRM. However, Oracle Real-Time Scheduler includes a fixed set of predefined status values, each of which Oracle Real-Time Scheduler designs for a particular stage in routing. You must map statuses from the Siebel environment to the corresponding statuses from Oracle Real-Time Scheduler in the middle tier. You can use DVMs to modify and commit changes without having to stop Oracle Fusion Middleware. You use an activity status mapping with status update flows. A field service technician can use the mobile application to change the status of an activity. During an update, this integration uses the appropriate status mapping in the DVM to map the change that the field service technician makes, and then calls Oracle Real-Time Scheduler.

                            Columns You Use to Map an Activity Status

                            To map an activity status, you use the following columns:

                            • Column 1: Siebel

                            • Column 2: ORS

                            Requirements for Mapping an Activity Status

                            If you use the SBL_to_ORS_ActivityStatusMapping DVM, then you must make sure your mapping meets the following requirements:

                            • The data in the Siebel column must be unique. Multiple Siebel statuses can map to the same status in Oracle Real-Time Scheduler. However, there must not be more than one entry in the map with the same Siebel status.

                            • The status is case-sensitive. If the Siebel status is ABC, then a DVM row must exist that includes a Siebel column value of ABC. This integration treats other values as different statuses. Example values include ABC, abc, or any other combination. The same rule applies for Oracle Real-Time Scheduler. Because all valid Oracle Real-Time Scheduler statuses are in upper case, the ORS column must use uppercase and valid status values. This integration treats a case mismatch between a domain value map (DVM) column and the data that the column corresponds to as a status mismatch. This situation can result in a rejected message. For lists of valid activity statuses, see the Documentation Sources for Configuring Oracle Real-Time Scheduler.

                            DVM Entries That Map an Activity Status

                            Siebel Column ORS Column

                            Schedule

                            M1SH

                            Dispatched

                            M1DS

                            Cancelled

                            M1CA

                            Declined

                            M1DC

                            Acknowledge

                            DISPATCHED

                            Enroute

                            M1EN

                            In Progress

                            M1ON

                            Done

                            M1CO

                              Mapping an Activity Status From Oracle Real-Time Scheduler to Siebel CRM

                              This Oracle Real-Time Scheduler integration uses the ORS_to_Siebel_ActivityStatusMapping DVM while it synchronizes an activity status for an activity from Oracle Real-Time Scheduler to Siebel CRM. This integration maps an activity status from Oracle Real-Time Scheduler to Siebel CRM in the following situations:

                              • If the call center agent clicks Refresh Activity to get the latest appointment details

                              • If the activity status is updated to Despatched or Inactive in Oracle Real-Time Scheduler

                              Columns You Use to Map an Activity Status

                              To map a stop status, you use the following columns:

                              • Column 1: ORS

                              • Column 2: Siebel

                              Requirements for Mapping an Activity Status

                              If you use the ORS_to_Siebel_ActivityStatusMapping DVM, then you must make sure your mapping meets the following requirements:

                              • The data in the ORS column must be unique. Multiple Oracle Real-Time Scheduler statuses can map to the same status in Siebel CRM. However, there must not be more than one entry in the map that contains the same status value in the ORS column.

                              • The requirements to map a stop status are the same as the requirements to map an activity status.

                              DVM Entries That Map an Activity Status

                              ORS Column Siebel Column

                              M1SH

                              Schedule

                              M1DS

                              Dispatched

                              M1CA

                              Cancelled

                              M1DC

                              Declined

                              M1EN

                              Enroute

                              M1CO

                              Done

                              M1ON

                              In Progress

                                Mapping a Shift Status From Siebel CRM to Oracle Real-Time Scheduler

                                This Oracle Real-Time Scheduler integration uses the Siebel_to_ORS_ShiftStatusMapping DVM while it synchronizes a Shift status from Siebel CRM to Oracle Real-Time Scheduler. This Oracle Real-Time Scheduler integration maps a Shift status from Siebel CRM to Oracle Real-Time Scheduler if the Siebel Field Technician updates the status of the Shift from the mobile application.

                                Requirements for Mapping a Shift Status

                                If you use the Siebel_to_ORS_ShiftStatusMapping DVM, then you must make sure your mapping meets the following requirements:

                                • The data in the Siebel column must be unique. Multiple Oracle Real-Time Scheduler statuses can map to the same status in Siebel CRM. However, there must not be more than one entry in the map that contains the same status value in the Siebel column.

                                DVM Entries That Map a Shift Status

                                Siebel Column ORS Column

                                Start

                                M1ST

                                Complete

                                M1CO

                                  Mapping a Break Status from Siebel CRM to Oracle Real-Time Scheduler

                                  This integration uses the Siebel_to_ORS_BreakStatusMapping DVM while it synchronizes a Break status from Siebel CRM to Oracle Real-Time Scheduler. This integration maps a Break status from Siebel CRM to Oracle Real-Time Scheduler if Siebel Field Technician updates the status of the Break from the mobile application.

                                  Requirements for Mapping an Activity Status

                                  If you use the Siebel_to_ORS_BreakStatusMapping DVM, then you must make sure your mapping meets the following requirements:

                                  • The data in the Siebel column must be unique. Multiple Oracle Real-Time Scheduler statuses can map to the same status in Siebel CRM. However, there must not be more than one entry in the map that contains the same status value in the Siebel column.

                                  DVM Entries That Map a Break Status

                                  Siebel Column ORS Column

                                  Start

                                  M1ST

                                  Complete

                                  M1CO

                                    Mapping a Time Zone from Siebel CRM to Oracle Real-Time Scheduler

                                    This integration uses the SBL_ORS_TimeZoneMapping DVM to map the Siebel's Time Zone abbreviation as well as Time Zone Name to Oracle Real-Time Scheduler’s Time Zone code. This mapping is being used while transferring Service Region and Employee from Siebel CRM and also during Appointment Booking in the Appointment Booking System.

                                    Requirements for Mapping a Time Zone

                                    If you use the SBL_ORS_TimeZoneMapping DVM, then you must make sure your mapping meets the following requirements:

                                    • The Standard Abbreviation of the Time Zone defined at Siebel CRM should be mapped to corresponding Time Zone Code at Oracle Real-Time Scheduler.

                                    • The Name of the Time Zone defined at Siebel CRM should be mapped to corresponding Time Zone Code at Oracle Real-Time Scheduler.

                                    DVM Entries That Map a Time Zone

                                    Siebel Column ORS Column

                                    Pacific Standard Time

                                    PST001

                                    (GMT-08:00) Pacific Standard Time (US & Canada)

                                    PST001

                                      Mapping a Time Zone from Oracle Real-Time Scheduler To Siebel CRM

                                      This integration uses the ORS_SBL_TimeZoneMapping DVM to map the Oracle Real-Time Scheduler's Time Zone code to Siebel's Time Zone abbreviation. This mapping is being used while refreshing the activity.

                                      Requirements for Mapping a Time Zone

                                      If you use the ORS_SBL_TimeZoneMapping DVM, then you must make sure your mapping meets the following requirements:

                                      • The Standard Abbreviation of the Time Zone defined at Siebel CRM should be mapped to corresponding Time Zone Code in Oracle Real-Time Scheduler.

                                      DVM Entries That Map a Time Zone

                                      ORS Column Siebel Column

                                      PST001

                                      Pacific Standard Time

                                        Mapping Schedule Weekdays from Siebel CRM to Oracle Real-Time Scheduler

                                        This integration uses the SBL_ORS_ScheduleWeekdays DVM to map the Siebel's Schedule Weekdays to Oracle Real-Time Scheduler’s Weekday code. This mapping is being used while transferring the Work Schedule from Siebel CRM.

                                        Requirements for Mapping Schedule Weekdays

                                        If you use the SBL_ORS_ScheduleWeekdays DVM, then you must make sure your mapping meets the following requirements:

                                        • The Language Independent Code of Schedule Weekday List of value defined at Siebel CRM should be mapped to corresponding Weekday Code in Oracle Real-Time Scheduler.

                                        DVM Entries That Map a Weekday Schedule

                                        Siebel Column ORS Column

                                        Monday

                                        M101

                                        Tuesday

                                        M102

                                        Wednesday

                                        M103

                                        Thursday

                                        M104

                                        Friday

                                        M105

                                        Saturday

                                        M106

                                        Sunday

                                        M107

                                          Mapping Language Code of Siebel CRM to Oracle Real-Time Scheduler

                                          This integration uses the SBL_ORS_LanguageCodeMapping DVM to map the Siebel's Language Code to Oracle Real-Time Scheduler's Language Code. This mapping is being used to support Multilingual deployment in Siebel CRM and Oracle Real-Time Scheduler.

                                          Requirements for Mapping a Language Code

                                          If you use the SBL_ORS_LanguageCodeMapping DVM, then you must make sure your mapping meets the following requirements:

                                          • The Language Code defined at Siebel CRM should be mapped to corresponding Language Code at Oracle Real-Time Scheduler.

                                          Examples of Mapping a Language Code

                                          Siebel Column ORS Column

                                          ENU

                                          ENG

                                          ESN

                                          ESA

                                            Mapping End Point URLs for all Oracle Real-Time Scheduler and Siebel Web Services

                                            This integration uses the SBL_ORS_Endpoint_Definition DVM to map the end point URL for each Inbound Web Service exposed by Oracle Real-Time Scheduler and Siebel CRM.

                                            Columns You Use to Map an Activity Status

                                            To map a Activity status, you use the following columns:

                                            • Column 1: Service Name

                                            • Column 2: Endpoint Url

                                            Requirements for Mapping an End Point URL

                                            If you use the SBL_ORS_Endpoint_Definition DVM, then you must make sure your mapping meets the following requirements:

                                            • Update Endpoint URL for each of the Service Name accordingly based on physical machine name.

                                            Examples of Mapping an End Point URL

                                            Service Name End Point URL

                                            Employee Maintenance

                                            For ORS 2.1

                                            http://<ORSserver name>:<port>/ouaf/XAIApp/xaiserver/M1-EmployeeMaintenance

                                            For ORS 2.3

                                            https://<ORSserver name>:<port>/ouaf/webservices/M1-EmployeeMaintenance

                                            ShiftExceptionORSWebService

                                            https://<Siebelserver name>:<port>/eai_<lang>/start.swe?SWEExtSource=WebService&amp;SWEExtCmd=Execute&amp;WSSOAP=1

                                              Mapping Country Code of Siebel CRM to Oracle Real-Time Scheduler

                                              This integration uses the SBL_ORS_CountryCodes DVM to map the Siebel's Country Code to Oracle Real-Time Scheduler's Country Code. This integration Country code on Siebel to the corresponding Country code defined at Oracle Real-Time Scheduler. The mapping is being used while sending Geocoding request for an Address from Siebel CRM to Oracle Real-Time Scheduler.

                                              Requirements for Mapping a Country Code

                                              If you use the SBL_ORS_LanguageCodeMapping DVM, then you must make sure your mapping meets the following requirements:

                                              • The Language Independent Code for Country List of value defined in Siebel CRM should be mapped to corresponding Country Code in Oracle Real-Time Scheduler.

                                              Examples of Mapping a Country Code

                                              Siebel Column ORS Column

                                              USA

                                              USA

                                              France

                                              FRA

                                                Mapping Oracle Real-Time SchedulerExpertise to Siebel CRM Skills

                                                The SBL_Expertise_Code_Definition DVM stores the proficiency values that a skill supports. You must map any value that you define in the SBL_Expertise_Code_Definition DVM to the EXPERTISE_CD list of values in Siebel CRM.

                                                Columns You Use to Map Skills

                                                To map a skill, you use the following columns:

                                                • Column 1: Expertise Code

                                                • Column 2: Relative Value

                                                Relative Values Determine Expertise Ranking

                                                The relative value determines expertise ranking. For example, if an Expert must possess a higher proficiency than a Novice, then Expert must include a higher integer value than Novice.

                                                DVM Entries That Map a Skill

                                                The following table lists entries that are predefined in the SBL_Expertise_Code_Definition DVM. One record must hold the Expertise Code as Default_Expertise. The Relative Value for this should be either NOVICE, INTERMEDIATE, or EXPERT. Another record must hold the Expertise Level as Default_Expertise_Level.The Relative Value for this should be any expertise level other than 0. Value 0 will be considered as no skill level and should not be used.

                                                Expertise Code Relative Value

                                                Default_Expertise

                                                Novice

                                                Default_Expertise_Level

                                                1

                                                Novice

                                                1

                                                Intermediate

                                                2

                                                Expert

                                                3

                                                Examples of Mapping a Skill

                                                Expertise Code Relative Value

                                                Default_Expertise

                                                Novice

                                                Default_Expertise_Level

                                                1

                                                Novice

                                                1

                                                Intermediate

                                                2

                                                Expert

                                                3

                                                Incorrect Example 1

                                                Expertise Code Relative Value

                                                Novice

                                                1

                                                Intermediate

                                                2

                                                Expert

                                                3

                                                  Mapping Run-Time Parameters

                                                  This topic describes how to edit the SBL_ORS_Parameter_Definition DVM. This integration uses this DVM as the configuration file to extract parameters in the run-time environment. This DVM provides a lookup source for default values, endpoint configuration, and so forth. This integration uses all flows that map run-time parameters.

                                                  Columns You Use to Map Run-Time Parameters

                                                  To map run-time parameters, you use the following columns:

                                                  • Column 1: Parameter

                                                  • Column 2: Value

                                                  Entries You Must Include to Map Parameters

                                                  The following table lists the entries you must include in the SBL_Expertise_Code_Definition DVM. You must use the case and spaces for each parameter as they appear in Mapping Run-Time Parameters. You cannot change the case, and you must include the spaces.

                                                  Parameter Description

                                                  ORS-Request Slot MaxCost

                                                  Used to book an appointment. If this integration requests a slot for an activity from Siebel CRM, then it sends the value of this parameter as the maximum allowed cost for that activity.

                                                  The value can be any decimal number greater than 0.1.

                                                  999999 is an example value of the ORS-Request Slot MaxCost parameter.

                                                  ORS-No of Slots

                                                  Defines the number of slots to display on a slot request from Siebel CRM.

                                                  The value can be any integer greater than 1.

                                                  15 is an example value of the ORS-No of Slots parameter.

                                                  ORS-Confirm Slot MaxCost

                                                  Used to confirm an appointment. If the cost to confirm an activity for a particular shift is greater than the cost specified in ORS-Confirm Slot MaxCost, then Oracle Real-Time Scheduler does not allow the activity.

                                                  The value can be any decimal number greater than 0.1.

                                                  999999 is an example value of the ORS-Confirm Slot MaxCost parameter.

                                                  ORS-FindShift

                                                  If the ORS-Confirm Slot MaxCost parameter value is too high, then the scheduler rejects it and then examines the ORS-FindShift parameter to determine if the scheduler must locate another shift that meets the maximum cost that the ORS-Confirm Slot MaxCost parameter specifies.

                                                  The value for the ORS-FindShift parameter is YES or NO. If the value is YES, then the scheduler attempts to find a suitable shift for that activity that costs less than the value in the ORS-Confirm Slot MaxCost parameter.

                                                  NO is an example value of the ORS-FindShift parameter.

                                                  ORS Default Service Area with Srv Regn

                                                  Determines if this integration forces Oracle Real-Time Scheduler to associate with a Service Area, and only that Service Area, the same name as the service region. If the ORS-Default Service Area with Srv Regn parameter is:

                                                  • YES, then when this integration synchronizes the employee to Oracle Real-Time Scheduler from Siebel Service, it associates the Service Area with the request.

                                                  • NO, then this integration does not send the Service Area mapping from Oracle Fusion Middleware to Oracle Real-Time Scheduler. You must use the Oracle Real-Time Scheduler user interface to map the Service Areas. This integration retains any mapping you do in the Oracle Real-Time Scheduler user interface even when it performs a resynchronization from Siebel Service.

                                                  YES is an example value of the ORS-Default Service Area with Srv Regn parameter.

                                                  ORS-Relative Rank of DEFAULT Expertise

                                                  Specifies the relative rank of the default expertise level. If this integration creates a new attribute in Oracle Real-Time Scheduler from Siebel Service, even if no expertise level is specified for the attribute, then it creates a proficiency named default for the attribute. The value in the parameter specifies the relative value of the proficiency.

                                                  If this integration sends the attribute with proficiency at some point in the future, then it compares the rank of this default expertise to other expertise ranks in order to determine whether the default proficiency is lower in precedence or higher in precedence. For more information, see Mapping Oracle Real-Time SchedulerExpertise to Siebel CRM Skills.

                                                  The value 900 is an example value of the ORS-Relative Rank of DEFAULT Expertise parameter.

                                                  Siebel_ID_of_MWM_

                                                  Base_TimeZone

                                                  Specifies the ROW_ID of the Timezone in Siebel CRM corresponding to the Base Timezone at Oracle Real-Time Scheduler. It gets the ROW_ID of the Timezone in Siebel CRM which corresponds to the Base Timezone defined in Oracle Real-Time Scheduler and place that value here. For example, if the Base timezone in Oracle Real-Time Scheduler is PST, then gets the ROW_ID of the Pacific Time Zone record from Siebel CRM.

                                                  Optional Entries You Can Include to Map Parameters

                                                  Parameter Description

                                                  ORS-Request Slot MaxCost-ServiceRegionName

                                                  Defines parameters for the service region. For example:

                                                  ORS-FindShift-ServiceRegionName

                                                  where:

                                                  • ServiceRegionName is the name of the service region.

                                                  For example: ORS-FindShift-New York City.

                                                  If you do not configure these service region parameters on the DVM, then this integration uses the default parameters that are described in Mapping Run-Time Parameters. Any service region parameter that you define on the DVM modifies the default parameter.

                                                  Note the following examples:

                                                  • 9990 is an example value for the ORS-Request Slot MaxCost-ServiceRegionName parameter

                                                  • 20 is an example value for the ORS-No of Slots-ServiceRegionName parameter.

                                                  • 7777 is an example value for the ORS-Confirm Slot MaxCost-ServiceRegionName parameter.

                                                  • YES is an example value for the ORS-FindShift-ServiceRegionName parameter.

                                                  • NO is an example value of the ORS-Default Service Area with Srv Regn-ServiceRegionName parameter.

                                                  ORS-No of Slots-ServiceRegionName

                                                  ORS-Confirm Slot MaxCost-ServiceRegionName

                                                  ORS-FindShift-ServiceRegionName

                                                  ORS-Default Service Area with Srv Regn-ServiceRegionName

                                                  Default Batch Size - Employee

                                                  Sets the number of records that this integration groups before it saves them to the Siebel database. For more information, see Mapping Run-Time Parameters.

                                                  100 is an example value of the Default Batch Size - Employee parameter.

                                                  Default Batch Size - Activity

                                                  Determines the synchronization batch size for activities. This usage is similar to the Default Batch Size - Employee parameter. For more information, see Mapping Run-Time Parameters.

                                                  The value 100 is an example value of the Default Batch Size - Activity parameter.

                                                  Default Batch Size - Address

                                                  Determines the synchronization batch size for addresses. This usage is similar to the Default Batch Size - Employee parameter. For more information, see Mapping Run-Time Parameters.

                                                  The value 100 is an example value of the Default Batch Size - Address parameter.

                                                  Default Batch Size - Geocoding

                                                  Determines the batch size to retrieve geocodes for multiple addresses. The batch geocoding flow waits until the number of geocodes that this integration holds in memory reaches the value in the Default Batch Size - Geocoding parameter, and then saves them in the Siebel database. This usage is similar to the Default Batch Size - Employee parameter. For more information, see Mapping Run-Time Parameters.

                                                  The value 100 is an example value of the Default Batch Size - Geocoding parameter.

                                                  About the Default Batch Size - Employee Parameter

                                                  During a service region data transfer, this integration extracts employees from the Siebel database and attempts to synchronize them with Oracle Real-Time Scheduler, one record at a time. It stores the status of the synchronization in the Siebel database, along with the timestamp of the synchronization operation. This status describes whether the synchronization is successful, not successful, and the reasons for any failed synchronization.

                                                  To set the number of records that this integration groups before it saves them to the Siebel database, you can use the Default Batch Size - Employee parameter. For example, if Default Batch Size - Employee is 100, then the service region data transfer flow waits until the synchronization status in memory is 100 records, and then writes these records to the Siebel Database.

                                                  If the overall total number of records is less than 100, then this integration saves the records to the Siebel database when it reaches the total.

                                                  You can use any integer value greater than 0.

                                                    Editing Domain Value Maps

                                                    This task is a step in Process of Installing SOA Composites for This Integration.

                                                    To edit a DVM, you use the Oracle Business Process Composer.

                                                    To edit domain value maps

                                                    1. Enter the following address in the URL window of a Web browser:

                                                      http://MachineName:SOAServerPort/soa/composer
                                                      

                                                      This URL accesses the Oracle Business Process Composer.

                                                    2. Enter the administrator user name and password, and then click Login.

                                                    3. In the Business Process Composer, click Open, and then choose Open DVM.

                                                    4. Choose one of the DVMs you must edit.

                                                      You must edit each DVM that this integration requires. For more information, see DVMs You Can Edit.

                                                      You can use the Show drop-down menu to choose all DVMs, including DVMs in the Oracle MDS.

                                                      After you open a DVM, the Oracle Business Process Composer displays all existing mappings. The header specifies the columns in the DVM. All entries are read-only.

                                                      If a DVM is in edit mode, then the Oracle Business Process Composer displays the Add button. If you choose a particular record within a DVM, then the Oracle Business Process Composer displays the edit and delete modes.

                                                    5. Do any of the following:

                                                      • To edit the existing DVM, click Edit.

                                                      • To add a new entry, click Add, enter the new values, and then click OK.

                                                      • To edit a record, click the record, and then click the Edit button that resides next to the Add button.

                                                      • To delete an existing mapping, click the record and then click Delete.

                                                        A confirmation screen appears.

                                                    6. Click Commit at the start of the page.

                                                      You can optionally save changes on the user session and make more changes later before you save them. However, to save these changes to the run time environment, you must click Commit.

                                                      DVMs You Can Edit

                                                      You can edit the following DVMs:

                                                        Importing ORS Certificate and Siebel Certificate into Oracle Web Logic Server

                                                        Note: This feature is applicable only to Oracle Real-Time Scheduler version 2.3.

                                                        To update ORS2.3 Certificate and Siebel Certificate in FMW Environment, the following two updates are required:

                                                        1. Keystore update in EnterpriseManager

                                                        2. KeyStore import into DemoTrust Java KeyStore

                                                          Keystore Update in Enterprise Manager

                                                          To update ORS2.3 Certificate
                                                          1. Get ORS certificate from ORS wsdl. For example, ouaf_demo_cert.cer.

                                                          2. Login to Weblogic Enterprise Manager, expand the WebLogic domain, and right-click on your domain, select Security, then Keystore.

                                                          3. Expand System and select Trust.

                                                          4. Add ORS certificate details as following:

                                                            1. Click on Manage, then click on Import.

                                                            2. Select Certificate Type as Trusted Certificate.

                                                            3. Give a name in Alias Name.

                                                            4. Paste ORS certificate content into *Paste Certificate String here.

                                                          5. Click Ok.

                                                          Note: The feature described in the following topic is available in Siebel CRM 18.4 Update and later releases.
                                                          To update Siebel Certificate
                                                          1. Get Siebel Certificate from Siebel Application. For example, siebel.cer.

                                                          2. Login to Weblogic Enterprise Manager, expand the WebLogic domain, and right-click on your domain and select Security, then Keystore.

                                                          3. Expand System and select Trust.

                                                          4. Add Siebel certificate details as following:

                                                            1. Click on Manage, then click on Import.

                                                            2. Select Certificate Type as Trusted Certificate.

                                                            3. Give a name in Alias Name.

                                                            4. Paste Siebel certificate content into *Paste Certificate String here.

                                                          5. Click Ok.

                                                            Key Store import into Demo Trust Java KeyStore

                                                            1. Launch FMW through putty.

                                                            2. Navigate to Middleware/wlserver/server/lib.

                                                            3. Run the following command:

                                                              1. For ORS2.3 Certificate import:

                                                                keytool -import -trustcacerts -file ouaf_demo_cert.cer -keystore DemoTrust.jks
                                                                

                                                                Provide Trust Password: DemoTrustKeyStorePassPhrase

                                                              2. For Siebel Certificate import:

                                                                keytool -import -trustcacerts -file siebel.cer -keystore DemoTrust.jks
                                                                

                                                                Provide Trust Password: DemoTrustKeyStorePassPhrase

                                                              Note: Before running the command, paste ORS and siebel certificate in to the path Middleware/wlserver/server/lib. If "Error: certificate is already imported" is observed during the first time import of certificates, then provide different alias name in the command. For example, keytool -import -trustcacerts -file Certificate.cer -keystore DemoTrust.jks -alias <differentaliasname>.
                                                            4. Restart the WebLogic and SOA server.

                                                              Updating ORS2.3 HTTP Username and Password to ORSWebservices in Enterprise Manager

                                                              To update ORS2.3 HTTP username and password

                                                              1. Open WebLogic Enterprise Manager.

                                                              2. Update the following flows with ORS2.3 Username and Password:

                                                                • ActivityLatestStateRetrieval_EBF

                                                                • AdminDataManagement_EBF

                                                                • AppointmentBookingSystemSBLORS_EBF

                                                                • RealTimeSingleAddressGeoCoding

                                                                • ServiceRegionCutoverToORS_EBF

                                                                • ServiceRegionRollbackFromORS_EBF

                                                                • ShiftWeeklyTemplateMaintenanceSBLORS_EBF

                                                                • StatusUpdateSBLtoORS_EBF

                                                                • WorkCalendarMaintenanceSBLORS_EBF

                                                              3. Select a flow. For example, RealTimeSingleAddressGeoCoding.

                                                              4. From Policies tab, make a note of all services using the policy oracle/wss_username_token_over_ssl_client_policy. For example, for flow RealTimeSingleAddressGeoCoding , the service MWMWebservice is attached with oracle/wss_username_token_over_ssl_client_policy.

                                                              5. Navigate to Dashboard tab and select the Services. For example, MWMWebservice.

                                                              6. In Properties tab, update the ORS HTTP Username and Password in HTTP Basic Authentication section for the previously selected policy, here for example, MWMWebservice. Click Apply.

                                                              7. Repeat Steps 5 and 6 for each service using oracle/wss_username_token_over_ssl_client_policy.

                                                              8. Repeat Steps 3 to 7 for each flow.

                                                                Note: Server restart is not required after update.
                                                                Note: In the absence of these changes, when ORS Webservices are invoked, a 401 Unauthorized error is observed.