Setting Up Atmosphere with Arc

This guide walks you through setting up Atmosphere using Cubewise Arc, the recommended IDE for TM1 development. Arc provides a user-friendly interface for managing Atmosphere connections and deploying TI processes to your TM1 instances.

Overview

By the end of this guide, you will be able to:

• Configure Arc to connect to your Atmosphere tenant

• Set up connections to TM1 instances and external data sources (Snowflake, Salesforce, Databricks, etc.)

• Deploy Atmosphere TI processes to your TM1 environment

• Test and verify your setup

Prerequisites

Before you begin, ensure you have:

• Atmosphere Welcome Kit - Contains your tenant domain and API key

• TM1 Server Access - Admin-level access to at least one TM1 instance

• Network Access - Ability to reach your TM1 server from the machine running Arc

New Installation

If you do not have Arc installed, follow these steps:

Step 1: Download Arc

Download the latest version of Arc from Cubewise.

Step 2: Extract and Run

1. Extract the contents of the ZIP file to your preferred installation directory (e.g., C:\Cubewise\Arc)

2. Run arc.exe to start the application

3. Wait for Arc to complete its initial setup - you'll see configuration files generated in the same directory

Step 3: Configure Atmosphere URL

1. Close Arc

2. Open the settings.yml file in the Arc installation directory

3. Add the following configuration at the bottom of the file:

Step 4: Connect to TM1 Instance

Before using Atmosphere, you need to connect Arc to your TM1 instance(s). The connection process varies depending on your TM1 deployment, but you will need to edit the same settings.yml file. Look for official documentation that matches your implementation:

Tip: Your Atmosphere domain is provided in your Welcome Kit. It typically follows the format {tenant}.atmosphere.run for production or {tenant}.atmosphere-dev.run for development environments.

Upgrading an Existing Installation

If you have a prior version of Arc installed, follow these steps:

Step 1: Download Arc

Download the latest version of Arc from Cubewise.

Step 2: Update Arc Executable

1. Close Arc if it's running

2. Navigate to your Arc installation directory

3. Replace the existing arc.exe with the newly downloaded version

Step 3: Clean Up Previous Atmosphere Plugin

1. Navigate to the /plugins directory within your Arc installation

2. Check if there's an existing atmosphere folder

3. If found, delete this folder

Important: Removing the old Atmosphere plugin folder prevents conflicts with the new integrated Atmosphere features in Arc.

Step 4: Configure Atmosphere URL

1. Open the settings.yml file in the Arc installation directory

2. Check if Atmosphere settings already exist at the bottom of the file

3. If not present, add the following configuration:

4. Save the file and restart Arc

Setting Up Atmosphere Connections

Once Arc is configured and connected to TM1, you can set up connections to the various endpoints Atmosphere supports.

Adding a New Connection

1. Look for the Atmosphere icon in the top-right corner of Arc (next to the User icon)

2. Click the icon to open the Atmosphere Connections panel

3. Click the + button to add a new connection

4. Select the connection type from the dropdown:

   • TM1 - IBM Planning Analytics / TM1 instances

   • Snowflake - Snowflake data warehouse

   • Databricks - Databricks workspace

   • Salesforce - Salesforce CRM

   • And more...

5. Fill in the required parameters based on the selected connection type

Note: Each connection type has different required parameters. Refer to the specific connector documentation for details.

Testing Connections

After creating a connection, verify it works correctly:

1. Locate the newly created connection in the list

2. Click the connection test icon (WiFi-like icon) next to the connection

3. Wait for the test to complete

4. A successful test confirms Atmosphere can communicate with the endpoint

A successful connection test means your credentials are valid and network connectivity is established. You're ready to deploy Atmosphere processes.

Deploying Atmosphere TI Processes

With your connections configured, you can now deploy Atmosphere's TurboIntegrator processes to your TM1 instance.

Accessing the Deploy Section

1. In the Atmosphere Connections panel, find the TM1 connection where you want to install the processes

2. Click to expand the connection details

3. Navigate to the Deploy section

Configuring Deployment Options

Before deploying, configure the following options:

API Key Handling

Choose how the Atmosphere API key should be stored:

Module Selection

Select which Atmosphere modules to deploy:

1. Click the module dropdown to see all available modules in your tenant

2. Select the modules you need (you can select multiple)

3. Only selected modules will be deployed as TI processes

Operating System

Select the operating system your TM1 instance runs on:

• Windows

• Linux

Note: If you're running TM1 version 12 or later, you can skip the OS selection as it's not required.

Running the Deployment

1. Review your deployment configuration

2. Click Run to start the deployment

3. Wait for the process to complete

The deployment will create }atmosphere.* TI processes in your TM1 instance for each selected module.

Verifying the Installation

After deployment, verify that everything was installed correctly:

Step 1: Access Your TM1 Instance

Connect to your TM1 instance using your preferred method:

• TM1 Architect

• Planning Analytics Workspace (PAW)

• Arc

Step 2: Enable Control Objects

Ensure control objects (processes starting with }) are visible:

• In TM1 Architect: View → Show Control Objects

• In PAW: Settings → Show Control Objects

• In Arc: Control objects are visible by default

Step 3: Verify Atmosphere Processes

Look for processes starting with }atmosphere.:

You should see processes such as:

• }atmosphere.update.secret - For managing connection credentials

• }atmosphere.run.ping.* - For testing connections

• }atmosphere.run.* - Various connector and module processes

If you can see the }atmosphere.* processes in your TM1 instance, the installation was successful. You're now ready to start using Atmosphere.

Alternative Setup Methods

If you prefer not to use Arc, Atmosphere connections and credentials can also be managed using:

• cURL - Command-line HTTP requests

• Postman - API testing tool

• Python - Using the requests library or TM1py

Detailed documentation for these alternative methods is coming soon. In the meantime, contact Cubewise support for guidance.

Next Steps

Now that Atmosphere is set up, you're ready to start building integrations. Browse the Connectors and Functions sections in the navigation menu to explore available modules.

Troubleshooting

Arc shows two Atmosphere icons

• Verify atmosphereurl is correctly set in settings.yml

• Ensure you're using the latest version of Arc

• Clear the current /plugins/atmosphere folder and re-install arc.exe

• Restart Arc after making configuration changes

• Clear browser cookies and cache

Connection test fails

• Verify credentials are correct

• Check network connectivity to the endpoint

• Ensure any required firewall rules are in place

• Review the error message for specific guidance

Deployment fails or processes don't appear

• Ensure the user you provided to Atmosphere has admin privileges on the TM1 instance

• Check that the TM1 connection in Arc is working

• Look for error messages in the TM1 server log

Need more help?

Contact Cubewise support at code-support@cubewise.com