Name | Type | Cardinality | Label | Required | Help |
defaultSelection |
RecordRef |
0..1 |
|
|
To create a static default for the segment, use this dropdown list to select the default value. The static default is overwritten if a dynamic default is generated. (Dynamic defaults are configured by using the Source List dropdown list on the Application & Sourcing subtab.) |
description |
string |
0..1 |
|
|
If appropriate, enter notes about the segment. The description is visible only on this page, for people who have permission to view or edit the segment. |
fieldType |
CustomizationFieldType |
0..1 |
|
|
This choice determines whether a user setting a value for the segment on a record can save multiple selections, as follows:
* List/Record - The user can save only one selection.
* Multiple Select - The user can save multiple selections.
Be aware that the following limitations exist when a segment has a type of Multiple Select:
* The segment cannot have GL Impact.
* The segment cannot be applied to transaction columns.
* You cannot configure dynamic defaulting for the segment. |
filteredByList |
RecordRefList |
0..1 |
|
|
|
hasGLImpact |
boolean |
0..1 |
|
|
When you enable GL Impact, segment values that are saved on transaction instances are displayed on the GL Impact page for those transactions. Custom segments applied to transaction types or columns can have GL impact.
You can check the GL Impact box even when the segment is not applied to transaction types or columns. However, until you apply the segment to a transaction type or column, this setting has no effect.
After a segment has been created, the GL Impact setting cannot be modified. |
help |
string |
0..1 |
|
|
Enter field-level help for the segment. Users working with the segment can click the segment’s label to display a popup window containing your help text. |
isInactive |
boolean |
0..1 |
Inactive |
F |
If a custom segment is no longer needed, inactivate it by checking this box. If the custom segment is used for criteria in duplicate detection, you cannot clear the inactive box. |
isMandatory |
boolean |
0..1 |
|
|
Check this box to make the segment a required field on records where it appears. This option affects all record types to which the segment has been applied.
Be aware that even with this configuration, the segment is not necessarily mandatory in all situations. For more information, see Making a Custom Segment Mandatory in the Help Center. |
label |
string |
0..1 |
|
|
This text is used as the segment’s label when the segment appears on a record as a field or transaction column. The label must be unique across all classifications in your system. For example, if you have classifications called Class, Department, Location, or Subsidiary, you cannot use any of those words as this segment's label. You also cannot name a segment Account, and you cannot duplicate an existing segment’s label. |
recordScriptId |
string |
0..1 |
|
|
This is the identification number for the custom record that is associated with the custom segment. Every custom segment has a custom record. This ID is the custom segment type and is important for web services. You would use the record ID with the internal ID to reference this custom segment in a script. |
recordType |
RecordRef |
0..1 |
Record Type |
F |
The custom record type that is linked to this custom segment. The custom record type has the same name as the custom segment. The custom record type name is a link that opens the Custom Record configuration page. |
scriptId |
string |
0..1 |
ID |
F |
You use the ID value when scripting to instances of the custom segment. As a best practice, enter a name that begins with an underscore. The text you enter is prepended with the string cseg. If you do not enter a value, the system generates one.
This field has a 15-character limit.
This value cannot be changed after the new segment is saved. This ID is used in the API for the custom GL plug-in. |
showInList |
boolean |
0..1 |
|
|
Check this box to display the custom segment column on a custom record list or sublist. Clear this box to remove the custom segment column from the custom record list or sublist. |