Omnitable Additional Resources

JSON Configuration Settings

Baseline Configuration

Setting Name	API API, or Application Programming Interface, is used by customers to create custom career portals or to take advantage of Data Mirror/DataMart. Bullhorn prefers to use REST API. Name	Example	Description	Required?
Object Name	objectName	"TR1__Job A job (vacancy, position, role) is an opening for which a customer's client needs a placement._Role A job (vacancy, position, role) is an opening for which a customer's client needs a placement.__c"	The API Name of the salesforce sObject this table will be displaying	Yes
Context Filter Field Name	contextFilterFieldName	"TR1__Job__c"	The API Name of field used for the contextual filter. For example, when the table is displaying a related list.	No
Default Fields Fieldset	defaultFields	"Applications_omnitable_default"	The name of a fieldset, found on the above sObject, containing the fields to display on this table	Yes
Available Fields Fieldset	availableFields	“Applications_omnitable_available”	The name of a fieldset, found on the sObject, containing the fields that the user can choose to display. If null then the default fields field set is used instead	No
Infinite Scroll Initial Chunk Size	infiniteScrollInitialChunkSize	50	How many records should be loaded when the table is first displayed	Yes
Infinite Scroll Chunk Size	infiniteScrollChunkSize	20	How many additional records should be loaded each time the user scrolls to the bottom of the table	Yes
Column Overrides	columnOverrides		A list of Column Configuration elements (see Column Configuration section) outlining overrides that apply to specific columns on the table	No
Default Sort Order	defaultSortOrder	[{"fieldName":"Name","sortDirection": "asc"}]	A list of Sort Configuration elements (see Sort Configuration section below) outlining the default sort order of the table. While this is a list, it currently only supports a single element. fieldName= The API Name of the sObject field that the table should be sorted by sortDirection=The direction that the sort should be applied. ”asc” or “desc”. Defaults to “asc”	No
Action When used in ATS or Search and Match UI, one of multiple actions available after user has selected a sub-set of Candidates Categories	actionCategories		A list of Action Categories Configuration elements (see Action Categories Configuration section below) outlining the Action Categories to display on the Omnitable Generic/reusable component that can be added to pages to show a fully configurable/customizable list of records and actions.	No
Actions	actions		A list of Action Configuration elements (see Action Configuration section below) outlining the actions visible on the Omnitable	No
Contextual Record Type Overrides	contextRecordTypeOverrides		A list of Record Type Override elements (see Record Type Override section below) outlining the customization for specific record types	No

Column Configuration

Setting Name	API Name	Description	Required?
Field Name	fieldName	The API Name of the sObject field this override applies to	Yes
Column Label	label	Either a string literal or the name of a custom label to be displayed as the label of the column instead of the field’s label	No
Custom Sort Field	customSortField	The API Name of another sObject field that should be used to sort this column instead.	No
Custom Renderer	renderer	The full name of the LWC used to render the data in the table. If it's in a namespace, use the format "namespace/componentName" If it's not in a namespace, use the format "c/componentName"	No
Virtual Column Name	virtualName	When this value is set then an additional column will be added to the table for this field using these settings. This allows an admin to configure multiple columns showing the same data in different ways. This value becomes the unique identifier for the new column.	No

Sort Configuration

Setting Name	API Name	Example	Description	Required?
Field Name	fieldName	"Name"	The API Name of the sObject field that the table should be sorted by	Yes
Sort Direction	sortDirection	"asc"	The direction that the sort should be applied. ”asc” or “desc”. Defaults to “asc”	No

Setting Name

API Name

Example

Description

Required?

Field Name

fieldName

"Name"

The API Name of the sObject field that the table should be sorted by

Yes

Sort Direction

sortDirection

"asc"

The direction that the sort should be applied.

”asc” or “desc”. Defaults to “asc”

Action Configuration

