Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
titleavailable since 5.2.0

The support page provides a direct link to the Checklist support portal and the option to generate a support file.

On this page:
Table of Contents
maxLevel3
minLevel2

Accessing the support page

You can find the support page in the Manage Apps page, in the sidebar.

  1. Go to Administration > Manage apps.

    Image Modified

  2. In the sidebar, go to Checklist for Jira > Support.

    Image Modified

  3. The following page should appear.

    Image Modified

Providing the support file

Being able to replicate issues is one of the best ways to figure our what is going on. By providing a support file, you provide context to the support team which can help pin point the problem faster, cutting down on the back-and-forth during support.

Downloading the support file

To download the support file, simply click the Download button under the Support File section. Make sure to select the data related to your support request.

Info

Not sure what to select? Ask our support team!

Generating the support file

The support file only contains your Jira version and data specific to the Checklist for Jira app, such as:

  • app version

  • checklist and proxy fields

  • checklist and proxy field configuration

  • templates

  • workflow tools provided by the Checklist app

Although no other data is exported from your instance (like projects and issues), some sensitive information is visible in the form of item names and assignees.

You can select what data you want to include in the file, as described in the table below:

Data

Description

Global Items

The list of global items per configuration scheme context, in each Checklist field file.

Default Local Items

The list of default local items per configuration scheme context, in each Checklist field file.

Parameters

The parameters of each configuration scheme context, in each Checklist, Checklist Proxy and Customer Portal Proxy field file

Templates

The templates per configuration scheme context, in each Checklist field file.

Workflow Tools

All Checklist-specific workflow conditions, validators or post functions configurations.

The data is exported in JSON format, so you can see what it contains before you send it. The files are separated by custom field, other than the workflow tools, which are separated by workflow tool type.

File examples

Description

checklist-10101.json

The “checklist” part indicates the file is for a Checklist custom field. The “10101” number is the custom field ID.

proxy-10101.json

The “proxy” part indicates the file is for a Checklist Proxy custom field. The “10101” number is the custom field ID.

customer-portal-10101.json

The “custom-portal” part indicates the file is for a Customer Portal Proxy custom field. The “10101” number is the custom field ID.

workflow-conditions.json

Contains the list of all Checklist Workflow Condition configurations.

workflow-functions.json

Contains the list of all Modify Checklists post function configurations.

workflow-validators.json

Contains the list of all Checklist Workflow Validator configurations.


Status
titleSERVER documentation
(On Cloud? Go here.)
Have questions? Contact our Service Desk for help anytime.