See Also
Custom Field Descriptions allow specification of custom floating point, integer, and string fields with user-defined column headers and field names. These fields can be added to case information displays for all power system case data and many supporting data types. Custom fields are currently not available for use with case information displays listing display objects. By default, there are five custom fields of each type available, but any number of each type of field can be defined for each type of data. In addition the default number of fields to have for all objects can also be changed.
To view the Custom Field Descriptions, open Custom Field Descriptions found under the Case Information and Auxiliary folder on the Model Explorer. The table lists the object types for which custom fields have been defined, how many of each type of field has been defined, and any custom field captions and headers for the fields. By default, there will be three entries; there are two fields each for floating point, integer, and string fields for all data types. These defaults will be used unless specific custom fields are defined for a particular data type.
To insert a new description, select Records > Insert from the case information toolbar. To modify an existing description, choose Show Dialog from the case information toolbar. Performing either of these actions will open the Custom Field Description dialog. To remove and existing description, choose Records > Delete. Default descriptions cannot be removed.
The following fields are used for defining the custom field descriptions:
Object Type
Type of object for which the field is available. The Default type will be used for any data type that does not have its own definition. This field can only be set using the Custom Field Description dialog and cannot be changed once a description has been created.
Field Type
The three options for this field are Floating Point, Integer, and String. This is the type of value that will be used in the custom field. This field can only be set on the Custom Field Description dialog when inserting a new custom field description.
Number of Type
This value determines how many fields of the particular Field Type will be available.
Captions for Field (comma-separated)
Specify the caption to use for each field. These captions will appear in lists of fields for objects such as the list of available fields used with Display/Column options. Enter the captions as a comma-separated list. Leave an empty entry to not assign a particular caption. If a caption is not defined for a particular field, the default will be used. For example, if the Field Type is Integer and there are two fields defined, the Field Captions will be Integer 1 and Integer 2.
If captions are not defined for the fields and Captions for Headers are defined, the header captions will be used instead of the defaults.
Captions for Header (comma-separated)
Specify the caption to use for each field column header. These headers appear in the case information displays for the particular object type. Enter the captions as a comma-separated list. Leave an empty entry to not assign a particular caption. If a header caption is not defined for a particular field, the default will be used. For example, if the Field Type is Integer and there are two fields defined, the Header Captions will be Cust Int 1 and Cust Int 2.
If captions are not defined for the headers and Captions for Field are defined, the field captions will be used instead of the defaults.
Include in Difference (comma-separated)Added in Version 22
Specify YES/NO as whether to include this particular custom field (for the chosen object type) when in Difference or Change mode. These headers appear in the case information displays for the particular object type. Enter this as a comma-separated list. Leave an blank value to assign it as YES. Also, values not assigned will be internally interpreted as YES.
Only fields assigned as NO will be not included while in Difference or Change mode, and their present value will be displayed. Otherwise fields will be included, and a difference or change value will be shown.
Auxiliary File Script commands
There are two Auxiliary File Script commands that can be used to edit the Custom Field descriptions for a particular ObjectType/FieldType/Location
CustomFieldDescriptionModify(ObjectType, CustomType, Location, FieldString, HeaderString, IncludeInDiff);
CustomFieldDescriptionAppend(ObjectType, CustomType, FieldString, HeaderString, IncludeInDiff);
For more help on these see Auxiliary File Format Description document