Bookshelf Home | Contents | Index | PDF     

Siebel CRM Desktop for Microsoft Outlook Administration Guide > XML Files Reference > XML Code That Customizes Forms >

Types of Controls for the Control Tag of the Forms File

This topic describes the types of controls you can configure for the control tag of the forms_xx.xml file. It includes the following topics:

Values of the Control Tag of the Forms File

Table 52 describes the values you can specify for the class attribute of the control tag of the forms_xx.xml file.

Table 52. Values You Can Specify for the Class Attribute of the Control Tag
Value
Description

button

A button control. if you use this control, then it is not necessary to use a field tag.

checkbox

A check box control. The field that the field tag assigns to this control must include the following configuration:

  • The name of the field
  • The field type must be Boolean

combobox

A simple control that allows the user to choose any value from a list. For more information, see Combobox Control of the Forms File.

datetime

A datetime control that allows the user to choose a date from a calendar. The field tag must contain the date or datetime field.

dropdown

A control that displays a menu when the user clicks the control. For example, if the user clicks Addresses on the contact form, then Siebel CRM Desktop displays Personal Addresses or Business Addresses. For more information, see Dropdown Control of the Forms File.

edge

A panel control that includes a border. If you use this control in a cell where the size is 1, such as with a separator, then it is not necessary to use a field tag.

edit

A simple edit box control.

gradient_checkbox

A control that behaves like a check box control, but uses a different graphical interface. This control displays on the Sharing bar.

lookup

A control that the user can use to choose any object. CRM Desktop uses a lookup control to establish a relationship between objects. For example, to link an account with a contact. For more information, see Lookup Control of the Forms File.

multi_currency

A control that CRM Desktop uses to display the values from more than one field, such as price, revenue, and so on. An example usage of the multi_currency control is where CRM Desktop must display the amount and currency values in a single field. For more information, see Multicurrency Control of the Forms File.

mvg_primary_selector

A control that CRM Desktop uses to display the primary association in a many-to-many (M:M) relationship. For more information, see MVG Primary Selector Control of the Forms File.

static

A static control that you can use as a label on a form. If you use this control, then it is not necessary to use a field tag.

subform

A group of controls that you can use to display the fields of one object on the form of another object. For example, you can display a Siebel CRM activity on the native form for the Outlook task or calendar . For more information, see Subform Control of the Forms File.

Combobox Control of the Forms File

If you set the class attribute of the control tag to combobox, then you must specify the following tags in the control tag:

  • source. Describes the list values for this control. The source tag includes the following attributes:
    • type. Contains the ID of a list that the siebel_basic_mapping.xml file describes.
    • field. Contains the name of the field that Siebel CRM Desktop displays as a list value.
    • format. Defines the mask for this field output. Attributes are usually the same for all lists that drop down. It uses the following format:

    field="Value"

    format=":[:(Label):]"

    Although Label is a variable, you must specify it as an absolute value, as described here.

  • field. A field of an object that stores a value that the user chooses in a list.
Example Code of the Combobox Control

The following code illustrates usage of the combobox control:

<control id="0x20105" class="combobox">
  <source type="ContactLeadSourcePicklist" field="Value" format=":[:(Label):]"/>
  <field>LeadSource</field>
</control>

Dropdown Control of the Forms File

The dropdown control of the forms_xx.xml file is a button that includes menu options. If the user clicks this button, then Siebel CRM Desktop displays the menu. You add menu items for this menu to a script.

If you set the class attribute of the control tag to dropdown, then you must specify the following tags in the control tag:

  • control. Contains more tags that you can use to describe the dropdown control.
  • text. The value in the control tag that you can use to specify the text of the dropdown control.

To specify the caption for the dropdown control, you can use the caption attribute.

Example Code of the Dropdown Control

The following code illustrates usage of the dropdown control:

<cell size="22">
  <control id="dd_contacts" class="dropdown" caption="#lbl_contacts" tab_order="1" visible="false"></control>
</cell>

Lookup Control of the Forms File

If you set the class attribute of the control tag to lookup, then you must specify the following tags in the control tag:

  • source. Describes the list values for this lookup control. The source tag includes the following attributes:
    • type. Contains the ID of an object that Siebel CRM Desktop uses in this control.
    • field. Not used.
    • format. Defines the mask for this field output. For example:

    format=":[:(First Name) :]:[:(Last Name):]"

    • resource_id. Defines the ID of the description for the lookup dialog box that the lookup_view_defs.xml file describes. For more information, see Customizing the SalesBook Control.
  • field. The field of an object that stores the ID of the object that the user chooses in a lookup object.
Example Code of the Lookup Control

The following code illustrates usage of the lookup control:

<control id="0x20100" class="lookup">
  <source type="All Items" format=":[:(FirstName) :]:[:(LastName):]" resource_id="lookup:all_types"/>
  <source type="Contact" format=":[:(FirstName) :]:[:(LastName):]" resource_id="lookup:contacts"/>
</control>

Multicurrency Control of the Forms File

If you set the class attribute of the control tag to multi_currency, then you must specify the following tags in the control tag:

  • value_field. Contains the amount field name.
  • currency_field. Contains the currency field name.
  • exchangedate_field. Contains the exchange date field value. This tag is optional.
Example Code of the Multi Currency Control

The following code illustrates usage of the multi_currency control:

<control id="1" class=" multi_currency " tab_order="1">
  <value_field>Revenue</value_field>
  <currency_field>Currency</currency_field>
  <exchangedate_field>Date</exchangedate_field>
</control>

MVG Primary Selector Control of the Forms File

If you set the class attribute of the control tag to mvg_primary_selector, then you must specify the following tags in the control tag:

  • source. Behavior is similar to the lookup control. The source tag includes the following attributes:
    • type. Defines the many-to-many association ID that Siebel CRM Desktop uses for this control.
    • linking_field. Contains the field name of this association where the ID of the parent object is saved.
    • flag_field. Contains the field name that CRM Desktop uses to set the primary flag.
    • display_format. Defines the output mask.

Subform Control of the Forms File

The following code illustrates usage of the subform control:

<cell size="22">
  <control class="subform" id="activity_subform">
    <cell size="22">
      <stack layout="horz" spacing="20" padding="6">
        <cell>
          <control class="static" id="ActivityLabel">
            <text>Activity Name:</text>
          </control>
        </cell>
        <cell>
          <control class="edit" id="ActivityName">
            <field>Name</field>
          </control>
        </cell>
      </stack>
    </cell>
  </control>
</cell>

Web Page Control of the Forms File

If you set the class attribute of the control tag to web_page, then you must specify the url attribute in the control tag. The following code illustrates usage of the web_page control:

<control class="web_page" id="linkedin_search">
    <url>http://www.linkedin.com/</url>
  </control>

You can specify a static or a dynamic URL as the value of the url attribute. If the URL is dynamic, then JavaScript supports it. For example, you can present a dynamic personal page for a business contact on the Contact form. The following is an example of this JavaScript:

if (!is_new)
  form.linkedin_search.navigate = "http://www.linkedin.com/pub/dir/?last=" + form.item['Last Name'] + "&first=" + form.item['First Name'];

If the url attribute is not set, then Siebel CRM Desktop loads the about:blank page, by default.

      
Siebel CRM Desktop for Microsoft Outlook Administration Guide Copyright © 2018, Oracle and/or its affiliates. All rights reserved. Legal Notices.