Setting Name	API Name	Example	Description	Required?
Action Name	actionName	Reject/Unreject	The unique name of the Action IMPORTANT: If adding a custom ATS action, insert the value from the Action Name field (from ATS Job Custom Action Custom Metadata Type)	Yes
Action Label	actionLabel		The display name of the Action, displayed in the UI. It is recommended to use shorter labels to prevent trimming in a dropdown menu.	No
Menu Category	menuCategory		The name of the Action Category this Action belongs to. Should be skipped for uncategorized actions.	No
Contextual Record Types	contextRecordTypes	TR1__Permanent	An array of developer names for the record types this action applies to. If the record type is namespaced, then this should be included with a double underscore EX: [“TR1__Permanent”, “customRecordType”] If this attribute is not present, then the action applies to any record type.	No
Modal Size	modalSize	medium	The size of the action modal, allowed options are: ["small", "medium", "large", "full"]. Defaults to medium.	No
Flow Name	flowName	TR1__ATS_Action_Launcher	The API Name of the Screen Flow to be loaded when the action is executed	Yes
Pinned	pinned	false'	Sets whether the Action should appear pinned in the toolbar, or unpinned in the Action Menu	Yes
Icon	icon	utility:leave_conference	The name of an SLDS Icon to display. EX: utility:call	No
Variables Mapping	variablesMapping	"variablesMapping": { "actionName": "actionName", "selectedIds": "applicationIds", "contextualRecordId": "jobId" }	An Action Variables Mapping object that contains information on the names and types of variables passed to the Action Flow. If not set, no variables will be passed to the Flow	No

Action Variables Mapping

Setting Name	API Name	Example	Description	Required?
Omnitable Name	omnitableName	JobATS	If set, the current Omnitable API Name will be passed to the flow, as a String, in a variable by this name	No
Selected Ids	selectedIds	applicationIds	If set, the currently selected Ids will be passed to the flow, as a List of Strings, in a variable by this name	No
Selected Object Name	selectedObjectName	TR1__Job_Role__c	If set, the current Omnitable Object Name will be passed to the flow, as a String, in a variable by this name	No
Contextual Record Id	contextualRecordId	jobId	If set, the Id of the Record page is passed to the flow, as a String, in a variable by this name.	No
Contextual Record Object Name	contextualRecordObjectName		If set, the Object Name of the Record page is passed to the flow, as a String, in a variable by this name.	No
Action Name	actionName		If set, the action name will be passed to the flow, as a String, in a variable by this name	No

Action Categories

Setting Name	API Name	Example	Description	Required?
Category Name	categoryName		The unique name of the Action Category	Yes
Category Label	label		The display name of the Action Category, displayed in the UI. Either the raw text value or the API name of custom label to use. It is recommended to use shorter labels to prevent trimming in a dropdown menu.	Yes

Setting Name

API Name

Example

Description

Required?

Category Name

categoryName

The unique name of the Action Category

Yes

Category Label

label

The display name of the Action Category, displayed in the UI.

Either the raw text value or the API name of custom label to use.

It is recommended to use shorter labels to prevent trimming in a dropdown menu.

Yes

Record Type Override

Setting Name	API Name	Example	Description	Required?
Context Filter Field Name	contextRecordType	TR1__Job__c	The developer name for the record type these overrides apply to. If the record type is namespaced, then this should be included with a double underscore e.g. TR1__Permanent	Yes
Default Fields Fieldset	defaultFields	omnitable_default_permanent	The name of a fieldset, found on the sObject the table displays, containing the fields to display on this table	No
Available Fields Fieldset	availableFields	omnitable_available_permanent	The name of a fieldset, found on the sObject the table displays, containing the fields that the user can choose to display. If null then the default fields field set is used instead	No

Setting Name

API Name

Example

Description

Required?

Context Filter Field Name

contextRecordType

TR1__Job__c

The developer name for the record type these overrides apply to.

If the record type is namespaced, then this should be included with a double underscore e.g. TR1__Permanent

Yes

Default Fields Fieldset

defaultFields

omnitable_default_permanent

The name of a fieldset, found on the sObject the table displays, containing the fields to display on this table

Available Fields Fieldset

availableFields

omnitable_available_permanent

The name of a fieldset, found on the sObject the table displays, containing the fields that the user can choose to display. If null then the default fields field set is used instead

For JSON Configuration Examples, see Omnitable JSON Configuration Examples.