Table of Contents
...
Assets search gives the possibility of enhanced search, visibility, and selection of Asset objects in Assets custom fields from the Customer Portal. After configuration, the Asset search field will be added to the customer portal on the request creation page. See Asset search configuration and Assets search on the Customer Portal below for the user guide.
...
Go to “General Settings / Assets search” to configure connection with Assets:
...
Click the “Configure now” button and fill in the Email and API Token fields:
...
When fill both fields in, the “Save Configuration“ button will be enabled and if the credentials are correct, you will see the success message:
...
You can refresh the connection status by clicking the “Refresh status“ button.
If the credentials are incorrect, you will see the corresponding notification:
...
You can also delete the connection by clicking the “Delete configuration” button after clicking the “Edit Configuration” and by confirming the deletion in the confirmation popup:
...
After the connection is successful, you can start configuring the Asset search field by clicking “+Add Asset search field“ button and defining the parameters.
...
| Info |
|---|
The corresponding Assets custom field should be initially created and configured in Jira! |
Asset Search Parameters & Scope
Active/Inactive (toggle)
Switch this toggle to show or hide the search field on the Customer Portal.
Toggling this on will make this Asset field mandatory for requests in the Customer Portal.
Name (mandatory)
Choose a name for your Asset search field. The name will be visible above
Placeholder
- Choose a placeholder for your Asset search field. This placeholder will be visible by default in
the search field on the Customer Portal.
Add a description for your Asset search field. This description will be visible under the search field on the Customer Portal.
Copy to summary toggle
Projects (mandatory)
Select the project(s), in the requests of which the Asset search field should be visible.
Issue Types (mandatory)
Select the Issue Type(s), where the Asset search field should be visible. The list of the Issue Types is defined by the selected project above.
If you remove a project from the configuration, the corresponding Issue Types will be cleared.
Request Types
Select the Request Type(s), in which the Asset search field should be visible. The list of the Request Types is defined by the selected Projects and Issue Types above.
If you remove a project or issue type from the configuration, the corresponding Request Types will be cleared.
If the Assets field is added to any Request Type in the Jira configuration, you cannot add such a field into the configuration of the app. If you need to use the field from the app, please remove it from the selected Request Type in Jira.
You can configure only one Asset search field with the same request type. If the Request Type is selected in the configuration of one Asset search field, if you try to configure another field with the same request type, you will see the corresponding error message upon saving the configuration and the field configuration will not be saved:
Assets info sheet | Display SettingsDisplay Settings
Display Name
Choose a name for your Asset search field. The name will be visible above the search field on the Customer Portal.
Placeholder
Choose a placeholder for your Asset search field. This placeholder will be visible by default in the search field on the Customer Portal.
Description
Add a description for your Asset search field. This description will be visible under the search field on the Customer Portal.
Linked Jira Asset Field (mandatory)
Choose the Asset custom field that should be shown on the Customer portal and where the searched object will be selected after the creation of the request. The dropdown will show all the Asset fields in the JSM. The Asset field must be associated with the create and edit issue screens of the selected projects' corresponding issue type(s).
Display and search across these attributes in the custom field
Select the attributes that should be displayed on the Customer Portal in the Asset Info Sheet for the searched object. The list shows the attributes selected in "Allow search filtering by these attributes" in the Assets custom field configuration in Jira.
When you click in the field for the first time it might take few seconds until all the attributes are loaded.
Even if not selected, the Label attribute and the object key will always be visible on the Customer portal.
Field can store multiple objects (toggle)
Select this toggle if the “Field can store multiple objects“ option in the Asset field configuration is selected.
If The toggle is not activated, it will be possible to select only one Asset object in the field (radio button):
Default Response
Select the attributes that should be displayed on the Customer Portal in the Asset Info Sheet for the searched object. The list shows the attributes selected in "Allow search filtering by these attributes" in the Assets custom field configuration in Jira.
Use Default response and hide from portal (toggle)
Hide this field from the request form. It will be visible in the issue view, and pre-field pre field with the value you field here.
Required (toggle)
Make this field mandatory for requests in the Customer Portal.
+ Add another field
You can add more than one Asset search field (up to 25).
You can also add dependent (cascading) fields, using filter scope (AQL) in the Jira custom field configuration.
After all the mandatory fields are filled, click the enabled “Save Configuration“ button.
Assets search on the Customer Portal
...