XML Files Reference

This chapter describes the code in the XML files that Siebel CRM Desktop includes in the customization package. It includes the following topics:

Getting Information About Tags of the Metadata Files

The metadata files that Siebel CRM Desktop uses includes a number of tags that you can modify. XSD files include documentation for many of these tags. To get a copy of these files and to view the documentation that they contain, see Article ID 1502099.1 on My Oracle Support.

XML Code That Maps a Field

This topic describes the code of the Ln_siebel_basic_mapping.xml file. It includes the following topics:

For more information, see Customizing Field Mapping.

Example Code of the Siebel Basic Mapping File

The following code is an example of the Ln_siebel_basic_mapping.xml file:

<root>
  <types>
    <type id="Contact" form="SBLPerson">
      <post_sync_processor>
        <contact_post_processor/>
      </post_sync_processor>
      <field id="First Name" ver="1">
        <reader>
          <lotus_std>
            <lotus_field id="FirstName"/>
            <convertor>
              <string/>
            </convertor>
          </lotus_std>
        </reader>
        <writer>
          <lotus_std>
            <lotus_field id="FirstName"/>
            <convertor>
              <string/>
            </convertor>
          </lotus_std>
        </writer>
      </field>
      <field id="Last Name" ver="1">
        <reader>
          <lotus_std>
            <lotus_field id="LastName"/>
            <convertor>
              <string/>
            </convertor>
          </lotus_std>
        </reader>
        <writer>
          <lotus_std>
            <lotus_field id="LastName"/>
            <convertor>
              <string/>
            </convertor>
          </lotus_std>
        </writer>
      </field>
    </type>
  </types>
</root>

Type Tag of the Siebel Basic Mapping File

The type tag defines the Siebel CRM object that Siebel CRM Desktop maps to IBM Notes.

Siebel CRM Desktop includes the following attributes in the type tag:

id. Defines the ID or name of the Siebel CRM object that Siebel CRM Desktop maps to IBM Notes.
form. Defines the ID of the form that Siebel CRM Desktop uses to display the object that the type tag defines.

Field Tag of the Siebel Basic Mapping File

The field tag describes the field mapping. It describes one field, so the number of field tags must be the same as the number of fields that are mapped.

The field tag includes the following attributes:

id. Defines the field identifier. For example, the API name of the field. To assign a control to this field on a form, Siebel CRM Desktop also uses the value of this attribute in the forms.dxl file.
ver. Used during development. Siebel CRM Desktop does not apply any change to the field description until the value of the ver attribute increases.

Writer Tag of the Siebel Basic Mapping File

The writer tag defines write access to the field that Siebel CRM Desktop maps to IBM Notes. It includes only the class attribute. The following values are available for the class attribute:

lotus_std
rich_string
attached_file_writer
attached_filename_writer
multiwriter

The writer tag can include the following tags:

lotus_field
convertor
linked_fields

XML Code That Customizes Platform Configuration

This topic describes the XML code that you can use to customize the platform configuration. The following code is an example of the platform_configuration.xml file. For more information, see Files in the Customization Package:

<platform>
  <initialization_script>
    <![CDATA[
      application.settings.set("ProgressFormAutoshow", 0);
    ]]>
  </initialization_script>
</platform>

XML Code That Customizes Synchronization

This topic describes the code of the Ln_connector_configuration.xml file. It includes the following topics:

For more information, see Customizing Synchronization.

Example Code of the Connector Configuration File

The following code is an example of the Ln_connector_configuration.xml file:

<root>
  <types>
    <type id="Opportunity">
      <view label="Opportunity" label_plural="Opportunities" 
small_icon="type_image:Opportunity:16" normal_icon="type_image:Opportunity:24" 
large_icon="type_image:Opportunity:48"></view>
        <synchronizer name_format=":[:(Name):]">
          <links>
            <link>Account Id</link>
            <link>Currency Code</link>
          </links>
        <natural_keys>
          <natural_key>
            <field>Name</field>
          </natural_key>
        </natural_keys>
        </synchronizer>
      </type>
    </types>
    <filter_presets>
      <preset name="Test filters">
        <type id="Action">
          <group link="and">
            <binary field="Planned" condition="ge">
              <value type="function">today</value>
            </binary>
          </group>
        </type>
    </preset>
  </filter_presets>
</root>

Types Tag of the Connector Configuration File

The types tag describes the types of objects to synchronize. It does not contain attributes. It does contain a set of type tags. You must describe these types in the Ln_siebel_basic_mapping.xml file.

Type Tag of the Connector Configuration File

The type tag describes the type to synchronize. You must describe it in the Ln_siebel_basic_mapping.xml file. It includes the id attribute that defines the ID of the object.

The type tag must contain the following tags:

view
synchronizer

View Tag of the Connector Configuration File

The view tag defines the type in the user interface. It defines the Filter Records tab on the Synchronization Control Panel dialog box.

The view tag includes the following attributes:

