You create code lists in reference data sets. A code list inherits its structure definition and attributes from the reference data set. You can define additional attributes or display columns, and assign stakeholders to a code list that are different from the reference data set.
Later, you create or import a set of code values from a source system into the code list.
Create a code list in a reference data set, and configure the general properties, external URLs, notification recipients, and status of the code list.
Before you begin, you must create a reference data set.
1Click New and select Code List.
The New Code List page appears and displays the Summary tab.
2Select a reference data set to associate with this code list.
3In the Name field, enter a name.
4Optionally, complete the general properties fields.
Note: Code lists inherit the domain, confidentiality, and priority from the reference data set.
Field
Description
Version
The version information of the code list.
Description
A description of the code list. The description cannot exceed 4000 characters.
Additional Description
Additional description of the code list. You can add additional details of a code list in the Additional Description field.
Application
The source application of the code values.
Domain
An area or grouping to describe the code values.
Confidentiality
The confidentiality level of the code list inherited from the reference data set. The confidentiality levels are confidential, internal, restricted, and public.
Priority
The priority of the asset. The priority levels are critical, high, medium, and low.
Note: The Summary tab of the code lists displays only the Reference Data Set, Name, and Description fields for users with a Reference Data Management Basic Edition license.
5In the External URLs section, click Add External URL.
A blank row appears.
6To add an external URL, enter a URL name and a link of an external page for an externally mandated code list.
The added external URL appears in the row. You can enter up to 4,000 characters for external URL names and links.
7To remove an external URL, hover over a row, and click Delete External URL.
8To notify external stakeholders about changes to the code list, click Add Notification Recipient in the Notification Recipients section.
Note: Ensure that you define a process in Cloud Application Integration to trigger notifications to external stakeholders in Reference 360. For more information about designing processes in Cloud Application Integration, see Designing Processes.
A blank row appears.
9To add a notification recipient, enter a name, contact type, such as email or SMS text message, and the respective contact detail.
The added notification recipient appears in the row. You can enter up to 4,000 characters for notification recipient names and contact details.
10To remove a notification recipient, hover over a row, and click Delete Notification Recipient.
Step 2. Define the structure, attributes, and display settings of code lists
Define the structure, attributes, and display settings of the code list. Code lists inherit their structure and attributes from the reference data set.
Important: After you create the code list, some actions are restricted to prevent issues with the definition of the code list, such as modifying the structure. For more information, see Code lists.
1Click Definition.
The Definition tab opens.
2If the code list didn't inherit a structure from the reference data set, configure the structure definition.
Option
Description
Hierarchical
A hierarchical code list allows you to arrange code values into levels to create hierarchies.
The following video shows you how to create a hierarchical code list:
3Optionally, to configure business IDs for code values in the code list, select Enable Business ID and specify the business ID properties.
The following table describes the business ID properties:
Property
Description
Display Name of Business ID
Name of the field that displays business IDs. Default is Business ID.
Format
Required. The format in which you want the business IDs to be generated.
Select one of the following formats:
- Alphanumeric. Use 10 to 24 characters, starting with a prefix that consists of three characters. The prefix can contain uppercase letters and numbers. For example, RDM4AB78W2.
- Numeric. Use 10 to 24 numbers including a prefix of three digits. For example, 9994567123. You can enter an offset value. The business ID of code values created by Reference 360 starts at the offset value, excluding the prefix. For example, with a length of 10, an offset value of 1000, and a prefix of 999, the starting business ID is 9990001000.
Length (including prefix)
Required. Total length of the business IDs.
Prefix
Required. Characters added to the beginning of business IDs.
Offset
Starting value for business IDs that Reference 360 generates. Applicable for numeric business IDs.
4Optionally, configure a custom attribute for the code list.
aClick Add.
An attribute row appears in the Attributes section. In the New Attribute panel, you can configure the details of the attribute.
bIn the Attribute Name field, enter a name.
Note: Ensure that you don't use the display name of the business ID that you define or the reserved keyword Business ID in the attribute name.
Reference 360 generates internal field names for the attributes based on the attribute names and displays them in the export file when you export code values.
The following table describes the attribute names and their corresponding internal names:
Attribute name
Internal field name
Contains only alphanumeric characters
Same as the attribute name.
Contains alphanumeric characters with a space or special characters
Alphanumeric characters of the attribute name are appended with values starting from 1.
Contains only special characters
field1.
Note: If a code list contains any existing attribute as field1, the internal field name appears as field11.
cFrom the Type list, select the data type of the attribute.
Note: You can define a scale for the Decimal data type attributes. The supported scale value ranges from 1 to 34. Default is 4. The default precision is 34. Ensure that the scale value that you define is less than the default precision.
dSet a default value for the attribute.
When you add a code value to the code list, the field displays the default value. If you add new rule associations or modify the existing rule associations for the attribute, Reference 360 clears the default value. You can set default value based on the configured rule association.
eTo make the attribute required, select Required.
fTo add a validation rule for a string, integer, or decimal attribute type, click Add Rule and configure a validation rule.
The following table lists the validation rules that you can configure for each attribute type:
Attribute Type
Rules
String
- Allowed Characters
- Not Allowed Characters
- Concatenate
- Contains
- Does Not Contain
- Minimum Length
- Maximum Length
- Starts with
- Ends with
Note: For attributes with a concatenate rule, you can update the values that are used in the concatenated attribute value. However, if you configure a concatenate rule for the Code attribute, you cannot update the values in the concatenated attribute value.
Decimal
- Minimum Value
- Maximum Value
- Maximum Scale
- Maximum Precision
Integer
- Minimum Value
- Maximum Value
Date
- Start Date
- End Date
- Date Range
You can set a new attribute or an existing attribute as required for an existing code list. You can't set the Name and Code attributes as optional as they are required by default.
When you set a new attribute or modify the existing attribute as required, a warning message appears.
Note: Users with a Reference Data Management Basic Edition license cannot edit the existing attributes, add new attributes, or add rules to the attributes of the code list.
5Optionally, in the Display Settings section, select the attribute that you want to appear in Reference 360 to represent code values in the code list.
Step 3. Assign stakeholders
Assign stakeholder roles to users who play a role in using, creating, or maintaining the asset. Stakeholder roles determine a user's privileges for the asset.
When a user manages an asset as a stakeholder, they have the combined privileges provided by their stakeholder role and their Reference 360 role. For more information about stakeholder roles, see Stakeholder roles. For more information about assigning roles, see Guidelines for assigning roles.
The following video shows you how to assign stakeholders:
1Click Stakeholders.
The Stakeholder tab opens.
2Click Add.
A list appears in an empty row.
3In the Role list, select a stakeholder role.
The New Stakeholder dialog box appears.
4Select a user name and click Add.
The user name of the stakeholder appears in the row.