Adding Connector Custom Fields
This guide walks you through the process of configuring Connector Custom Fields, which is necessary if you intend to use Remote Object Links.
Automatically create Custom Fields
When a mapping is created, an accompanying read-only custom field of type "Remote System Reference" is automatically created for you to display the information from Salesforce in the Jira issues. The administrator might wish to configure the field as for other custom fields. For more information regarding Custom Fields, view the Jira documentation.)
Please note the following defaults for these fields:
- Globally available for all issues.
- Are automatically added to the default Field Configuration. For more information, view the Jira documentation regarding field behavior.
- Their field templates are empty, although there is a default view that displays a link back to the Salesforce object.
- They are not associated with any screens.
The administrator may want to add a field template and will need to associate the field with at least one screen.
An example of some automatically created Salesforce custom fields is shown below in a view from the standard Custom Fields page in Administration:
Remote Linking Custom Fields
The Connector provides two other custom fields that can be added by an administrator to Jira issues:
- Remote Object Link
- Multi Remote Object Link
These fields allow a Jira issue to link to more objects in Salesforce than the automatically added custom field.
For example, you might want to also add to a Jira issue, which is linked to a Salesforce Case, links to related Contacts in Salesforce. The multi field allows you to add more than one link.
Adding new Custom Fields
You won't need to add the Remote System Reference fields as they are automatically created as mentioned in the introduction.
If you wish you can add the Remote Object linking fields with the following steps:
- Go to Cog Icon > Issues.
- In the sidebar, under Fields, click Custom Fields.
- Click on the Add Custom Field link near the top.
- The Select a Field Type dialog box will appear.
- Choose the field you want to create, either Remote Object Link or Multi Object Link and click Next.
- Type in a Name and Description for your new field.
Then click Create.
- You are now asked to associate the field you just created to screens.
Choose the screen you want to associate the field with and click Update.
You will now need to specify which Salesforce object you want the field to link to.
Find your new field's listing and on the far right, click the Cog Icon > Configure:
At the screen for the Default Configuration Scheme for your field, click the Edit Configurations link under Configurations.
- On the Edit Display Template screen, choose the Remote System and Remote Object you want linked to the custom field.
Then click Submit.
- You can now start adding a Remote Object Link.
See Modifying display templates for information on how to customize the display templates of the custom fields.