Siebel Order Management Guide > Preparing for Integration > About Using Third-Party Product Availability Applications >

Required Setup Procedures for Checking Availability

To set up the use of third-party product availability-to-promise systems, you must perform the following tasks:

Checking the Availability Fulfillment Methods

For the integration to work, you must check that your ATP engine supports the Inquire, Reserve, and Unreserve methods. If your ATP engine refers to these methods with different terms, you may need to do some configuration to map the method names.

Setting the ATP Action Parameter in the Quote and Order Business Components Properties

The product availability fulfillment integration is launched from a Quote or Order business component at either the header level or the line level. The Quote or Order business component defines the method to be used to invoke the ATP Check ASI. This method is one of those listed in Table 7, depending on whether the user clicked a button to Inquire, Reserve, or Unreserve.

You must make sure that the value of the ATP Action Parameter in the user property defining the ATPInquireAll method in both the Quote and Order business components matches the command expected by the ATP engine.

The ATP Action parameters come preconfigured with the values shown in Table 7. If these values match the commands expected by your ATP engine, you do not need to make any changes to the ATP Action parameter. However, if your ATP engine expects different commands, you can change them in Siebel Tools.

Table 7.  Preconfigured ATP Action Parameter Settings
User Interface Element
BusComp
Method Name
ATP Action
Inquire All button, Quote or Order header
Quote/Order Entry - Orders
ATPInquireAll
Inquire
Inquire button, Quote or Order Line Items list
Quote Item/Order Entry - Line Items
ATPInquire
Inquire
Reserve All button, Quote or Order header
Quote/Order Entry - Orders
ATPReserveAll
Reserve
Reserve button, Quote or Order Line Items list
Quote Item/Order Entry - Line Items
ATPReserve
Reserve
Unreserve All button, Quote or Order header
Quote/Order Entry - Orders
ATPUnReserveAll
Unreserve
Unreserve button, Quote or Order Line Items list
Quote Item/Order Entry - Line Items
ATPUnReserve
Unreserve

The following procedure shows you how to make changes to the ATP Action parameter for the method ATPInquireAll. You can use these as a model to make changes to any of the other ATP methods, as appropriate.

NOTE:  If the middleware handles this mapping, then you do not need to change this ATP Action Parameter. For example, if the middleware knows that ATP Action = Inquire in your Siebel application, and that ATP Action = Check in your fulfillment engine, the middleware provides the mapping.

To set the business component user properties for the Quote business component

  1. In Siebel Tools, select the Quote business component.
  2. Select Business Component User Prop.
  3. In the Value field, query for *ATP*.

    4. This returns all of the Quote business component user properties that are related to the ATP functionality.

  4. For the user property that includes the ATPInquireAll method, edit the ATP Action parameter so that it exactly matches the command expected by the ATP engine. The default value is Inquire.

To set the business component user properties for the Order business component

  1. In Siebel Tools, select the Order business component.
  2. Select Business Component User Prop.
  3. In the Value field, query for *ATP*.

    4. This returns all of the Order business component user properties that are related to the ATP functionality.

  4. For the user property that includes the ATPInquireAll method, edit the ATP Action parameter so that it exactly matches the command expected by the ATP engine. The default value is Inquire.

Verifying the External ATP Check Business Service User Properties

You must verify the External ATP Check business service user properties.

To verify the External ATP Check business service user properties

  1. In Siebel Tools, select the External ATP Check business service.
  2. Select Business Service User Prop.
  3. Verify that the Names and Values of the User Properties match those in the following table.

    4. Name
    Value
    siebel_port_name
    Default
    siebel_web_service_name
    External ATP Check
    siebel_web_service_namespace
    http://siebel.com/asi/

Configuring Web Services

Web services are used to direct the inbound and outbound messages to and from:

You must make sure that the Web services are correctly configured.

To configure the Web services

  1. In your Siebel application, navigate to the Web Services Administration screen.
  2. From the Show drop-down list, select Outbound Web Services.
  3. Select the row with External ATP Check in the Name field.
  4. Verify that the fields in the Outbound Web Services list match those in the following table.

    5. Namespace
    Name
    Status
    http://siebel.com/asi/
    External ATP Check
    Active

  5. In the Service Ports list, click New, and enter the following values in the fields of the new record.

    6. Field
    Comments
    Name
    Enter a name for the port.
    Port Type
    Enter External ATP Check.
    Transport
    Select from the drop-down list.
    If you want to set up testing, for example when you are customizing applets or extending the ASI, select Local Business Service.
    Address
    When you select a transport, the field will be populated with a template address. Edit the address based on whether you are sending the data to middleware or the ATP engine.
    If you want to set up testing, for example when you are customizing applets or extending the ASI, enter ATP ASI Test. For more information, see ATP ASI Testing Script.
    Binding
    If a SOAP header is expected by the receiving application, select SOAP_RPC.
    If you are using ATP ASI Test, select Property Set.

For more information about configuring Web Services and setting up demonstration scripts, see Integration Platform Technologies: Siebel eBusiness Application Integration Volume II.

ATP ASI Testing Script

The ATP ASI test is a testing script that simulates a simple fulfillment engine. It writes the output and response to an XML file on the server machine. By default the script writes the output and the response to ${SIEBEL_HOME}/bin. For example: D:\Siebel\bin. It writes an output file called ATPOutput.xml. This file represents what you would be sending to your middleware or fulfillment engine. Then the script generates a real-time response and sends the XML back to the Web service. The XML response that is generated is written into a file called ATPFinished.xml, which you can see in the file system. This testing infrastructure allows you to analyze what will be sent to the middleware and what the Siebel application is expecting back, and allows you to test your user interface.


 Siebel Order Management Guide 
 Published: 18 April 2003