Table of Contents

...

• Workspace ID

  • Fill in the ID of the Assets (Insight) workspace you want to configure backup for. The Workspace ID can be found on the following link: https://[yourcloud].atlassian.net/rest/servicedeskapi/insight/workspace. The Jira Service Management REST API uses the workspace ID to identify your individual instance of Assets (Insight), it is an alphanumeric string at the end of the text shown on the opened link with the following sample appearance: 3b3b70g5-66f8-3c01-a2d7-e5bbf2584dc3:

  • {"size":1,"start":0,"limit":50,"isLastPage":true,"_links":{"self":"https://[yourcloud].atlassian.net/rest/servicedeskapi/assets/workspace","base":"https://[yourcloud].atlassian.net","context":""},"values":[{"workspaceId":"3b3b70g5-66f8-3c01-a2d7-e5bbf2584dc3"}]}

...

After filling the three fields in, click the “Save and Continue“ button. If there is an error in the filled fields, you will see the corresponding error message and link for editing the incorrect information:

...

• MongoDB

• DocumentDB

• CosmosDB

• DynamoDB

To activate local DB storage, switch on the ”Backup on local database” toggle and fill in the following data (examples and instructions are given for MongoDB):

...

After deciding on the database, click the Save and Continue button to proceed to the third step.

...

When the backup database is chosen, you will see the Current Connection information and can Sync the existing schemas by clicking the Sync schemas button:

...

...

After filling in the necessary information, click the Save target instance button to add the instance to the list.

...

You can delete the current connection by clicking Delete. You will see the confirmation popup:

...

If you click the Delete button, the synched schemas will disappear and to continue using the app, you will need to go through the Initial setup.

...

• Schema Name

• Instance

  • URL of the instance where the schema is located

• Location

  • Cloud

  • Another Cloud: Backup schemas from another instance

  • Data Center: Add Data Center / Server

• Status

  • Active

  • DeletedInactive

    • When the schema is deleted from the The schema will be “inactive” if it was a part of another instance, but the instance was later removed from the list.

    • Backup will be disabled for the schemas with the “Inactive” status

  • Deleted

    • When the schema is deleted from the assets. It is not possible to backup the deleted schema, in this case Backup now button will be disabled:

      • 

    • Sync Error

      • Backup will be disabled for the schemas with the “Sync error” status

• Last backup date

  • Date of the last backup

  • In this column, additional information might be shown, e.g. regarding the last backup backup error

    • 

• Backups

  • Disabled

    • When the backup schedule is not set

  • Pending

    • When the backup has not yet started and is in the queue

  • In Progress

    • Backup in Progress

  • Auto

    • Backup is scheduled

    • The next backup date will also be displayed:

      • 

• Actions

  • Backup now

  • Restore

  • Schedule Backup

    • You can schedule backup using a corn expression

  • Delete

    • After clicking the Delete button, you will see the confirmation popup:

      • 

...

• Hide deleted schema toggle

  • By turning off the toggle you can hide the deleted schemas

• Instances (single-select)

  • You can choose the instances for which you would like to see the schemas

  • Instance type

    • Cloud

    • Another CloudData

    • CenterDC/Server

  • Status

    • Active

    • Inactive

    • Deleted

    • Sync Error

  • Search

    • You can search the scheme by name. After typing the first letter in the Seach field, the schema grid will be automatically filtered according to the search term.

...

• • Clear Filter

    • Will appear if at least one filter is selected and will clear all the selected filters:

...

The filters will remain selected if you navigate through the app or refresh the browser window.

...

Click the Yes button to start the backupYou can add descriptions to certain backups for further simplifying the backups management. You can check the backup process status later view and edit the description if needed. After adding the description (not mandatory), click the Yes button to start the backup. You can check the backup process status along the corresponding schema in the Synced schemas grid:

...

After the backup is started, it will go into the “IN QUEUE“ status and “IN PROGRESS“, when the backup process is started.

When the backup is started you can stop the process anytime, by clicking Stop button:

...

...

...

...

A backup schedule should be configured for an individual schema. To configure the backup schedule, click on the Schedule backup button, under three dots along the desired schema. The schedule configuration window will pop up:

...

To switch backup on, activate the “Backup On/Off“ toggle. The green color of the toggle corresponds to “On“ and the grey color corresponds to “Off”.You can “Enable“ toggle. The green color of the toggle corresponds to “On“ and the grey color corresponds to “Off”.

You can choose between two options - Recommended and Custom. In case of choosing the recommended time, the most optimal time is defined in the moment and the backup will start every day on that time.

You can also choose your desired schedule for the backup. You can define the schedule at a specific time by choosing from every:

• Year

• Month

• Week

• Day

...

Additionally, you can use Cron expression to further define the schedule.

Cron Expression

To enhance the backup schedule, cron expression is used. A cron expression gives you control over the frequency, compared to the default schedules. It is a simple and straightforward expression to define the backup schedule. You can find more information about how to construct the expression on the following links:

...

After deciding on the schedule and filling in the expression, click “Save“ button.

If the Cron expression is not valid (e.g. number of hours is more than 24 or the number of minutes is more than 60), after clicking the Save button, you will see the error message - “Cron expression is not valid”:

...

...