label. Label that displays this object in the Synchronization Control Panel dialog box if Siebel CRM Desktop cannot resolve the name of this object.
label_plural. Label that displays this object in the Synchronization Control Panel dialog box if the label is most appropriately displayed in plural.
small icon. Defines a 16-by-16 pixel icon that Siebel CRM Desktop uses for this object on the Synchronization Control Panel dialog box.
normal_icon. Defines the icon that displays next to the object type in the Filter Records tab of the Synchronization Control Panel dialog box.
large_icon. Defines the icon that displays in the Siebel CRM Desktop Synchronization dialog box while Siebel CRM Desktop synchronizes this type of object.
suppress_sync_ui. If suppress_sync_ui is true, then this attribute hides objects of this type from the Filter Records tab of the Synchronization Control Panel dialog box. If suppress_sync_ui is not defined, then Siebel CRM Desktop applies the false value, by default.

For more information, see Controlling the Object Types That Siebel CRM Desktop Displays in the Filter Records Tab.

Synchronizer Tag of the Connector Configuration File

The synchronizer tag describes attributes that the Synchronization Engine requires. For example, it describes relationships between objects or criteria to identify duplicate objects.

The synchronizer tag includes the name_format attribute that defines the format of the output string for objects of this type. Siebel CRM Desktop uses this string if objects of this type are displayed on the Check Issues, Resolve Conflicts, Resolve Duplicates, or Confirm Synchronization tab of the Control Panel in the Siebel CRM Desktop add-in.

The synchronizer tag can contain the following tags:

links
natural_keys

Links Tag of the Connector Configuration File

The links tag describes the references between types. You must specify it in the synchronizer tag. Note the following requirements:

You must use the links tag to describe all fields that Siebel CRM Desktop uses to store references between objects. A link field is an example of a field that Siebel CRM Desktop uses to store a reference between objects.
You must describe all links in the links tag.

The links and link tags do not contain attributes.

Example Code of the Links Tag

The following code is an example of the links tag:

<links>
  <link>Account Id</link>
  <link>Opportunity Id</link>
  <link>Created By</link>
  <link>Primary Owner Id</link>
</links>

Natural Key Tag of the Connector Configuration File

The natural_key tag is defined in the synchronizer tag. You use it to configure criteria to identify duplicated records during synchronization. The natural_key tag includes the following items:

A set of natural_key tags that describe the criteria. Siebel CRM Desktop uses OR logic for all criteria that the natural_key tag describes.
A set of field tags. Each of these tags includes a field name that Siebel CRM Desktop examines to identify duplicates. Siebel CRM Desktop uses AND logic for all field tags.

Example Code of the Natural Key Tag

The following code is an example of the natural_keys tag:

<natural_keys>
  <natural_key>
    <field>First Name</field>
    <field>Last Name</field>
  </natural_key>
  <natural_key>
    <field>Email Address</field>
  </natural_key>
</natural_keys>

In this code, if one of the following situations is true, then Siebel CRM Desktop detects two objects as duplicates:

First Name AND Last Name contain the same values
Email Address fields contain the same values

Filter Presets Tag of the Connector Configuration File

The filter_presets tag contains predefined filter criteria. The preset tag describes this criteria. The preset tag includes the name attribute. It defines the name for this criteria. The preset tag contains a set of type tags that specify filter criteria for each type.

The type tag defines the object type. Siebel CRM Desktop applies the filter criteria to this object type. You must specify the object type in the id attribute of this tag. The group tag describes a group of criteria.

Example Code of the Filter Presets Tag

The following code is an example usage of the filter_presets tag of the Ln_connector_configuration.xml file:

<filter_presets>
  <preset name="Test filters">
    <type id="Opportunity">
      <group link="and">
        <binary field="Status" condition="in">
          <value type="array">
            <value type="string">Accepted</value>
            <value type="string">Pending</value>
            <value type="string">Rejected</value>
            <value type="string">Rerouted</value>
          </value>
        </binary>
      </group>
    </type>
      <type id="Action">
        <group link="and">
          <binary field="Planned" condition="ge">
            <value type="function">today</value>
          </binary>
        </group>
      </type>
  </preset>
</filter_presets>

Example Code That Sets the Size and Type of Field

This topic describes code you can use to set the size and type of field. For more information, see Controlling the Size and Type of Synchronized Records. The following code is an example usage of the group tag of the Ln_connector_configuration.xml file to set the size and type of field:

<group link="and">
  <binary field="FileSize" condition="le">
   <value type="integer">5242880</value>
   </binary>
   <group link="or">
   <binary field="FileExt" condition="eq">
   <value type="string">doc</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">docx</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">xls</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">xlsx</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">msg</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">txt</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">rtf</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">html</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">ppt</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">pptx</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">pdf</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">mht</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">mpp</value>
   </binary>
   <binary field="FileExt" condition="eq">
   <value type="string">vsd</value>
   </binary>
   </group>
 </group>