11 Managing Callouts

Creating a Callout

A predefined callout named XSLTCallout is provided for XML-to-XML transformations. You cannot update or delete this callout or create callout properties or callout usages for it. You can also create your own Java callouts. A callout includes attributes, such as a name, description, implementation class name, and callout .jar file library name. These callout details load the callout class, map the input and output parameters, and invoke the class. You can create multiple callouts with the same name. However, you must assign them different implementation names. Follow these instructions to create a callout:

1. Click Partners, then Callouts.

2. Click Create in the Callouts section.

   The Create Callout page appears.

3. Enter the following details to create a callout. An asterisk (*) indicates a required field.

   Field	Value
   Name *	Enter a unique and recognizable name for the callout.
   Description	Enter a description.
   Implementation Name *	Enter the class file name. Note: OracleAS Integration B2B includes a predefined class file named XSLTCalloutImpl that you can use for XML-to-XML transformations.
   Library Name *	Enter the callout .jar file library name that defines how to perform the transformation. The class file is included in the .jar file. Note: If you specify your own callout .jar file, the directory location for this file must be specified with the Callout Directory parameter of the Server Properties page in Oracle Enterprise Manager 10g Application Server Control Console. Note that the directory location for the default b2b.jar file included with OracleAS Integration B2B does not need to be specified.
   Timeout (seconds)	Enter the time limit in which to process the callout.

   
   

4. Click Apply.

   The callout is created and the new Callout Details page appears.

See "OracleAS Integration B2B Middle-Tier Instance Server Properties" for instructions on accessing the Callout Directory server property in Oracle Enterprise Manager 10g Application Server Control Console to set the callout .jar file location.

import java.io.*;
import java.net.*;
import java.util.*;
import oracle.xml.parser.v2.*;
import oracle.tip.callout.Callout;
import oracle.tip.callout.CalloutMessage;
import oracle.tip.callout.CalloutContext;
import oracle.tip.callout.exception.*;
 
/**
 * This sample callout transforms the incoming XML document
 * to another XML document. It also shows how to generate
 * Functional Ack and Error message.
 */
public class MyCallout implements Callout {  
   public void execute(CalloutContext context,
                       List input,
                       List output)
               throws CalloutDomainException, CalloutSystemException {
     try {
 
      // (1) Retrieve the callout properties from CalloutContext
      String xsltFile     = context.getStringProperty("xsltFile");
 
      // (2) Get the input callout message
      CalloutMessage cmIn = (CalloutMessage)input.get(0);
 
      // (3) Process the message
      // instantiate a stylesheet
      URL xslURL = new URL("file://" + xsltFile);     
      XSLProcessor processor = new XSLProcessor();
      XSLStylesheet xsl = processor.newXSLStylesheet(xslURL);
 
      // parser input XML content
      DOMParser parser = new DOMParser();
      parser.setPreserveWhitespace(true);  
      parser.parse(new StringReader(cmIn.getBodyAsString()));
      XMLDocument xml = parser.getDocument();
      processor.showWarnings(true);
      processor.setErrorStream(System.err);
 
      // Transform the document
      StringWriter strWriter = new  StringWriter();
      processor.processXSL(xsl, xml, new PrintWriter(strWriter));
 
      // (4) Create a output callout message
      // create a callout output message
      CalloutMessage cmOut =
          new CalloutMessage(strWriter.getBuffer().toString());
      strWriter.close();
 
// create Functional Ack callout message
// this is an optional step
CalloutMessage fa = new CalloutMessage(/*set FA payload here*/);
fa.setParameter("functional_ack", "true");
//setting your own doctype and revision
//set the doc type name and revision as defined in b2b ui
fa.setParameter("doctype_name", "fa");
fa.setParameter("doctype_revision", "1.0");
 
// create Error callout message
// this is an optional step
CalloutMessage err = new CalloutMessage(/* set the payload that causes this
error */);
err.setParameter("error_message", "true");
err.setParameter("error_desc", "set the error desc");

      output.add(cmOut);
      output.add(fa);
      output.add(err);

      //(5) Throw an exception, if any
    } catch (Exception e) {
      throw new CalloutDomainException(e);
    }
  }
}

