Skip to main content

Table and field mapping

A Jira Table Mapping defines that a Business Central table is synchronized to a specific Jira entity type. Currently supported combinations are:

BC Source TableJira Entity TypeJira REST resource
CustomerOrganization/rest/servicedeskapi/organization
Contact (Person type only)Customer/rest/servicedeskapi/customer

Only one enabled table mapping is allowed per BC table and Jira entity type combination.

Entity configuration

The Jira Entity Configurations page defines, per Jira entity type, the REST endpoint and processing rules used by every table mapping for that entity:

FieldMeaning
Jira API EndpointRelative REST resource used to create or update the entity
Jira API Endpoint (Delete)Relative REST resource used to delete the entity; supports {entityId}/{organizationId} placeholders
Default Processing PriorityDefault priority used for messages of this entity type when the mapping does not override it (lower number = processed first)
Prevent DeleteBlocks delete operations from being queued for this entity type
Prevent Standard Field ChangeBlocks changes to standard fields once the record has already been synced
Create if Update FailsQueues a new create message when an update fails because the target no longer exists in Jira

Default entity configurations for Organization and Customer are created automatically the first time the onboarding wizard or Initialize Defaults action runs. The Test Configuration action on the entity configuration card shows the resolved endpoint together with all enabled table mappings that use it.

Table mapping

On the Jira Table Mapping card, the Business Central Source and Jira Target sections define the BC table and Jira entity type, and can no longer be changed once the mapping is Enabled. The Connection section selects the OAuth2 Setup Code to use, with an optional Base URL override. The Status section shows the mapping Description and the number of Active Fields.

Enabling a mapping is only possible when:

  • an OAuth2 setup is selected and has both a Client ID and client secret,
  • the OAuth2 setup has a Cloud ID (that is, it has completed authorization), and
  • a Base URL is available, either on the mapping or on the OAuth2 setup.

Disabling a mapping is blocked while pending, processing or retry messages still exist for it.

Actions available on the table mapping card:

  • Create Default Mappings - creates a recommended set of field mappings for the selected entity type (see Field mapping).
  • Select Records to Sync - mass-enables synchronization for existing records (see below).
  • Activation Rules - configures automatic sync activation (see Automatic activation).
  • Open Entity Configuration - opens the entity configuration card for the mapped entity type.
  • Get Available Spaces - loads Jira Service Management spaces for space assignment.
  • Test Mapping - builds a sample payload from the first record of the source table, without sending it to Jira.
  • Validate Against Jira - checks that the custom fields used in the field mappings actually exist in Jira.

Field mapping

Field mappings, shown in the Field Mappings part of the table mapping card, define which Business Central field is sent to which Jira field:

FieldMeaning
Field CategoryStandard Field (built-in Jira field, e.g. name) or Custom Field (organization-specific Jira field)
BC Source FieldThe Business Central field to synchronize
Jira Field IDThe target field ID or name in Jira
Jira Field TypeText, Email, URL, Date, Number, Boolean, Phone, Select or Multi Select
Default Value if BC Field EmptyValue sent to Jira when the BC field is empty
Mapping EnabledWhether the field mapping is active
Field Purpose/Usage DescriptionFree-text note describing the field's purpose (hidden by default)

Custom Field mappings are sent to Jira through the organization/customer detail fields API rather than the standard create/update call, which requires additional OAuth2 scopes - see Additional scopes - only applicable if using detail fields.

Only one field mapping is allowed per BC field within a table mapping. For custom fields, the Jira Field ID must be at least two characters, cannot contain ? : ; . = ", and cannot be one of the reserved words Name, Key, Created, Updated or Label. The Test Field Value action shows the resolved value for the first record of the source table.

Use Create Default Mappings on the table mapping card to populate a recommended set of field mappings for the chosen entity type; existing mappings are cleared after confirmation.

Combined name

Enabling Enable Combined Name on the table mapping lets Jira receive a name assembled from several Business Central fields, using a Combined Name Template with field names in curly braces, for example:

{No.} - {Name}

The resulting value is stored in the Jira Combined Name field on the Customer or Contact card. It is recalculated automatically whenever a template field changes on the record, and - when the combined name is enabled on the mapping for the first time - for every already sync-enabled record, tracked with a progress dialog.

Mass-enabling synchronization for existing records

Use Select Records to Sync on the table mapping to enable synchronization for many existing records at once instead of one by one:

  1. Select Select Records to Sync on the table mapping card or list.
  2. Use the standard filter dialog to narrow down the records to include.
  3. Confirm the selection.

All matching records that do not already have sync enabled are updated, and a confirmation message reports how many records were processed. Records are only queued if the table mapping and its field mappings are already fully configured, as described above. For Contacts, only records of type Person are considered, matching the supported combinations.

Assigning records to Jira Service Management spaces

A space refers to a Jira Service Management service desk. Organizations and Customers can be linked automatically to one or more spaces when they are synced:

  1. On the table mapping card, select Get Available Spaces to load spaces from Jira Service Management (requires an authorized OAuth2 setup).
  2. Select the spaces to use and confirm; they are added to the Assigned Spaces part on the table mapping card.

By default, every synced record is linked to all assigned spaces. To restrict a space to matching records only:

  1. On the Assigned Spaces part, enable Enable Filter for the space.
  2. Select Edit Filter to open the filter builder and define the criteria.
  3. Use View Matching Records to check which records currently match, or Clear Filter to remove the restriction again (all records are then assigned).

The filter builder is pre-populated with commonly used fields, though other fields of the source table can be added as well:

Source tablePre-populated filter fields
CustomerNo., Country/Region Code, Customer Posting Group, Customer Price Group
ContactNo., Country/Region Code, Type, Company No.

When a Customer or Contact is synced and created in Jira, the connector automatically links the resulting Organization or Customer to every assigned space whose filter matches (or to all assigned spaces, if no filter is set for that space).