User Defined Lists File
Previous Top Next

 

The User Defined Lists File (files with extension ls.csv) contains a list of possible values for the attributes in the Optionee File The User Defined Lists File is used to define criteria for report grouping.

Insertions and Modifications
Upload file can contain both new records, and updates to existing records.
A row is uniquely identified by a combination of the Attribute Name and Attribute Value.

If there is more than one record in the User Defined Lists file with the same Attribute Name and Attribute Value, the system will assume that the last record is supposed to update the previous record(s).  The previous record(s) will be lost and no validation error will be reported.


Deletions

To delete a record, you can add a record in an acceptable .CSV file format that contains only the Attribute Name. Deletion records can be in the same file as insertion and modification records.

Attribute Names can only be deleted if they are not being referenced by any Optionee entries.

Deleting an Attribute Name will delete all of the Attribute Values for that name when the Attribute Type is “List”.

At the moment there is no way to delete a single Attribute Value.


File Format

#
Field Name
P =Required
Field Type
Sample Field
Description
1
AttributeName
P
Alpha-Numeric (40)
Title
To attach values from this list to an optionee, the list name should match the optionee attribute name
2
AttributeType
P
List Selection
(Enumeration)
STRING
The Item Type can be BOOLEAN or the value LIST.
Both upper and lower case allowed
3
AttributeValue
 
Alpha-Numeric (40)
CEO
The value that gets attached to an Optionee.
Required if the AttributeType = LIST
4
AttributeDescription
 
Alpha-Numeric (40)
Chief Executive Officer
The long description of the list item.
5
AttributeLevel
 
List Selection (Enumeration)
Grant
The value in this field specifies that the Attribute Name is for the Grant or the Optionee Level


Examples

To properly load, fields in each row of the file must be in the following sequence:

AttributeName,AttributeType,AttributeValue,AttributeDescription,AttributeLevel

An example of valid lines in a user defined lists file are as follows (note the extra comma used to identify the missing optional Item Description field in the second example):

Location,List,PHX,Phoenix
Title,List,CEO Chief Executive Officer,Optionee