Bookshelf Home | Contents | Index | PDF     

Siebel Order Management Guide Addendum for Communications > Employee Asset-Based Ordering > Roadmap for Configuring Bulk Requests >

Process of Adding Custom Fields to Import Template Files

To add custom fields to import template files, administrators perform the following tasks:

  1. Adding Custom Fields to Business Components.
  2. Adding Custom Fields to Integration Components.
  3. Generate the schema for the integration object for importing bulk requests. For more information, see Integration Platform Technologies: Siebel Enterprise Application Integration.
  4. Setting Up the Version Number for Import Template Files.
  5. Updating the XLS Source File.

Then, use the new XLS source file and the new schema file and to create the new import template files that contain the custom fields. For more information, see Creating Bulk Import Template Files.

This process is a step in Roadmap for Configuring Bulk Requests.

Adding Custom Fields to Business Components

A developer can add new fields to bulk requests to accommodate business needs. The developer must add the new fields to the appropriate business components. The business components to which you might want to add fields include:

  • ABO Bulk Request - Orders
  • ABO Bulk Request - Quotes
  • ABO Bulk Request Action Field Names
  • ABO Bulk Request Action Set
  • ABO Bulk Request Action Set - Simple
  • ABO Bulk Request Action Set Orders
  • ABO Bulk Request Action Set Quotes
  • ABO Bulk Request Actions
  • ABO Bulk Request Actions - Simple
  • ABO Bulk Request Exceptions
  • ABO Bulk Request Header
  • ABO Bulk Request Header - Simple
  • ABO Bulk Request Instance
  • ABO Bulk Request Instance - Simple

This task is a step in Process of Adding Custom Fields to Import Template Files.

To add custom fields to business components

  1. Log in to Siebel Tools.
  2. In the Object Explorer, click Business Component.
  3. In the Business Components list, select the business component to which you want to add the new field.
  4. Lock this business component so that you can change it.
  5. In Object Explorer, navigate to Business Component, then the Field, and in the Fields list, add the new field to the business component.
  6. Compile the object for your changes into the Siebel Repository File (SRF).
  7. Unlock the business component.

Adding Custom Fields to Integration Components

After you add custom fields to business components, you must add those fields to the appropriate integration components on the integration object for the import template file. You can add fields to the following integration components:

  • ABO Bulk Request Action Set
  • ABO Bulk Request Instance
  • ABO Bulk Request Actions

This task is a step in Process of Adding Custom Fields to Import Template Files.

To add custom fields to integration components

  1. Log in to Siebel Tools.
  2. In the Object Explorer, click Integration Object.
  3. In the Integration Objects list, select ABO Bulk Request Import integration object.
  4. Lock this integration object so that you can change it.
  5. In Object Explorer, navigate to Integration Object, then the Integration Component.
  6. In the Integration Components list, select the integration component to which you want to add new fields.
  7. In Object Explorer, navigate to Integration Object, then the Integration Component, then the Integration Component Field.
  8. In the Integration Component Fields list, add the custom fields to the integration component.
  9. Compile the object for your changes into the Siebel Repository File (SRF).
  10. Unlock the integration object.

Setting Up the Version Number for Import Template Files

Each set of import template files that the administrator creates must have the same version number. Though any prior template versions are still available, you set the version number for the new templates to make sure that users can access only the new import template files to create bulk requests.

This task is a step in Process of Adding Custom Fields to Import Template Files.

To set the version number for import template files

  1. Navigate to the Administration - Application screen, then the System Preferences view.
  2. Query for Bulk Request Template Version in the System Preference Name field.
  3. Change the version number in the System Preference Value field to the version number for the new import template files.

Updating the XLS Source File

If an administrator changes bulk requests to include new custom fields, then the administrator must also change the XLS source file that creates the XML import template files that users complete to import data into those bulk requests. To update the XLS source file, you update the Meta Data worksheet and the macro procedures in that file.

This task is a step in Process of Adding Custom Fields to Import Template Files.

