{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":39876,"path":"platform-administration/table-administration-and-data-management/c_DictionaryAttributes.md","title":"Altering tables and fields using dictionary attributes","bundle":null,"doc_type":null,"release":"australia","body":"\n# Altering tables and fields using dictionary attributes\n\nDictionary attributes alter the behavior of the table or field that the dictionary record describes. Administrators can add or modify dictionary attributes.\n\n## Adding an attribute\n\nTo add or remove an attribute to a table or field, open a dictionary record, select the **Advanced** link, and modify the **Attributes** field. Alternatively, in a dictionary record, select **New** in the Attributes related list. For details on modifying dictionary entries, see [Modify dictionary entries](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/table-administration-and-data-management/t_ModifyADictionaryEntryFromAForm.md).\n\nAttributes are comma-separated. If attributes exist on a dictionary record, add a comma with no spaces before adding an attribute.\n\nFor an attribute that accepts true/false values:\n\n- To specify a value of true, you can either enter `attribute` or `attribute=true`.\n- To specify a value of false, you can either ensure that the attribute does not appear or enter `attribute=false`. To maintain the values during upgrades, do not remove an attribute that is on a table by default.\n\n## Maintaining attribute values for upgrades\n\nIf you remove an attribute that is part of the base system, it is automatically restored during an upgrade. To prevent upgrades from changing the behavior of your system, leave the attribute on the table or field, but set its value as desired.\n\nFor example, if a field has the attribute `knowledge_search=true` by default, do not remove the attribute to set it to false; rather set it to `knowledge_search=false`.\n\n## Available dictionary attributes\n\n\n
\n\nName\n\n\n\nValue\n\n\n\nTarget Element\n\n\n\nDescription\n\n
\n\nallow\\_null\n\n\n\ntrue/false\n\n\n\nfield\\_name field\n\n\n\nIf present or true, enables you to enter `None` as the field\n\n
\n\nallow\\_public\n\n\n\ntrue/false\n\n\n\ntable\\_name field\n\n\n\nIf true, the table name field displays tables from all scopes instead of only the current scope.\n\n
\n\nallow\\_references\n\n\n\ntrue/false\n\n\n\nfield\\_name field\n\n\n\nIf true, a tree is displayed to select from that includes reference fields so you can dot-walk.\n\n
\n\nallowHugeAlter\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf true, enables you to add a column to a table with more than 100 million rows.\n\n
\n\napproval\\_user\n\n\n\nname of field containing the users for the approval type this field represents\n\n\n\ninteger field\n\n\n\nSpecifies the table fields that are used to perform lookups using a matcher. You specify approvals as table fields that have an attribute of **approval\\_user=<field\\_name>**, where <field\\_name> indicates the field in the table that contains the users for this approval type. - Fields with this attribute contain an integer value that indicates the sequence for the approvals.\n- All approval fields with the same sequence number indicate that multiple approvals are required before continuing.\n- Approvals are requested in the order of the sequence numbers. For example, all approvals with sequence number 100 must be approved before approvals with sequence number 200 are requested.\n\n
\n\nattachment\\_index\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf true, attachments on the table are indexed for search purposes. To learn more, see [Index attachments on a table](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/t_DisablingAttachmentsOnATable.md).\n\n
\n\nbarcode\n\n\n\ntrue/false\n\n\n\nstring field\n\n\n\nEnables a string field to access a camera on a mobile device to scan and process a bar code.\n\n
\n\nbase\\_table\n\n\n\nname of base table type\n\n\n\ntable\\_name field\n\n\n\nSpecifies the table\\_name field that enables you to select any table that is derived from the table specified by this attribute. By default, the base table itself is also included in the list \\(but see **skip\\_root** to turn off this behavior\\).\n\n
\n\ncalendar\\_elements\n\n\n\nlist of field names, separated by semicolons \\(\";\"\\)\n\n\n\nany calendar event table\n\n\n\nSpecifies the list of fields used when constructing the description of a calendar event. If not specified, the display name plus short description are used. The **calendar\\_elements** attribute does not support derived \\(dot-walked\\) fields.\n\n
\n\ncollection\\_interval\n\n\n\ninterval specified as \"HH:MM:SS\" \\(like \"01:02:30\" for one hour, two minutes, and 30 seconds\\)\n\n\n\ncollection field\n\n\n\nSpecifies the interval of metrics collection.\n\n
\n\nclose\\_states\n\n\n\ninactive state integer values\n\n\n\ntask state field\n\n\n\nUsed by the TaskStateUtil API to identify the list of inactive state values delimited by semicolons \\(;\\)\n\n
\n\ncritical\n\n\n\ntrue/false\n\n\n\nany field in the apm\\_application table\n\n\n\nDefines fields that have critical information about an application, which enables tracking the entry of critical information.\n\n
\n\ncurrent\\_location\n\n\n\ntrue/false\n\n\n\nstring field\n\n\n\nEnables a string field to access the GPS location of a mobile device.\n\n
\n\ndisable\\_execute\\_now\n\n\n\ntrue/false\n\n\n\nany table derived from sys\\_auto\n\n\n\nIf present or true, disables the usual **Execute Now** button. The ServiceNow AI Platform applications that use schedules, such as Discovery, use this attribute to substitute their own more appropriate action.\n\n
\n\ndefault\\_rows\n\n\n\ninteger value\n\n\n\nmultitext fields\n\n\n\nSets the default number of rows in a multitext field.\n\n
\n\ndefault\\_close\\_state\n\n\n\nstate integer value\n\n\n\ntask state field\n\n\n\nUsed by the TaskStateUtil API to identify the default close state value for a task table.\n\n
\n\ndefault\\_work\\_state\n\n\n\nstate integer value\n\n\n\ntask state field\n\n\n\nUsed by the TaskStateUtil API to identify the default working state value for a task table.\n\n
\n\ndetail\\_row\n\n\n\nname of field to display in detail row\n\n\n\nany table\n\n\n\nDisplays the value of the specified field as a [Lists](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-user-interface/c_UseLists.md) for each record in the list view. UI15 is required to use this attribute.**Note:** If different **detail\\_row** attributes are defined for a parent table and a child table, the system uses the child table attribute.\n\n
\n\ndisplay\\_image\n\n\n\ntrue/false\n\n\n\ntable with fields of the user\\_image type\n\n\n\nIf present or true, displays records of the user\\_image type in an image form. If the record is in the \\[sys\\_user\\] table, and the image is not available, the user initials are displayed.\n\n
\n\ndocument\\_viewer\\_audit\n\n\n\nview, download, or all\n\n\n\nany table\n\n\n\nWhen the Document Viewer is enabled, this attribute keeps a record of the user actions that are performed on attachments. The values are as follows:- **view**: Enables an audit when users view an attachment\n- **download**: Supplies audit information for only downloaded attachments\n- **all**: Shows audit information when attachments are viewed and downloaded\n\n
\n\nemail\\_client\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, causes an icon \\(an envelope\\) to appear in the more options menu in the form header. If you click it, a pop-up email client appears.\n\n
\n\nenforce\\_dot\\_walk\\_cross\\_scope\\_access\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nThis attribute enforces dot-walk cross-scope access restrictions for individual tables. The attribute must be added to the dictionary record for the table \\(the record in sys\\_dictionary with Type = “Collection” for the specific table\\).- To enable enforcement, add **enforce\\_dot\\_walk\\_cross\\_scope\\_access** or **enforce\\_dot\\_walk\\_cross\\_scope\\_access=true**.\n- To turn off enforcement, add **enforce\\_dot\\_walk\\_cross\\_scope\\_access=false**.\n\n
\n\nexclude\\_auto\\_recovery\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nDisables automatic recovery of draft records for this table and its extensions.\n\n
\n\nexclude\\_from\\_rollback\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nExcludes this table \\(and any of its descendant tables\\) from being recorded for rollback. For example, use this attribute to preserve records that are created from an automated test. For tables excluded by default, see [Tables excluded from rollback after running an automated test](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/application-development/atf-excluded-from-rollback.md).\n\n
\n\nextensions\\_only\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nSpecifies that the table should only have records in tables that extend it. For example, the Task table has this attribute because you would create incident, problem, change records, and not task records.\n\n
\n\nfield\\_list\\_selector\n\n\n\ntrue/false\n\n\n\nany glide\\_list\n\n\n\nEnables the user to select a field from the dependent table \\(or current if the dependent is not specified\\). Some workflow activities use this attribute.\n\n
\n\nfield\\_decorations\n\n\n\nUI Macro name list, separated by semicolons \\(\";\"\\)\n\n\n\nmost fields \\(except list and multiline text fields\\)\n\n\n\nSimilar to **ref\\_contributions**, causes the named UI macro to be invoked when the field is rendered on a form.\n\n
\n\nformat\n\n\n\nformat name\n\n\n\nany numeric field\n\n\n\nSpecifies a named format to use instead of the standard numeric formatting. Options are as follows: - **glide\\_duration**: Formats a time specified in milliseconds as **ddd hh:mm:ss**.\n- **none**: Disables automatic number formatting \\(for example, changes 2,500–2500\\).\n\n**Note:** This attribute applies only to display values and not user input values.\n\n
\n\nglide.db.oracle.ps.query\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present and false, prevents the use of Oracle prepared queries on the table.\n\n
\n\nglobal\\_visibility\n\n\n\ntrue/false\n\n\n\nany table with a sys\\_domain column\n\n\n\nIf present or true, makes this table visible globally even if there are domain restrictions \\(that is, the sys\\_domain field has a value\\).\n\n
\n\nhasLabels\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, marks this table as being the target of a label at some point. You can manually set this attribute, but it is normally set automatically whenever a label is generated. When true, the label engine runs on any change to the table, and updates the labels as needed.\n\n
\n\nhasListeners\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, marks this table as available for listeners to get events \\(insert, update, delete\\).\n\n
\n\nhasWorkflow\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nInstructs the workflow engine to listen for changes to the table and fires events to a workflow when a record associated with a particular workflow has changed.\n\n
\n\nhide\\_email\\_icon\n\n\n\ntrue/false\n\n\n\nemail field\n\n\n\nIf true, the default email icon does not display. The default value is false.\n\n
\n\nhtml\\_sanitize\n\n\n\ntrue/false\n\n\n\nany HTML or translated HTML field\n\n\n\nIf present or true, enables HTML sanitization for the selected HTML or Translated HTML field. By default, performs HTML Sanitization on all HTML and Translated HTML fields. Set this attribute to false to disable sanitization.\n\n
\n\nhtml\\_sanitize\\_config\n\n\n\nname of custom sanitizer configuration file\n\n\n\nany HTML or translated HTML field\n\n\n\nIf present, performs sanitization using the specified configuration file instead of the default platform sanitizer. For example, the Embedded Help \\[sys\\_embedded\\_help\\_content\\] table uses a specified file \\(EmbeddedHelpSanitizerConfig\\) for the help **Content** field.\n\n
\n\ni18n\\_locale\\_text\\_match\n\n\n\ntrue/false\n\n\n\nany string field\n\n\n\nIf true, enables case and accent \\(diacritic\\) sensitivity for text search of the column. If false, text search of the column is case and accent insensitive. The default behavior is false. This attribute can't be set to true when i18n\\_session\\_language\\_sortable is true on the same column. To learn more see [Set case and accent sensitivity on a per-column basis](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/system-localization/sl-locale-text-match.md).\n\n
\n\ni18n\\_session\\_language\\_sortable\n\n\n\ntrue/false\n\n\n\nany string field\n\n\n\nIf true, enables sorting the column by the user's session language. If false, sorting by the user's session language is disabled and the column is sorted according to the English alphabet. This attribute can't be set to true when i18n\\_locale\\_text\\_match is true on the same column. To learn more see [Sorting according to the session language](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/system-localization/sorting-session-language.md)\n\n
\n\nicons\n\n\n\nname of JavaScript class\n\n\n\nany workflow field\n\n\n\nSpecifies a JavaScript class that produces workflow icons.\n\n
\n\nignore\\_filter\\_on\\_new\n\n\n\ntrue/false\n\n\n\nany field\n\n\n\nIf true, prevents the fields on a form from populating with values from a filtered list.\n\n
\n\nimage\n\n\n\nrelative path of image file\n\n\n\nany table\n\n\n\nSpecifies an image file to use when a module or BSM map uses this table. This specification overrides the icons that would otherwise be used for the table.\n\n
\n\ninclude\\_container\\_types\n\n\n\ntrue/false\n\n\n\nany internal\\_type field\n\n\n\nCauses the field to render with container \\(split\\) types as well other types.\n\n
\n\nip\\_data\\_control\n\n\n\n- none\n- canonical\n- expanded\n- canonicalize\\_when\\_possible \\(default value\\)\n\n\n\nfield type on any table\n\n\n\nChecks whether the data should be normalized through the **ip\\_data\\_control** attribute. - If the attribute is none, no conversion happens and data is inserted as-is.\n- If the attribute is canonical, values are inserted in their smaller canonical form.\n- If the attribute is expanded, values are inserted in the larger expanded form to facilitate comparisons.\n- If the attribute is canonicalize\\_when\\_possible, values are inserted in canonical form when it is a valid IP or as-is when it is not.\n\n
\n\nisOrder\n\n\n\ntrue/false\n\n\n\nany field\n\n\n\nSets the field as the default field that is used for the sort order in lists. Overridden by the **ORDERBY** URL parameter, or the user's sort preferences.\n\n
\n\niterativeDelete\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, forces all row deletes to execute iteratively. Otherwise, you can perform some deletes using a more efficient bulk method.\n\n
\n\njson\\_view\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nif a JSON object is associated with the field, places an icon next to a field that, when you click it, displays the data interchange information.\n\n
\n\nknowledge\\_custom\n\n\n\nname of JavaScript function\n\n\n\nany field\n\n\n\nSpecifies a JavaScript function to implement a custom knowledge search \\(see **knowledge\\_search**\\).\n\n
\n\nknowledge\\_search\n\n\n\ntrue/false\n\n\n\nstring fields\n\n\n\nIf present or true, causes a knowledge search icon \\(a small book\\) to appear next to the field. Clicking this icon launches a pop-up window for searching the knowledge base, unless a custom knowledge search function has been specified. To learn more, see **knowledge\\_custom**.\n\n
\n\nlargeTable\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, marks this table as \"large\" to preventing table locking with specific MySQL database operations \\(adding/removing a column/index, compacting a table\\). Without this attribute \\(or the **smallTable** attribute\\), the **glide.db.large.threshold** property, or the default value of **5,000**, determines whether a table is large.\n\n
\n\nlisten\n\n\n\ntrue/false\n\n\n\nany field\n\n\n\nIf present or true, calls a JavaScript function named <tableName>\\_<fieldName>Listen, or globalListen if that function does not exist. It calls the function with arguments \\(tableName, fieldName, oldValue, newValue\\).\n\n
\n\nlive\\_feed\n\n\n\ntrue/false\n\n\n\nany field\n\n\n\nIf present or true, creates a toggle option on the activity formatter header for incidents, tasks, and problems. The toggle provides a choice between the **Live Feed** for that record \\(also known as a document feed\\) or the activity formatter fields already in use. To learn more, see [Activity formatter](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/c_ActivityFormatter.md) for more details.\n\n
\n\nlong\\_label\n\n\n\ntrue/false\n\n\n\nany reference field\n\n\n\nLong or short labels refer to the label that appears for reference fields on a form. For example, if the reference field contains the caller’s email address, the long label would be Caller Email, while the short label would be Email.\n\n- Usually the placement of the reference field on the form makes it clear what the field represents.\n- It uses the global property \\(**glide.short.labels**\\) to specify the type of labels that appear for all reference fields on any form.\n- You can override the global property for any reference field by setting the **short\\_label=true** or **long\\_label=true** attribute in the dictionary for the reference field.\n\n
\n\nmaintain\\_order\n\n\n\ntrue/false\n\n\n\nany glide\\_list\n\n\n\nIf present or true, the up/down arrow order buttons appear to the right of the list of selected items.**Note:** You need to use the **Add multiple** button to see the order buttons.\n\n
\n\nmode\\_toggler\n\n\n\ntrue/false\n\n\n\nany composite\\_name field\n\n\n\nIf present or true, causes a name mode toggle icon \\(a small right-pointing triangle\\) to appear to the right of the label. Clicking this icon causes the field's rendering to change from a text field that accepts <tablename>.<fieldname> to a pair of reference choice boxes \\(one for the table, the other for the field\\). The latter is the default.\n\n
\n\nmodel\\_class\n\n\n\nbinary Java class name\n\n\n\nany field of type glide\\_var\n\n\n\nSpecifies a model variable within the Java code. The model must have a class that implements the IVariablesModel interface.\n\n
\n\nmodel\\_field\n\n\n\nsee description\n\n\n\nany field of type glide\\_var\n\n\n\nIdentifies a reference field in the record that has the model defined for it. For example, a workflow activity is associated with an activity definition. The activity definition has a related list of questions that make up the model for that activity definition. By using the activity\\_definition as the model\\_field for the activity, it builds the workflow activity model by reading the questions that are defined for the referenced activity definition.\n\n
\n\nnibble\\_size\n\n\n\npositive integer\n\n\n\nany table affected by the table cleaner\n\n\n\nSpecifies the maximum number of records that the table cleaner can delete in a single operation. The default value for this attribute is **250**.\n\n
\n\nnibble\\_sleep\n\n\n\ntrue/false\n\n\n\nany table affected by the table cleaner\n\n\n\nIf false, causes the table cleaner to perform cleanup operations without a pause between each operation.\n\n
\n\nno\\_add\\_me\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, hides the display of the Add Me icon that appears next to certain fields, such as the **Watch List** field.\n\n
\n\nno\\_attachment\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, prevents the attachment icon \\(a paperclip\\) from appearing on the form header.\n\n
\n\nno\\_attachments\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, attachments are not checked for and deleted when a record from this table is deleted. Meant for high-activity tables that never have attachments.\n\n
\n\nno\\_audit\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present, this field is not audited, even if the table is being audited. The true or false value is ignored.\n\n
\n\nno\\_audit\\_delete\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, a sys\\_audit\\_delete record is never created when you delete a record from this table. Meant for high-activity tables that never need sys\\_audit\\_delete information.\n\n
\n\nno\\_auto\\_map\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf true, this field is not mapped during an import set. Primarily used for LDAP imports.\n\n
\n\nno\\_email\n\n\n\ntrue/false\n\n\n\nany glide\\_list field referencing sys\\_user\n\n\n\nIf present or true, the email box is removed from the glide\\_list field like the **Watch list** field.\n\n
\n\nno\\_multiple\n\n\n\ntrue/false\n\n\n\nany glide\\_list field\n\n\n\nHides the select multiple icons.\n\n
\n\nno\\_optimize\n\n\n\ntrue/false\n\n\n\nany table affected by the table cleaner.\n\n\n\nIf present or true, prevents the MySQL table compaction operation from running on the specified table. The table compaction operation typically runs after the table cleaner deletes at least 50 percent of the data in the specified table.\n\n
\n\nno\\_separation\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, marks this table as not participating in domain separation. To learn more, see [Domain separation for service providers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/domain-sep-landing-page.md).\n\n
\n\nno\\_text\\_index\n\n\n\ntrue/false\n\n\n\nany field on a text indexed table, or any child table of a text indexed table\n\n\n\nIf a table is text indexed, the **no\\_text\\_index** field attribute prevents this field or child table from being included in the text index.\n\n
\n\nno\\_truncate\n\n\n\ntrue/false\n\n\n\nany string field\n\n\n\nIn a list view, shows the entire text value of the multitext value in a list, without truncating it. Without this attribute, the string is truncated based on the UI property **Number of characters displayed in list cells** which is **40** by default.\n\n
\n\nno\\_update\n\n\n\ntrue/false\n\n\n\ntable\n\n\n\nTrue for tables in which records are inserted or deleted but not updated. Prevents the system from creating sys\\_mod\\_count, sys\\_updated\\_by, sys\\_updated\\_on fields in the table when created. Does not stop updates of the table. This attribute setting is used to save space on high volume system tables, such as syslog and sys\\_audit.\n\n
\n\nno\\_view\n\n\n\ntrue/false\n\n\n\nany glide\\_list field\n\n\n\nHides the view-selected item icon.\n\n
\n\nomit\\_sys\\_original\n\n\n\ntrue/false\n\n\n\nprice and currency type fields\n\n\n\nWhen true, avoids retrieving the original value of a field during calculations. Omitting the sys\\_original value from being referenced during calculations can reduce performance issues when dealing with currencies or prices.\n\n
\n\nonlineAlter\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nTables with the **onlineAlter** attribute perform MySQL database operations using online schema changes. - Online schema changes provide a lock-free table upgrade when adding, modifying, or removing columns and when adding or dropping indexes. Without online schema changes, these changes to the database lock write access during execution.\n- Online schema changes use additional system resources. Oracle databases do not lock tables by default and do not use online schema changes.\n\n
\n\norder\n\n\n\nnumeric value\n\n\n\nmodel variable fields\n\n\n\nUsed internally only \\(for model variables\\).\n\n
\n\npop-up\\_processor\n\n\n\nbinary Java class name\n\n\n\nany field or table\n\n\n\nSpecifies a custom pop-up processor for processing the field \\(or all fields in a table\\).\n\n
\n\nreadable\n\n\n\ntrue/false\n\n\n\nany conditions field\n\n\n\nWhen true, causes rendering of the conditions field in any list view as a human-readable condition \\(instead of the encoded query that is stored in the database\\).\n\n
\n\nref\\_ac\\_columns\n\n\n\nlist of field names separated by semi-colons\n\n\n\nany reference field with an auto completer \\(see ref\\_auto\\_completer\\)\n\n\n\nSpecifies the columns whose display values should appear in an auto completion list, in addition to the name. To learn more, see the cmdb\\_ci field \\(**Configuration Item**\\) on the Incident form for a working example.\n\n
\n\nref\\_ac\\_columns\\_search\n\n\n\ntrue/false\n\n\n\nany reference field with an auto completer \\(see ref\\_auto\\_completer\\)\n\n\n\nCauses auto-complete to work with all fields that are specified in the **ref\\_ac\\_columns** attribute. This attribute overrides the default behavior, which searches only the display value column. To learn more, see [Configure auto-complete to match text from any reference field](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/c_AutoCompleteForReferenceFields.md).\n\n
\n\nref\\_ac\\_display\\_value\n\n\n\ntrue/false\n\n\n\nany reference field with an auto completer \\(see ref\\_auto\\_completer\\)\n\n\n\nCauses the reference field to hide the display value column so that the auto-complete function only matches the text from the columns that are listed in the **ref\\_ac\\_columns** attribute. This feature requires the use of the AJAXTableCompleter class and the **ref\\_ac\\_columns**, **ref\\_ac\\_columns\\_search**, and **ref\\_ac\\_display\\_value** attributes. To learn more, see [Remove the display value column](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/c_AutoCompleteForReferenceFields.md).\n\n**Note:** The ref\\_ac\\_display\\_value function does not work with Catalog Item variables.\n\n
\n\nref\\_ac\\_order\\_by\n\n\n\nfield name\n\n\n\nany reference field with an auto completer \\(see ref\\_auto\\_completer\\)\n\n\n\nSpecifies the column that is used to order the auto completion list.\n\n
\n\nref\\_auto\\_completer\n\n\n\nJavaScript class name\n\n\n\nany reference field \\(can be applied to a table to affect all reference fields on the table.\\)\n\n\n\nSpecifies the name of a JavaScript class \\(client side\\) that creates the list auto completion choices. Valid class values include: - AJAXReferenceCompleter: Matching auto-complete choices appear as a list. Only the [Display values](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/c_DisplayValues.md) column of the reference table appears. If there is no other auto-completion class specified, reference fields automatically use this class.\n- AJAXTableCompleter: Matching auto-complete choices appear as rows in a table. The display value column of the reference table appears, with any columns listed in the **ref\\_ac\\_columns** attribute.\n- AJAXReferenceChoice: Displays matching auto-complete choices as a list. Only the display value column of the reference table, and up to 25 matching choices, appear. If there are more than 25 auto-complete choices, the choices for the AJAXTableCompleter class appear for the reference field instead.\n\n For more information, see [Auto-complete for reference fields](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/c_AutoCompleteForReferenceFields.md).\n\n
\n\nref\\_contributions\n\n\n\nUI Macro name list, separated by semicolons \\(\";\"\\)\n\n\n\nany reference field\n\n\n\nWhen the field renders on a form, it invokes the named UI macro.\n\n
\n\nref\\_decoration\\_disabled\n\n\n\ntrue/false\n\n\n\nany reference field\n\n\n\nWhen set to `true`, disables the display of the reference icon on a selected field.\n\n
\n\nref\\_list\\_label\n\n\n\nlabel text\n\n\n\nany table\n\n\n\nSpecifies the title to use in a list banner.\n\n
\n\nref\\_qual\\_elements\n\n\n\nfield name list, separated by semicolons \\(\";\"\\)\n\n\n\nany reference field with a reference\\_qual field\n\n\n\nSpecifies a list of fields to send back to the server to get an updated reference.\n\n
\n\nref\\_sequence\n\n\n\nlist of fields in referenced table, separated by top hats \\(\"^\"\\)\n\n\n\nany reference field\n\n\n\nSpecifies the fields in the referenced table that are used to order the list. This attribute works like an ORDER BY clause in SQL, with each element in ascending order.\n\n
\n\nreference\\_types\n\n\n\nlist of valid reference types that are clickable separated by semicolons \\(\";\"\\)\n\n\n\nfield\\_name field\n\n\n\nLimits the reference fields that appear in the tree to the specified types.\n\n
\n\nremoteDependent\n\n\n\nname of database and table \\(like \"model.matcher\"\\)\n\n\n\nany script field\n\n\n\nDefines the remote \\(such as in another database\\) table that the script depends on.\n\n
\n\nrepeat\\_type\\_field\n\n\n\nfield name\n\n\n\na repeat count field for schedule rotation\n\n\n\nSpecifies the field that contains the repeat type \\(daily, weekly, monthly, or yearly\\).\n\n
\n\nro\\_collapsible\n\n\n\ntrue/false\n\n\n\nany multiline field\n\n\n\nIf present or true, causes an icon \\(either a \"+\" or a \"-\"\\) to appear next to the field label, allowing the field itself to be expanded or collapsed.\n\n
\n\nsaver\\_exempt\n\n\n\n- exempt\\_always= field will be skipped from writing to xml for all install contexts.\n- exempt\\_never= field will not be skipped from writing to xml \\(Default\\).\n- exempt\\_vcs\\_only= field will be skipped from writing to xml only in source control context.\n\n\n\nFields of metadata records\n\n\n\nWhen present, determines if the field is written to the xml representation of the record. An absence of the attribute is equivalent to exempt\\_never. When exempt\\_always, the field is skipped from writing to xml when exporting \\(publish, commit to source control, update set\\). When exempt\\_vcs\\_only, the field is skipped from writing to xml only in the source control context.\n\n
\n\nscale\n\n\n\ninteger\n\n\n\ndecimal field\n\n\n\nSets the number of decimal places to use on a Decimal field type. The default is 2. This attribute is applied to the max length attribute setting for the field. The decimal places for a field are a combination of the max length attribute setting and the scale attribute. For example, if you want four decimal places for the field, you need a max length attribute setting of 4, plus the default of 15 or 19. You would set the scale attribute to 4 to indicate the number of decimal places. Six decimal places require a max length setting of 21, a scale attribute setting of 6, and so on.\n\n **Note:** Increase the max length attribute to a value greater than 15 to increase this attribute.\n\n
\n\nscript\n\n\n\na function that returns the contents of the field\n\n\n\nany slushbucket field\n\n\n\nEnables you to write a script to define what is loaded into the slush bucket field.\n\n
\n\nshort\\_label\n\n\n\ntrue/false\n\n\n\nany reference field\n\n\n\nLong or short labels refer to the label that appears for reference fields on a form. For example, if the reference field contains the caller’s email address, the long label would be Caller Email, while the short label would be Email.\n\n- Usually the placement of the reference field on the form makes it clear what the field represents.\n- The global property \\(**glide.short.labels**\\) specifies the type of labels that appear for all reference fields on any form.\n- You can override the global property for any reference field by setting the **short\\_label=true** or **long\\_label=true** attribute for the reference field in the dictionary\n\n
\n\nshow\\_all\\_tables\n\n\n\ntrue/false\n\n\n\ndocument ID fields\n\n\n\nEnables users to select documents from system tables. For example, sys\\_script or sys\\_user. By default, users cannot select records from system tables.\n\n
\n\nshow\\_condition\\_count\n\n\n\ntrue/false\n\n\n\ncondition fields\n\n\n\nEnables or disables the condition count widget to preview how many records are a set of conditions. To learn more, see [Add the condition count to a condition field](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/t_AddingTheConditionCountWidget.md).\n\n
\n\nskip\\_root\n\n\n\ntrue/false\n\n\n\ntable\\_name field\n\n\n\nIf present or true, removes the base table from the list. To learn more, see base\\_table.\n\n
\n\nsla\\_basis\n\n\n\nlist of table names separated by semicolons \\(\";\"\\)\n\n\n\nany field of date type \\(glide\\_date\\_time, glide\\_date, due\\_date, date, or datetime\\)\n\n\n\nDefines the tables for which this field determines the start \\(open\\) time of an SLA.\n\n
\n\nsla\\_closure\n\n\n\nlist of table names separated by semicolons \\(\";\"\\)\n\n\n\nany field of date type \\(glide\\_date\\_time, glide\\_date, due\\_date, date, or datetime\\)\n\n\n\nDefines the tables for which this field determines the ending \\(close\\) time of an SLA.\n\n
\n\nslushbucket\\_ref\\_no\\_expand\n\n\n\ntrue/false\n\n\n\nany reference field\n\n\n\nIf present or true, prevents users from expanding the field from a form or list slush bucket.\n\n
\n\nsmallTable\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, marks this table as Small \\(that is, not large\\) for querying purposes. Without this attribute \\(or the **largeTable** attribute\\), the **glide.db.large.threshold** property, or a default value of **5,000** determines whether the table is large.\n\n
\n\nstart\\_locked\n\n\n\ntrue/false\n\n\n\nany glide\\_list field\n\n\n\nDetermines whether the field is locked or unlocked by default. Set the value to false to unlock the field by default.\n\n
\n\nstaticDependent\n\n\n\nname of table\n\n\n\nany script field\n\n\n\nSpecifies the table that the script depends on.\n\n
\n\nstrip\\_html\\_in\\_pdf\n\n\n\ntrue/false\n\n\n\nany field\n\n\n\nAttempts to remove HTML tags from a field when that field is exported to a PDF. This attribute is most useful on HTML fields.\n\n
\n\nsynch\\_attachments\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nSimilar to **update\\_synch** but writes the file attachments of the record to update sets. To learn more, see [Index attachments on a table](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/t_DisablingAttachmentsOnATable.md).\n\n
\n\ntable\n\n\n\nname of table\n\n\n\nfield\\_name field\n\n\n\nDisplays the specified table fields.\n\n
\n\ntableChoicesScript\n\n\n\nname of script include\n\n\n\ntable\\_name field\n\n\n\nSpecifies the name of a script include whose process\\(\\) method returns an array of table names from which to select.\n\n
\n\ntarget\\_field\n\n\n\npercent\\_complete\\_target decimal field name\n\n\n\nany percent complete fieldany decimal field\n\n\n\nWorks in combination with the target\\_threshold\\_colors attribute to define thresholds for percent complete fields. See the description for target\\_threshold colors.Example:\n\n ```\ntarget_field=percent_complete_target,target_threshold_colors=0:tomato;50:khaki;90:lightgreen\n```\n\n Specify an additional target\\_field attribute to compare the actual completion percentage of a task with a target percentage in a different decimal field that specifies where the task should be at this point. Use the column name of the decimal field.\n\n Example:\n\n ```\ntarget_field=percent_complete_target,target_threshold_colors=0:tomato;50:khaki;90:lightgreen,target_field=u_expected_completion\n```\n\n If you do not specify an additional target\\_field, a target value of 100 is used, allowing you to use the color thresholds with a single field value. See [Target threshold colors attribute](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/c_TargetThresholdColorsAttribute.md).\n\n
\n\ntarget\\_form\n\n\n\nname of form\n\n\n\nany table\n\n\n\nSpecifies the alternative form to be used when this table is referenced through a pop-up window on a reference field.\n\n
\n\ntarget\\_threshold\\_colors\n\n\n\nthreshold limit:color\n\n\n\nany percent complete field with the target\\_field attribute\n\n\n\nWorks in combination with the target\\_field attribute to define thresholds for percent complete fields. See the description for target\\_field.\n\n
\n\ntext\\_index\\_filter\\_junk\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nSets the value to false to [Enable or disable the Zing junk filter](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/t_DisableTheJunkFilter.md) for the table. - By default, Zing does not index or search for two-digit numbers and single character words \\(unless they are Chinese or Japanese characters\\).\n- Regenerate the index after disabling the junk filter. This attribute results in a larger table index.\n- For optimal performance, do not apply it unless it is required.\n\n
\n\ntext\\_search\\_only\n\n\n\ntrue/false\n\n\n\ntable\\_name field\n\n\n\nLimits the tables listed to those tables that are searchable by text.\n\n
\n\ntext\\_index\\_translations\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, forces indexes to be recalculated when translated strings are added. You must have a sys-admin role to modify this attribute. This one is automatically set for indexed fields that are translated, and to fields that have a translation and are being indexed. The **glide.i18n.force\\_index system** property, which defaults to true, overrides this attribute.\n\n
\n\ntime\\_zone\\_field\n\n\n\nname of field containing the time zone\n\n\n\nany schedule date/time field\n\n\n\nSpecifies the field in the parent record that contains the reference time zone for this field.\n\n
\n\ntimeDimension\n\n\n\ntrue/false\n\n\n\nany field of date type \\(glide\\_date\\_time, glide\\_date, due\\_date, date, or datetime\\) in a table subclassed from the task table\n\n\n\nIf present or true, enables the production of time dimension data for use by OLAP \\(to produce reports based on quarters, weeks, or other time periods\\). **Note:** OLAP functionality has been deprecated.\n\n
\n\ntrack\\_record\\_for\\_unauthenticated\\_user\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nEnables record tracking within Web Embeddables components. This attribute is set as needed through the Web Embeddables capability.For more information about how Web Embeddables are configured and used, see [Configure Web Embeddables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/customer-service-management/using-web-embeddables.md).\n\n
\n\ntree\\_picker\n\n\n\ntrue/false\n\n\n\nreference field to a hierarchical table\n\n\n\nDisplays the hierarchy of reference values in a tree display \\(such as locations\\). **Note:** The tree display hierarchy does not appear in reference fields when you are using mobile applications.\n\n
\n\nts\\_weight\n\n\n\ninteger value\n\n\n\nany field\n\n\n\nControls the relative importance of a match in the field for a text search. To learn more, see [Set the relative weight of a field](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/search-administration/t_ControlMatchRelevanceByField.md).\n\n
\n\ntypes\n\n\n\nlist of valid element types separated by semicolons \\(\";\"\\)\n\n\n\nfield\\_name field\n\n\n\nLimits the display of fields to the specified types.\n\n
\n\nupdate\\_exempt\n\n\n\ntrue/false\n\n\n\nany field from a table that has update\\_synch set to true\n\n\n\nIf present or true, you can change this field without skipping updates to the rest of the record. During software upgrades, the value of this field is preserved, while the rest of the record receives upgrades. By default, the Active field on a tracked table is treated as update\\_exempt even if the attribute is not present.\n\n
\n\nupdate\\_synch\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIndicates that changes in the table are tracked in update sets. Administrators cannot modify this attribute. To migrate data, use an [Importing from another ServiceNow instance](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/integrate-applications/c_ImportingFromAnotherSNInstance.md).\n\n
\n\nuse\\_document\\_viewer\n\n\n\ntrue/false\n\n\n\nany table\n\n\n\nIf present or true, enables users to open supported attachments in a document viewer within the platform, rather than downloading the files directly to their own file system.\n\n
\n\nuse\\_workflow\n\n\n\ntrue/false\n\n\n\nany table that has delivery plans or uses workflow\n\n\n\nIf present or true, causes a workflow to be used instead of delivery plans.\n\n
\n\nuser\\_preference\n\n\n\ntrue/false\n\n\n\nany field\n\n\n\nIf present or true, causes any user preferences to be used instead of the normal default value.\n\n
\n\nvertical\\_layout\n\n\n\ntrue/false\n\n\n\nradio buttons\n\n\n\nIf true, displays the radio buttons vertically.\n\n
- **[Modify the Glide durations format](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/table-administration-and-data-management/c_ModifyTheGlideDurationsFormat.md)** \nTo convert fields that are displayed in milliseconds \\(such as 'Resolution Time' on the Incident table\\) to a duration format \\(Months/Days/Hours/Seconds\\), populate the attribute field on the dictionary with: `format=glide_duration`.\n\n**Parent Topic:**[Managing tables and indexes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/platform-administration/table-administration-and-data-management/using-table-administration.md)\n\n"}}