Customizing › Expose Additional Data Fields

Expose Additional Data Fields

• The Business Unit, Account and User schemas provide several additional data fields which can be exposed in the user interface to allow customers to record extra data elements.
• Business Unit Data Fields

  The additional data fields for business units are found in the usm_tenant table in the following fields:

  data1: nvarchar(32)
  data2: nvarchar(32)
  data3: nvarchar(32)
  data4: nvarchar(64)
  data5: nvarchar(64)
  data6: nvarchar(128)
  data7: nvarchar(128)

• Account Data Fields

  The additional data fields for accounts are found in the usm_account table in the following fields:

  data1: nvarchar(32)
  data2: nvarchar(32)
  data3: nvarchar(32)
  data4: nvarchar(64)
  data5: nvarchar(64)
  data6: nvarchar(64)
  data7: nvarchar(128)

• User Data Fields

  The additional data fields for users are found in the usm_contact_extension table in the following fields:

  data1: nvarchar(512)
  data2: nvarchar(512)
  data3: nvarchar(512)
  data4: nvarchar(512)
  data5: nvarchar(512)
  data6: nvarchar(512)
  data7: nvarchar(512)

By default, these additional data fields are not shown on the user interface screens that allow you to add, edit and view the profile information for business units, accounts and users.

The user interface label for each data field is established in a file named custom.xml. This file can be different based on the language chosen for the system and will be located in a different folder for each language. For example, for English (icusen), the custom.xml file is located in the %USM_HOME%\view\webapps\usm\locale\icusen folder.

The custom.xml file looks like this:
<?xml version="1.0" encoding="UTF-8"?>
<shared>
	<account>
		<data1></data1>
		<data2></data2>
		<data3></data3>
		<data4></data4>
		<data5></data5>
		<data6></data6>
		<data7></data7>
	</account>

	<tenant>
		<data1></data1>
		<data2></data2>
		<data3></data3>
		<data4></data4>
		<data5></data5>
		<data6></data6>
		<data7></data7>
	</tenant>

	<user>
		<data1></data1>
		<data2></data2>
		<data3></data3>
		<data4></data4>
		<data5></data5>
		<data6></data6>
		<data7></data7>
	</user>
</shared>

By default, each additional data field does not have a label. To cause a data field to be shown on the user interface, establish a label for the data field in the custom.xml file.

To expose an additional data field in the user interface

1. Use an editor, such as Notepad, to edit the appropriate custom.xml file for the language of your system. For example, for English, edit the %USM_HOME%\view\webapps\usm\locale\icusen\custom.xml file.
2. Type in the label you would like to appear in the user interface between the start and end tags for the appropriate field (data1-data7) for the appropriate object (account, tenant (business unit) or user).
3. Save the custom.xml file and test by using the appropriate object’s add, edit and profile user interface screens.

Example:

To expose the account data1 and account data 5 fields to hold Cost Center and Department information, alter the <account> entries in the custom.xml file, as shown below:

	<account>
		<data1>Cost Center</data1>
		<data2></data2>
		<data3></data3>
		<data4></data4>
		<data5>Department</data5>
		<data6></data6>
		<data7></data7>
	</account>

Note: To expose a field without using a label, make the label have the value of a space.