Siebel Master Data Applications Reference for Industry Applications > Siebel Master Data Applications Administration > About Siebel Master Data Application Integration Objects >

Siebel Master Data Applications Integration Services


Siebel Master Data Applications provide an object called a business service, which you can reuse in multiple applications. The Siebel Connector for the Customer Information File provides the following prebuilt business services that you can configure to meet your business requirements:

  • UCM Transaction Manager
  • UCM Converter
  • UCM Dispatcher
  • UCM Security Manager
  • UCM Publish/Subscribe Service

You can configure business services by manipulating their user properties, or you can create your own business service in Siebel Tools. For information on using Siebel Tools to configure your application, see Configuring Siebel eBusiness Applications.

NOTE:  After you have configured your business services to accomplish the tasks required for your business scenario, you need to compile the business service to include the new information in your Siebel repository file (.srf). Then copy the .srf file to the directory where your servers can access it.

UCM Transaction Manager

You can extend this business service by manipulating its Operation user property. The basic format for value entry for each operation is as follows:

CIFOperation_Query

Service/Method/Argument;Argument; or /Method/Argument;Argument;

  • Service, Method, and Argument are separated by a forward slash (/).
  • Each Argument ends with a semi-colon (;).
CIFOperation_XMLQuery

EAI Siebel Adapter/Query/#XMLHierarchy;

  • The default Service name is EAI Siebel Adapter and the default argument name is SiebelMessage.
  • SiebelMessage indicates turning off the SiebelMessage.
  • XMLHierarchy indicates replacing SiebelMessage with XMLHierarchy.
CIFOperation_GetValue

FINS Industry/BC Facility Service/HierarchySearchSpec/!SiebelMessage;A=>B;

  • A=>B means getting argument value of A from argument value of B where argument B is an argument of the Connector Integration Object Instance.

Table 26 lists the user properties examples for the UCM Transaction Manager.

Table 26.  User Properties for UCM Transaction Manager
Operation Name
Value

IXMLOperation_ADD

EAI Siebel Adapter/Insert/

IXMLOperation_DELETE

EAI Siebel Adapter/Delete/

IXMLOperation_QUERY

EAI Siebel Adapter/Query/

IXMLOperation_QUERY_BY_ID

EAI Siebel Adapter/Query/PrimaryRowId;!SiebelMessage;

IXMLOperation_SYNCH

EAI Siebel Adapter/Synchronize

IXMLOperation_UPDATE

EAI Siebel Adapter/Update

UCM Converter

Table 27 displays the only user property you can configure for this business service. This value appears in the preheader section of your CRMML message.

Table 27.  User Property for UCM Converter
Name
Value

XMLEnvIntObjectName

Name of the envelope integration object shipped or customized by you.

The UCM Converter uses the hierarchy represented in the UCM integration object to guide the message through the converting process. If the integration object instance receives elements that do not have a definition defined in the integration object definition, the converter errors out. If you expect such a situation, you can set the Ignore Undefined XML Tag parameter on the user property of the corresponding integration object.

NOTE:  This user property is created by the wizard and is set to Y. You can turn it off if you wish the converter to error out.

UCM Dispatcher

You can modify both user properties for this business service as shown in Table 28.

Table 28.  User Properties for UCM Dispatcher
Name
Value

DispatcherMapName

Name of the dispatcher map shipped or customized by you.

XMLEnvIntObjectName

Name of the envelope integration object shipped or customized by you.

UCM Security Manager

You can modify or extend this business service by manipulating its user properties. The Name column stands for the UCM Transaction Manager Operation Name, while the Value column represents the Field Name for different types of privileges in the System Privileges View. Table 29 displays these user properties.

Table 29.  User Properties for UCM Security Manager
Name
Value

IXMLOperation_ADD

Insert

IXMLOperation_DELETE

Delete

IXMLOperation_QUERY

Query

IXMLOperation_QUERYPAGE

Query

IXMLOperation_UPDATE

Update

Inbound Server Administration

A server task is an instantiation of a server component. To run a server task, you need to run a component job, which requests one or more server tasks to run. The server task you need to run for the Siebel Connector for Master Data Applications depends on the registered system protocol type, either the Siebel EAI MQSeries Server Transport or the Siebel HTTP Server Transport.