To update the XLS source file

  1. Open the XLS source file.
  2. Update the meta data for the file. In the Meta Data worksheet:
    1. Change the number in the Version Number field to the new version number for the import template files.
    2. If you change the name or location of the schema file, then change the Schema File Name variable.
    3. If you change the name or location of the export file, then change the Export File variable.
  3. Update the macro procedures by navigating to Tools, then Macro, then Macros, selecting any macro name, and clicking Edit.
  4. If you add a field to a bulk request action set business component, then update the HeaderMap procedure by adding the following code:

       Range("<title cell reference>").Select
       ActiveCell.FormulaR1C1 = "<    field name>"
       ActiveCell.Font.Bold = True
       Set xp = ActiveSheet.Range("<    value cell reference>").XPath
       strXPath = "/SiebelMessage/ListOfAboBulkRequest/AboBulkRequestHeader
       /ListOfAboBulkRequestActionSet/AboBulkRequestActionSet/<    field name>"
       xp.SetValue myMap, strXPath

    where:

    • title cell reference is the reference of the worksheet cell that will contain the name of the new action set field.
    • value cell reference is the reference for the worksheet cell that will contain the value of the new action set field.
    • field name is the name of the new action set field.

      For example, to add a new action set field named Custom, the code is as follows:

         Range("E4").Select
         ActiveCell.FormulaR1C1 = "Custom"
         ActiveCell.Font.Bold = True
         Set xp = ActiveSheet.Range("E5").XPath
         strXPath = "/SiebelMessage/ListOfAboBulkRequest/AboBulkRequestHeader
         /ListOfAboBulkRequestActionSet/AboBulkRequestActionSet/Custom"
         xp.SetValue myMap, strXPath

  5. If you add a field to a bulk request action business component, then update the ActionMap procedure as follows:
    1. Update the range of worksheet cells that will contain the action fields in the following code:

         Range("<first cell title reference>:<last cell title reference>").Select
         Set myMap = ActiveWorkbook.XmlMaps(mapName)
         Set actionList = ActiveSheet.ListObjects.Add

      where:

      • first cell title reference is the reference for the worksheet cell that will contain the name of the first action field.
      • last cell title reference is the reference for the worksheet cell that will contain the name of the last action field.

        For example, if 10 fields exist in the action set, then the first line of code might be:

           Range("A7:J7").Select

    2. Add the following code for the new action field:

         strXPath = "/SiebelMessage/ListOfAboBulkRequest/AboBulkRequestHeader
         /ListOfAboBulkRequestActionSet/AboBulkRequestActionSet
         /ListOfAboBulkRequestActions/AboBulkRequestActions/<      field name>"
         actionList.ListColumns(<      column number>).XPath.SetValue myMap, strXPath
         Range("<      title cell reference>").Value = "<field name>"

      where:

      • field name is the name of the new action field.
      • column number is the number of the worksheet column for the new action field.
      • title cell reference is the reference of the worksheet cell that will contain the name of the new action field.

        For example, to add a new field named Custom, the code is as follows:

           strXPath = "/SiebelMessage/ListOfAboBulkRequest/AboBulkRequestHeader
           /ListOfAboBulkRequestActionSet/AboBulkRequestActionSet
           /ListOfAboBulkRequestActions/AboBulkRequestActions/Custom"
           actionList.ListColumns(10).XPath.SetValue myMap, strXPath
           Range("J7").Value = "Custom"

  6. If you add a field to a bulk request instance business component, then update the UserMap procedure as follows:
    1. Update the range of worksheet cells that will contain the instance fields in the following code:

         Range("<first cell title reference>:<last cell title reference>").Select
         Set myMap = ActiveWorkbook.XmlMaps(mapName)
         Set userList = ActiveSheet.ListObjects.Add

      where:

      • first cell title reference is the reference for the worksheet cell that will contain the name of the first instance field.
      • last cell title reference is the reference for the worksheet cell that will contain the name of the last instance field.

        For example, if three fields exist in the action set, then the first line of code might be:

           Range("K7:M7").Select

    2. Add the following code for the new instance field:

         strXPath = "/SiebelMessage/ListOfAboBulkRequest/AboBulkRequestHeader
         /ListOfAboBulkRequestActionSet/AboBulkRequestActionSet
         /ListOfAboBulkRequestInstance/AboBulkRequestInstance/<      field name>"
         userList.ListColumns(<      column number>).XPath.SetValue myMap, strXPath
         Range("<      title cell reference>").Value = "<field name>"

      where:

      • field name is the name of the new instance field.
      • column number is the number of the worksheet column for the new instance field.
      • title cell reference is the reference of the worksheet cell that will contain the name of the new instance field.

        For example, to add a new field named Custom, the code is as follows:

           strXPath = "/SiebelMessage/ListOfAboBulkRequest/AboBulkRequestHeader
           /ListOfAboBulkRequestActionSet/AboBulkRequestActionSet
           /ListOfAboBulkRequestInstance/AboBulkRequestInstance/Custom"
           userList.ListColumns(4).XPath.SetValue myMap, strXPath
           Range("N7").Value = "Custom"

    
Siebel Order Management Guide Addendum for Communications Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.