ShowDescriptions
Specifies whether the provider retrieves and returns table and column descriptions from ServiceNow metadata endpoints.
Possible Values
NONE, TableLabels, ColumnLabels, TableAndColumnLabels, ColumnCommentsData Type
string
Default Value
"NONE"
Remarks
Set this property to control whether table and column display names or comments are retrieved from ServiceNow metadata tables such as sys_documentation, sys_db_object, and sys_dictionary.
The following options are supported:
- NONE: Does not retrieve descriptions for tables or columns. No additional API calls are made.
- TableLabels: Retrieves display names for all tables from the sys_db_object endpoint.
- ColumnLabels: Retrieves display names for all columns from the sys_documentation endpoint.
- TableAndColumnLabels: Retrieves display names for both tables and columns from the sys_db_object and sys_documentation endpoints.
- ColumnComments: Retrieves comments for all columns from the sys_dictionary endpoint.
Setting this property to any value other than NONE causes the connector to issue additional API calls to collect the metadata.
This property is useful when you want to include descriptive metadata or display names for schema objects in ServiceNow.