The Siebel EAI MQSeries Server Transport is designed to provide a messaging solution to help you integrate data between Siebel eBusiness Applications and external applications that can interface with the IBM MQSeries. The EAI 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 subsystem

  1. Navigate to the Administration - Server Configuration screen.
  2. From the link bar, click Enterprises.
  3. Select the Profile Configuration view tab.
  4. Create two new records in the Profile Configuration list and provide the following information.
     
    Record 1
    Record 2

    Name

    Any name, CIFMQConnSubsy for example

    Any name, CIFMQDataSubsys for example

    Alias

    This field is required for creation of this record.

    This field is required for creation of this record.

    Subsystem Type

    MQSeriesServerSubsys

    EAITransportDataHandlingSubsys

    NOTE:  The subsystem type that you select should have a checkmark in the Is Named Enabled field.

  5. For each record, modify the following parameters in the Profile Parameters list:
    Parameter Name
    Record 1
    Record 2

    MQSeries Physical Queue Name

    Queue name to receive inbound request message from

    N/A

    MQSeries Queue Manager Name

    Queue manager name who own the queues

    N/A

    MQSeries Response Physical Queue Name

    Queue name to send response message to

    N/A

    MQSeries Sleep Time

    100 (or longer if required)

    N/A

    Workflow Process to Execute

    N/A

    UCM Server Party Package Workflow (MQSeries Server Transport Error Handling)

  6. Save both records.

    For details on this procedure and the Named Subsystems, see Siebel System Administration Guide.

After creating and configuring your Named Subsystem, you need to configure the MQSeries Server Receiver. For details on configuring MQSeries, see Transports and Interfaces: Siebel eBusiness Application Integration Volume III.

To configure MQSeries Server Receiver parameters

  1. Navigate to the Administration - Server Configuration screen.
  2. From the link bar, click Servers.
  3. In the Siebel Servers list, select the Siebel Server of interest.
  4. Click the Components view tab.
  5. In the Components list, select MQSeries Server Receiver (alias: MqSeriesSrvRcvr).
  6. Select the Parameters view tab under the Components list.
  7. Set the following parameters as follows:
    Parameter Name
    Alias
    Value

    Receiver Connection Subsystem

    ReceiverConnectionSubsystem

    Subsystem name created in To configure named subsystem. For example, CIFMQConnSubsys or CIFMQDataSubsys.

    Receiver Method Name

    ReceiverMethodName

    ReceiveDispatch or ReceiveDispatchSend.

    Default Tasks

    DfltTasks

    1 or number of tasks desired.

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

If the registered system is using the HTTP protocol type, you need to configure the Inbound EAI HTTP Transport. The Inbound EAI HTTP Transport is built into the Siebel Web Engine (SWE). To use it, you need to specify certain parameters listed as follows.

To configure the Siebel Web Engine to run the Inbound HTTP Transport

  1. Open eapps_sia.cfg file in the \bin subdirectory in the install directory.
  2. Locate the section [/cif_%language%], for example [/cif_enu].
  3. Add the EnableExtServiceOnly configuration parameter or set it as follows, if it already exists:

    [/cif_enu]

    ConnectString = <Connect String>

    EnableExtServiceOnly = TRUE

  4. Save and close the configuration file.

After creating and configuring the SWE, configure the required Named Subsystem. For complete instructions, see the procedure under Inbound Server Administration.

To configure the Siebel Universal Customer Master Application to run the Extension Service

  1. Open cif.cfg file in the \bin subdirectory in the install directory.
  2. Locate the section [/HTTP Services], or add this section if it is not found.
  3. Add the services and corresponding named subsystems configured. For example:

    [/HTTP Services]

    SiebelCIFContact = CIFInboundHTTPDispatch

    The name SiebelCIFContact in the queryString matches the name CIFInboundHTTPDispatch, which in turn looks up for the named subsystem list and dispatches accordingly.

  4. Save and close the configuration file.

For details on creating and configuring server tasks, see Siebel System Administration Guide, and for details on configuring MQSeries and HTTP, see Transports and Interfaces: Siebel eBusiness Application Integration Volume III.

Siebel Master Data Applications Reference for Industry Applications