listmanager_list.xml

You can use the listmanager_list.xml file to configure the view list screens.

List

The List element describes the list display format. You can define several display formats if the code is unique. You can choose the format to apply when opening the list screen. For example, you can create a contact format that displays only the name, address, and phone number of the contact and create a demographic format to display the income, age, and gender of the contact.

This element contains the following attributes:

  • Name - The name of the list display format.
  • Code - The code of the list display format. It must be unique.
  • AudienceLevel - The audience level the list display format is based on. This audience level is defined in the listmanager_tables.xml file.
  • Multiple - If set to true, you can select more than one member of the list. If set to false, you can select only one member of the list.
  • Datasource - The name of the data source that is used to access the table from the customer database.

For example:

<List Name="Contact" Code="CONTACT" AudienceLevel="Individual" 
	Datasource="JNDI_Name_for_customer_DB">

Each List element can contain Select, Order, and Link child elements:

<List ... >
 <Select ... />
 <Order ... />
 <Link . . . />
</List>

Select

The Select element describes the table and columns to display in the list content. Collaborate displays the columns in the same order as they appear in this file.

This element contains the following attributes:

  • Table - The name of the table to display. It must also be defined in the listmanager_tables.xml file.
  • Column - The name of the column to display from the related table. It must also be defined in the listmanager_tables.xml file.
  • Label - The label of the column header. It is a tag that is replaced by a localized descriptor contained in each list_language.properties resource bundle file.
  • Filtering - The attribute that allows you to filter the list content. The possible values are true or false.
  • Format - The attribute for formatting does not apply to values of a column if it is false. If it is not mentioned, the system considers it as true. It is applied to column with a number or integer data type. (It is different from Format in listmangaer_searchscreen.xml). For example, if the Column attribute has value of 1234 and this parameter is not mentioned or is set to true, then the value is displayed as 1,234. If this parameter is set to false, then the value is displayed as 1234.
  • FilteringUsingDropdown - This attribute allows you to filter by using a drop-down list, only if Filtering = true.

For example:

<Select Table="v_indiv_contact" Column="indiv_id" Label="indiv_id"/>

Order

The Order element describes the default sorting columns. It contains the following attributes:

  • Table - The name of the table that contains the sorting column(s). It must also be defined in the listmanager_tables.xml file.
  • Column - The column on which the sorting is based. It must also be defined in the listmanager_tables.xml file.
  • Label - The order type. The valid values are ASC for ascendant sorting or DESC for descendant sorting.

For example:

<Order Table="v_indiv_contact" Column="last_name" Type="ASC"/>

Link

The Link element describes the URL for the external application that contains customer details. The Link element is optional. It contains the following attributes:

  • URL - The base URL of the application, without any parameters.
  • Label - The link label or icon tooltip.
  • Logo - The name of a file as use as the icon. (optional)
  • LogoHeight - The height of the icon. (Use only with the Logo attribute.)
  • LogoWidth - The width of the icon. (Use only with the Logo attribute.)
  • NavName - The browser name.

Each Link element can contain multiple Param child elements.

For example:

<Link Url="http://localhost:7073/LeadsContact/callLeads.jsp"
Label="last_name" Logo="contact.gif">
 <Param Name="affiniumUserName" Type="user" Value="userlogin"/>
 <ParamName="LeadsRmcTbid" Type="column" Value="v_customer_contact.customer_id"/>
</Link>

Param

The Param element describes a parameter to add to the base URL. It contains the following attributes:

  • Name - The http parameter name.
  • Type - The type of information to send. The valid values are user to send the current logged user information and column to send the value of a specified column.
  • Value - The specific information to send. If the Type attribute value is user, the valid values of the Value attribute are userlogin and userid. If the Type attribute value is column, the valid value of the Value attribute is the column whose value should be appended to the base URL, specified as Table.column.
  • DateFormat - The format for sent dates. Used only for a date column (type D or F).

For example:

<Param Name="affiniumUserName" Type="user" Value="userlogin"/>
<ParamName="LeadsRmcTbid" Type="column" Value="v_customer_contact.customer_id"/>