/

Using an Existing OneAtlas Subscription

How to access data with an existing OneAtlas subscription.


Introduction

If you have a OneAtlas subscription that you want to use on the UP42 Platform, you need to have the OneAtlas credentials to create an environment and than add the OneAtlas API key-value pair as an environment variable. To connect the environment with the UP42 Platform and use your subscription, you then need to reference it in the relevant blocks that are included in your workflow(s).

If you already have a OneAtlas API key, we recommend generating a new one just for using it with UP42. This way, you can manage it separately from your other API key(s).

Steps

Create a OneAtlas API key

For completeness sake, we also included the step for generating a new OneAtlas key. Since OneAtlas is an external service, please note that we cannot guarantee the accuracy of the information herein provided.

  1. Login to your OneAtlas account.

  2. Go to your API key listing page here.

  3. Create a new API key and copy the value.

  4. Done.

The API key is only displayed once. If you fail to copy and save the value in a separate file, it will be lost and you will need to generate a new API key. Use only temporary storage for this purpose, your own secret storage or any other secure storage system.

Step 1: Create an Environment

  1. In the console, open the tab workspace.

  2. Click on tab Environments.

  3. Scroll down and click on the button Create Environment.

  4. Type in the name of your environment (in this example: OneAtlas LL) and click Save.

  5. You now created an empty environment.

  6. Done.

Create Enviroment
Create Enviroment

Save Enviroment
Save Enviroment

Step 2: Add the API Key as an Environment Variable

  1. Go to your environment and click on Add Environment Variable.

  2. Add the name ONEATLAS_API_KEY as Key.

  3. Copy the OneAtlas API key and paste it into Value, then click Save.

  4. Your newly created environment variable ONEATLAS_API_KEY should now be visible on your Environments dashboard.

  5. Done.

Good to Know

You can add as many environment variables as you want, but make sure their names are unique. For using OneAtlas data, please name the environment variable ONEATLAS_API_KEY, otherwise the credentials pass-through fails.

Please note that you cannot change the values of the environment variables. If you need to change the value of a variable, you need to create a new environment and add the variable with the respective changed value there.

Add Environment Variable
Add Environment Variable

Save Environment Variable
Save Environment Variable

Step 3: Reference the Environment in a Workflow

  1. Go to your project.

  2. Open the workflow where you want to enable the OneAtlas credentials pass-through.

  3. Reference the environment in the relevant block(s). In the case of a data subscription such as OneAtlas, the environment should be referenced in the data block.

  4. Configure the job. For more information, please refer to Job Configuration.

  5. Run the job.

  6. After the job has been successfully run, you can go to the job dashboard and check the credit consumption for each step. Since you referenced the previously created environment in the data block, the credential pass-through enables you to consume OneAtlas data without any credit costs. The first step will display a negligible amount of credits solely used for infrastructure.

Select a Workflow from your Project
Select a Workflow from your Project

Reference the Environment in the Workflow
Reference the Environment in the Workflow

No Credit Consumption (Negligible Amount) for the Block with the Referenced Environment
No Credit Consumption (Negligible Amount) for the Block with the Referenced Environment

Step 4: Done

Congratulations! You successfully ran jobs without getting charged by UP42 for the data retrieved through your OneAtlas subscription.