Viewing a Callout

Follow these instructions to view details about a specific callout:

1. Click Partners, then Callouts.

2. Select a specific callout to view in the Name column of the Callouts section.

   The Callout Details page for the selected callout appears.

3. View specific details, including the following:

   • The callout name, description, implementation name (class name), library name, and timeout value (in seconds)

   • Any callout properties assigned to this callout

   • The callout usages assigned to this callout (the source and target document definitions for the callout, such as a purchase order request and purchase order acceptance). For a callout to be selectable when you create a trading partner agreement, a callout usage must exist.

   This page, as with the Callouts page shown in Figure 11-3, enables you to delete or update a callout that you created.

4. Click Return to List to return to the Callouts page.

Updating a Callout

Follow these instructions to update a callout that you created:

1. Click Partners, then Callouts.

2. Select a specific callout to update in the Update column of the Callouts section.

   The Update Callout page appears.

3. Make appropriate changes. (See Step 3 for a list of fields you can update.)

4. Click Apply.

   The callout is updated and the Callout Details page appears.

Deleting a Callout

Follow these instructions to delete a callout that you created:

1. Click Partners, then Trading Partners, and then Callouts.

2. Select a specific callout to delete in the Delete column of the Callouts section.

3. Click Yes when prompted to delete a callout.

   The callout is deleted and the Callouts page appears.

Creating Callout Properties

Follow these instructions to create a callout property:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Click Create in the Callout Properties section.

   The Create Callout Property page appears.

4. Enter the following details to create a callout property. An asterisk (*) indicates a required field.

   Field	Value
   Name *	Enter a unique and recognizable name for the callout property.
   Description	Enter an optional description.
   Type *	Select a type (Boolean, date, float, integer, or string).
   Mandatory	Select False or True.
   Overridable	Select False or True. If set to True, you can override the value at the callout usage level. If set to False, do not enter a value at the callout usage level.
   Minimum Length	Enter a minimum length for the callout property.
   Maximum Length	Enter a maximum length for the callout property.
   Encrypt Value	Select False or True.
   Default Value	Enter a value. If the Encrypt Value is set to True, this value is encrypted.

   
   

5. Click Apply.

   The callout property is created and the new Callout Property Details page appears. You can now assign local values to this callout property that are applicable only to a specific callout usage. Or, you can use this callout property in its current format to be applicable to all callout usages.

Viewing Callout Properties

Follow these instructions to view details about a specific callout property:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Select a specific callout to view in the Name column of the Callout Properties section.

   The Callout Properties Details page for the selected callout property appears.

4. View specific details, including the callout property name, description, type (for example, string), if the property is mandatory, if the property is overridable, the minimum and maximum lengths, if encryption is enabled, and the default value (which is visible if not encrypted).

   This page, as with the Callout Details page shown in Figure 11-4, enables you to delete or update the selected callout property.

5. Click Return to List to return to the Callout Details page.

Updating Callout Properties

Follow these instructions to update a callout property:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Select a specific callout to update in the Update column of the Callout Properties section.

   The Update Callout Property page appears.

4. Make appropriate changes. (See Step 4 for a list of fields you can update.)

5. Click Apply.

   The callout property is updated and the Callout Property Details page appears.

Deleting Callout Properties

Follow these instructions to delete a callout property:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Select a specific callout property to delete in the Delete column of the Callout Properties section.

4. Click Yes when prompted to delete a callout property.

   The callout property is deleted and the Callout Details page appears.

Creating a Callout Usage

If you want to select a callout when you create a trading partner agreement, you must first create a callout usage. A callout usage consists of a source (input) and target (output) document definition for transformation. The document definitions that display for selection are the ones you created through either of two methods:

• Created support for a business action or collaboration with the Create Business Action wizard or Create Collaboration wizard

• Imported EDI X12 and EDI EDIFACT transaction sets, UCCnet standards, and RosettaNet collaborations into the design-time repository by clicking Administration, then Management, and then Import

Follow these instructions to create a callout usage:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Click Create in the Callout Usage section.

   The Create Callout Usage page appears.

4. Enter the following details to create a callout usage. An asterisk (*) indicates a required field.

   Field	Value
   Source Document Definition *	Select a source document definition. The selection you make here is the input to the callout (for example, a purchase order request initiated by a remote trading partner, as shown in Figure 11-1).
   Target Document Definition *	Select a target document definition. The selection you make here is the output to the callout (for example, a purchase order acceptance for a host application of a host trading partner, as shown in Figure 11-1).

   
   

5. Click Apply.

   The callout usage is created and the new Callout Usage Details page appears. The callout usage can now be selected when you create a trading partner agreement.

See the following for more information:

• "Creating a Business Action"

• "Creating a Collaboration"

• "Creating a Trading Partner Agreement"

• "Importing Support for Collaborations, Transaction Sets, and UCCnet Standards"

Viewing a Callout Usage

Follow these instructions to view details about a specific callout usage:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Select a specific callout usage to view in the Details column of the Callout Usage section.

   The Callout Usage Details page for the selected callout usage appears.

4. View specific details, including the following.

   • View the callout usage name

   • Callout metadata parameter value. You can also manage (create, view, update, and delete) callout metadata parameter values for the callout usage from this page. This enables you to create parameters unique to a specific callout usage or assign local values that override callout properties set at the callout level.

   This page, as with the Callout Details page shown in Figure 11-5, enables you to delete or update the selected callout usage.

5. Click Return to List to return to the Callout Details page.

Updating a Callout Usage

Follow these instructions to update a callout usage:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Select a specific callout usage to update in the Update column of the Callout Usage section.

   The Update Callout Usage page appears.

4. Make appropriate changes. (See Step 4 for a list of fields you can update.)

5. Click Apply.

   The callout usage is updated and the Callout Usage Details page appears.

Deleting a Callout Usage

Follow these instructions to delete a callout usage:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Select a specific callout usage to delete in the Delete column of the Callout Usage section.

4. Click Yes when prompted to delete a callout usage.

   The callout usage is deleted and the Callout Details page appears.

Creating a Callout Metadata Parameter Value for a Callout Usage

You can create a callout metadata parameter value for a callout usage that enables you to override properties set at the callout level (for example, with the xsltFile property). Callout metadata parameter values are similar in concept to local variables in that they are only applicable to a specific callout usage.

For example, the xsltFile property specifies the location for a specific .xslt file. Within one callout usage, you can assign a value to the xsltFile property that is appropriate for that specific callout usage (for example, /private/RNtoEBStransform.xslt for transformations from RosettaNet XML to Oracle E-Business Suite XML). In another callout usage, you can assign a different value (for example, private/EBStoRNtransform.xslt for transformations from Oracle E-Business Suite XML to RosettaNet XML).

You can also create callout metadata parameter values unique to a specific callout usage.

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Select a specific callout usage in the Details column of the Callout Usage section.

   The Callout Usage Details page for the selected callout usage appears.

4. Click Create in the Callout Metadata Parameter Values section.

   The Create Callout Metadata Parameter Value page appears.

5. Select whether to create or use an existing callout property value.

6. Go to the following steps based on your selection.

   Did You Select the Use Existing Callout Property Check Box?	Go To...
   Yes	Step 7
   No	Step 8

   
   

7. If you selected the Use Existing Callout Property check box, perform Steps 7a through 7b.

   1. Enter the following details to create a callout metadata parameter value. An asterisk (*) indicates a required field.

      Field	Value
      Callout Property	Select a callout property created at the callout level.
      Value *	Enter a callout property value. This value overrides the value set at the callout level.

      
      

   2. Go to Step 9.

