• Get started
  • Documentation
Products
Get started
Documentation
Resources
Atlassian Support
/
Jira Service Management
/
Resources
/
Connect, cleanse, reconcile data with Assets Data Manager
/
Move data into Data Manager to create raw data
Cloud

Run a job

Assets Data Manager for Jira Service Management Cloud is currently rolling out in Open Beta and will be available to all Premium + Enterprise sites by end of October 2024.

You must have Data Manager Admin and Adapter Admin permissions to complete the tasks in this section.

You must have navigated to Data Manager at least once before you can create a new job.

We’ve configured a job, but we need to run the job to move data into Data Manager.

Running a job takes place on your local instance, behind the firewall, and using a middleware client app called the Adapters Client.

Once a job is run in the Adapters Client, we can also add Transform functions to modify or clean up the raw data.

You can run a job manually using the command-line interface, or you can ‘wrap’ the client app in a scheduling app such as Windows Task Scheduler.

Each job is unique and can be run multiple times. The source, configuration options, transformations, and functions that are performed on the data are specified within the job configuration you selected when you Configure a new job.

After a job is run, the data is brought into Data Manager as Staged data. The history of jobs is visible in Adapters > Job execution history.

When running your Adapters Client job and your jobname includes spaces, ensure you are using standard double quotes (““), not smart quotes.

There are instances where copying UTF-8 text into another app will replace the text with smart quotes and they’ll look like they’re in italics .

Prerequisites to run the Adapters Client

Before running the Adapters Client, you must:

Run a job using the Adapters Client in MacOS

To manually run a job using MacOS:

  1. Open a command-line interface by navigating to the Terminal in Mac (Applications > Utilities > Terminal).

  2. You will need the following three pieces of information to run the Adapters Client:

    1. Your workspace ID. This should look something like this:

      1 e44regc98-8d2r-3af7-011t-209p44716366

    2. Your Adapters token. This should look something like this:

      1 ATCTT3xFrTN0U64VR99p1VfpQtLlpar7R4hq6PSkiNNaNOyk37P_7URVmROOp1Orez-ijlluMRwJA7Cw1LsgMFqFnvhJapdniv4ewDc0twt7vPBhrbDts1fyPOW6Tw3S-Gzg6rRaEULWl2_JqQNvictFu_hK6wGxpGRvPTpyaQXzr9MtQ_8yKDms=0433HC52

    3. The name you gave the job when you created it. If your job name includes spaces, make sure to encase it in standard double quotes (if you’re copying it from a tool like Notes, check that it hasn’t become a smart quote and is in italics):

      1 "My Job Name"

  3. Navigate to the location of the Adapters Client:

    1 cd Users/Shared/assets_data_manager

  4. Select the version of the Adapters Client that matches your CPU. Pick from:

    1 2 cd osx-arm64/assets-adapters-client cd osx-x64/assets-adapters-client

  5. Run the app (substituting in your jobName, workspaceId, and token):

    1 ./dm-adapters --run "<myJobName>" --workspace-id <workspaceId> --token <your-Adapters-token>

A success message should tell you when the job is complete and if any errors were encountered while the job was running.

Run a job using the Adapters Client in Windows

To manually run a job using the Adapters Client in Windows:

  1. Open a command-line interface using Ctrl + Shift + Enter (to open as an Administrator).

  2. You will need the following three pieces of information to run the Adapters Client:

    1. Your workspace ID. This should look something like this:

      1 e44regc98-8d2r-3af7-011t-209p44716366

    2. Your Adapters token. This should look something like this:

      1 ATCTT3xFrTN0U64VR99p1VfpQtLlpar7R4hq6PSkiNNaNOyk37P_7URVmROOp1Orez-ijlluMRwJA7Cw1LsgMFqFnvhJapdniv4ewDc0twt7vPBhrbDts1fyPOW6Tw3S-Gzg6rRaEULWl2_JqQNvictFu_hK6wGxpGRvPTpyaQXzr9MtQ_8yKDms=0433HC52

    3. The name you gave the job when you created it. If your job name includes spaces, make sure to encase it in standard double quotes (if you’re copying it from a tool like Notes, check that it hasn’t become a smart quote and is in italics):

  3. Navigate to the location of the Adapters Client:

    1 cd c:\users\public\assets_data_manager

  4. Select the version of the Adapters Client that matches your CPU. Pick from:

    1 2 cd win-x64/assets-adapters-client cd win-x86/assets-adapters-client

  5. Run the app (substituting in your jobName, workspaceId, and token):

    1 dm-adapters.exe --run "<myJobName>" --workspace-id "<workspaceId>" --token "<your-Adapters-token>"

A success message should tell you when the job is complete and if any errors were encountered while the job was running.

Run a job using the Adapters Client in Linux

To manually run a job using Linux:

  1. Open a command-line interface by navigating to the Terminal in Linux (Ctrl + Alt + T)

  2. You will need the following three pieces of information to run the Adapters Client:

    1. Your workspace ID. This should look something like this:

      1 e44regc98-8d2r-3af7-011t-209p44716366

    2. Your Adapters token. This should look something like this:

      1 ATCTT3xFrTN0U64VR99p1VfpQtLlpar7R4hq6PSkiNNaNOyk37P_7URVmROOp1Orez-ijlluMRwJA7Cw1LsgMFqFnvhJapdniv4ewDc0twt7vPBhrbDts1fyPOW6Tw3S-Gzg6rRaEULWl2_JqQNvictFu_hK6wGxpGRvPTpyaQXzr9MtQ_8yKDms=0433HC52

    3. The name you gave the job when you created it. If your job name includes spaces, you will have to encase it in quotes:

      1 "My Job Name"

  3. Navigate to the location of the Adapters Client:

    1 cd Users/Shared/assets_data_manager

  4. Select the version of the Adapters Client that matches your CPU. Pick from:

    1 2 cd linux-arm64/assets-adapters-client cd linux-x64/assets-adapters-client

  5. Run the app (substituting in your jobName, workspaceId, and token):

    1 ./dm-adapters --run "<myJobName>" --workspace-id <workspaceId> --token <your-Adapters-token>

A success message should tell you when the job is complete and if any errors were encountered while the job was running.

 

Command-line errors when running the Adapters Client

The command-line will return an error if there are any inconsistencies between your data source and the way you have configured your job. Here are some possible error messages and their potential fixes:

  1. Error in line 1: Cannot find column 'cpu' in the Column Mappings. You have incorrectly entered a column name, or the name of the column in the data source contains a space.

  2. Line 280: The column count is not correct. Two possible causes:

    1. The number of column mappings in your job must exactly match the number of column mapping configured in your job.

    2. There are spaces in your CSV data, but have not selected an appropriate Qualifier character to surround text values that include spaces. The usual qualifier for CSV files is ".

  3. Column ‘whenCreated', date value '20/04/2009 1:47' cannot be converted to 'd/MM/yyyy HH:mm (8/02/2006 06:30).' You have attempted to use a date mask on a column, but the date mask you have selected doesn’t match the format of your data. Select a different date mask.

  4. When run through the command line, the Adapters Client will tell you if a newer version of the Client is available.

Still need help?

The Atlassian Community is here for you.
Ask the Community
On this pageRun a job using the Adapters Client in MacOSRun a job using the Adapters Client in WindowsRun a job using the Adapters Client in Linux
CommunityQuestions, discussions, and articles