Bookshelf v7.5: Building Customized Interfaces Using the ASI Framework

Building Customized Interfaces Using the ASI Framework

You can build your own interfaces using the ASI Framework.

To define an inbound interface

Determine the schema and fields of the integration objects based on your business needs.

Open Siebel Tools, create the internal integration object using the Integration Object Wizard, and deactivate the components and fields that are not required.

Deleting fields is not recommended. For more information about creating integration objects, see Integration Platform Technologies: Siebel eBusiness Application Integration Volume II.

Create the interface integration object in Siebel Tools using one of the following methods:

Copy the internal integration object, if the internal and interface objects are the same.

Use the DTD or XML schema wizard. For more information about using the XML schema wizard, see Integration Platform Technologies: Siebel eBusiness Application Integration Volume II.

Create the object manually.

Deactivate the components and fields that are not required.

Deleting fields is not recommended.

Choose the Tools menu and select Validate Object to check the definition of the integration objects in Siebel Tools.

Compile the SRF file, and import it to the Siebel server.

Open the Siebel Client, select the Integration Administration menu, and select the Data Maps screen.

NOTE: Do not create an explicit data map if an object is a subset of another or if the objects are the same. The data synchronization service automatically maps the subsets if the root integration components have the same name.

Open the Integration Administration menu and choose the Data Map editor to create an explicit data map if the two objects contain different component or field names.

A map is required for each direction:

Interface Object > Internal Object

Internal Object > Interface Object

Click Validate in the Data Map editor to check the data map changes before testing.

Open Siebel Tools, define the business service, and set the class property to CSSEAIDataSyncService.

Within the business service:

Define the methods needed for this service. See Methods for more details.

Define the Business Service User Properties to configure the internal object and the data map names. See Business Service User Properties for more details.

Recompile the projects with the integration objects and business services definition into the SRF file.

Open the Siebel Client, select the Web Services Administration menu, and choose the Inbound Web Services administration screen. Create an entry if the inbound interface is to be made available as a Web Service.

To create an outbound interface, you must publish it as a Web Service so it can be used externally.

To define an external interface

Open Siebel Tools and define the integration objects by hand or by using the Integration Object Wizard.

Deactivate components and fields that are not required.

Deleting fields is not recommended.

Create interface integration objects manually, by copying and changing the internal object, or by importing an XML DTD.

NOTE: Skip to Step 5 of this procedure if a WSDL exists for the internal interface. You can run the WSDL Wizard to automatically import the information that is manually done in Steps 3 through 5. If a WSDL does not exist, complete Step 2 through Step 4. For more information about using the WSDL Wizard, see Integration Platform Technologies: Siebel eBusiness Application Integration Volume II.

Open Siebel Tools and define the business service to describe the interface to the ASI, including all methods and parameters for each method.

This business service references the integration objects created in Step 1.

Set the business service's class to CSSWSOutboundDispatcher.

Set the parameters on methods to type Integration Object and refer to the specified interface object.

Define the Business Service User Properties in Siebel Tools.

Choose a name for the default Service, siebel_web_service_name.

Choose the properties for the default Port, siebel_port_name.

Register the name on the business service as a user property, and define the service and portname as the proxy's default service name, siebel_web_service_namespace.

Open the Siebel Client, choose the Outbound Web Services Administration screen, and select a name for the default service. Configure the following properties:

Port types are all the published proxy business services used to define the outbound ASI interface. The port name is the business service you created in Siebel Tools in Step 2.

Transports describe the transport type for your particular platform and system. For more information, see Exposing ASIs With Interface Technologies.

Protocols describes the formatting of the integration object being sent. For more information, see Protocols.

Address is the physical location of the touchpoint files.

Recompile the projects with the integration objects and business services definition into the SRF file.

Define an entry for the outbound ASI in the Outbound Services Administration View.

The port type should reference the business service created for the outbound ASI. The name of the business service and port must match the default names set on the business services definition.

To define the Data Map

An inbound and outbound data map need to be created for each interface. In the Siebel client, use the Data Maps view under the Integration Administration menu to create a new data map for your new or customized integration objects.

See Data Mapping for more information about data mapping.

For more information about creating a data map for the ASI, see Business Processes and Rules: Siebel eBusiness Application Integration Volume IV.