Siebel Reports Guide > Customizing Siebel CRM Reports > Specifying the Siebel CRM Data That Report Templates Use >

Modifying Integration Objects

This topic describes how to modify a predefined integration object or create a custom integration object so that you can add fields to a report. You can do the following after you modify or create a new integration object:

• Use the integration object when you register a report template. For more information, see Registering Report Templates.
• Use the integration object in the Sample Data File Generation view to create a custom report. For information, see Creating XML Files from Integration Objects.

CAUTION:  If you modify a predefined integration object or create a custom integration object, then it is strongly recommended that you get help from someone who is familiar with using Siebel Tools and configuring Siebel Business Applications. For more information, see Integration Platform Technologies: Siebel Enterprise Application Integration. For more information, see How Siebel Reports Uses Integration Objects.

Modifying Predefined Integration Objects to Add Fields to Reports

Siebel CRM comes with predefined reports and each of these reports references an integration object that provides the report schema. This topic describes how to modify an existing integration object so that Siebel CRM can use it to add fields to a report. If necessary, you can reduce the size of the integration object that you use to improve performance. For more information, see Reducing the Amount of Data That Integration Objects Transfer.

To modify predefined integration objects to add fields to reports

1. Log in to the Siebel client, and then identify the integration object that you must modify:
   1. Navigate to the Administration - BIP Publisher Reports screen.
   2. In the template list, choose the report where you must add a new field.

      For more information, see Views You Use to Register Report Templates.

   3. Note the value that Siebel CRM displays in the Primary Integration Object Name field.

      Siebel CRM prefixes the integration objects that it uses with BIP.

2. Add a new field to the integration object:
   1. Log in to Siebel Tools.
   2. In the Object Explorer, click Integration Object.

      If the Object Explorer does not display the Integration Object type, then do the following:

      • Click the View menu, and then the Options menu item.
      • In the Development Tools Options dialog box, click the Object Explorer tab.
      • Make sure the integration object and all child object types of the integration object type contains a check mark, and then click OK.
   3. In the Integration Objects list, locate the integration object that you identified in Step 1.
   4. In the Object Explorer, expand the Integration Object tree, expand the Integration Component tree, and then click Integration Component Field.
   5. Scroll through the Integration Component Field list until you locate the field that the report must display.
   6. Note the values in the following properties:
      • External Name
      • External Data Type
      • External Length

        Each of these properties reference a property of the business component field that contains the data that the report must display. For example, the External Name of the integration object field references the Name property of the business component field.

   7. In the Integration Component Field list, create a new integration component field:
      • Enter the values you noted in Step f into the External Name, External Data Type, External Length properties.
      • Set the XML Sequence property.
      • Set the XML Tag property. You typically set the XML Tag property to the same value that the Name property contains.

        Siebel CRM uses these XML properties when it uses the XML file to get data from the Siebel Database. You must you use the syntax that an XML tag requires. You must not include any spaces or special characters. The following prefix is not required:

   ss_

3. Reduce the Size of the integration object that you modified in Step 2.

   For more information, see Reducing the Amount of Data That Integration Objects Transfer.

4. Compile your changes.
5. Deploy the integration object:
   1. In the Integration Objects list, right-click the integration object you located in Step c, and then click Deploy to Runtime Database.

      Siebel CRM overrides the object definition that the SRF file contains for this integration object.

   2. Log in to the Siebel client, navigate to the Administration - Web Services screen, and then the Deployed Integration Objects view.
   3. Query for the integration object that you deployed in Step a to make sure Siebel CRM deployed it successfully.
   4. Navigate to the Administration - Web Services screen, and then Inbound Web Services view.
   5. Click Clear Cache to update the run-time database.
6. (Optional) Deploy the modified SRF to the production environment.

   For more information, see Deploying Reports..

Creating New Integration Objects to Add Fields to Reports

Siebel CRM populates a QueryString field in the sample XML and parses it as a field value in the integration object while the report runs, by default. This field contains the user-defined query that the user entered to run the report. You can display this field value on the report template. For example, the format of the field might be [Account Status] = "Active"].

To create a new integration object to add fields to reports

1. Make sure no predefined integration objects exist that meet your report layout requirements.

   Siebel CRM comes with predefined integration objects. It is recommended that you create a new integration object only if the predefined integration objects do not meet your requirements. For more information, see Modifying Predefined Integration Objects to Add Fields to Reports.

2. Log in to Siebel Tools.
3. In the Object Explorer, click Integration Object.
4. Right-click in the Integration Objects list, click New Objects Wizard, and then click Integration Object.
5. Use the Integration Object Builder wizard to create the new integration object.

   Note the following:

   • Make sure you prefix the name of this new integration object with BIP. You must add the BIP prefix so that Siebel CRM displays this integration object in the Sample Data File Generation view in the client. For information about this view, see Creating XML Files from Integration Objects.
   • Make sure you include in the integration component any fields that the user can query in the applet that references the master business component. For more information, see About Master-Detail Reports.
6. Reduce the Size of the integration object that you created in Step 5.

   For more information, see Reducing the Amount of Data That Integration Objects Transfer.

7. Compile your changes.
8. Deploy the integration object:

   Do Step 5, except deploy the integration object you added in Step 4.