8. If you did not select the Use Existing Callout Property check box, perform Steps 8a through 8b.

   1. Enter the following details to create a callout metadata parameter value. An asterisk (*) indicates a required field.

      Field	Value
      Name *	Enter a unique and recognizable name for the callout metadata parameter value.
      Description	Enter an optional description.
      Type *	Select a type (Boolean, date, float, integer, or string). Note: Changing a type can invalidate the callout metadata parameter value default value. Note: The date value does not currently function properly. To use the date value, create a callout property in which you select the date value from the Type list of the Create Callout Property page.
      Encrypt Value	Select False or True. You cannot update this value at a later time.
      Value *	Select Create New to create a new value or Use Existing to select an existing value. If Encrypt Value is set to True, this value is encrypted.

      
      

   2. Go to Step 9.

9. Click Apply.

   The callout metadata parameter value for this callout usage is created and the new Callout Usage Details page appears.

Viewing a Callout Metadata Parameter Value for a Callout Usage

Follow these instructions to view details about a specific callout metadata parameter value for a callout usage:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Select a specific callout usage in the Details column of the Callout Usage section.

   The Callout Usage Details page for the selected callout usage appears.

4. View specific details in the Callout Metadata Parameter Values section, including the callout metadata parameter value name, if the value is encrypted, type (for example, string), and value.

5. Click Return to List to return to the Callout Details page.

Updating a Callout Metadata Parameter Value for a Callout Usage

Follow these instructions to update a callout metadata parameter value of a callout usage:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Select a specific callout usage in the Details column of the Callout Usage section.

4. Select a specific callout metadata parameter value to update in the Update column of the Callout Metadata Parameter Values section.

   The Update Callout Metadata Parameter Value page appears.

5. Update the callout metadata parameter value.

6. Click Apply.

   The callout metadata parameter value is updated and the Callout Usage Details page appears.

Deleting a Callout Metadata Parameter Value of a Callout Usage

Follow these instructions to delete a callout metadata parameter value of a callout usage:

1. Click Partners, then Callouts.

2. Select a specific callout in the Name column.

   The Callout Details page appears.

3. Select a specific callout usage in the Details column of the Callout Usage section.

4. Select a specific callout metadata parameter value to delete in the Delete column of the Callout Metadata Parameter Values section.

5. Click Yes when prompted to delete a callout metadata parameter value.

   The callout metadata parameter value is deleted and the Callout Usage Details page appears.

Acme Server, Task 1: Performing the RosettaNet over RNIF Tutorial

This tutorial assumes you have completed the RosettaNet over the Internet tutorial described in "Tutorial 1: Setting Up a RosettaNet over the Internet Transaction". As part of that tutorial, you set up the Acme server, where Acme was the host trading partner (buyer) and GlobalChips was the remote trading partner (seller).

Acme Server, Task 2: Setting Up Callout Usages

Perform the following callout usage tasks on the Acme server:

• Create an OAG Custom Document Type

• Modify XML Gateway Settings

• Modify the XSLTCallout Settings

• Create a Trading Partner Agreement

• Create and Deploy a Configuration

GlobalChips Server, Task 1: Performing the RosettaNet over RNIF Tutorial

This tutorial assumes you have completed the RosettaNet over the Internet tutorial described in "Tutorial 1: Setting Up a RosettaNet over the Internet Transaction". As part of that tutorial, you set up the GlobalChips server (seller), where GlobalChips was the host trading partner and Acme was the remote trading partner (buyer). On both servers, Acme was the buyer and GlobalChips was the seller.

GlobalChips Server, Task 2: Setting Up Callout Usages

Perform the following callout usage tasks on the GlobalChips server:

• Create an OAG Custom Document Type

• Modify XML Gateway Settings

• Modify the XSLTCallout Settings

• Create a Trading Partner Agreement

• Create and Deploy a Configuration