Configuration

Choosing which language to display

Starting with Arc v1.4.1, Arc supports now English, Spanish, German and French. Arc will display the language defined in your web browser settings.

If you are using Chrome, you can filter Chrome’s settings to show only settings related to “language”, the language used by Arc will the first one in the list. In the example below Arc will display English:

To use the French language instead, just move French to the top of the list:

You then just need to refresh Arc and it will now display the new language:

All other languages than German, Spanish and French will display in English.

Upgrading Arc for TM1

Upgrading Arc for TM1 is very simple as Arc does not require any installation, you will just need to replace your current Arc file with the new one.

To download the latest version, go to the Arc download page:

Unzip the folder and you will find the arc.exe file (if you downloaded the Windows version).

There are two ways of starting Arc, you can either start it as a local prompt by just double clicking on the arc.exe file:

If Arc is currently running as a Windows service, you will have to stop the service first, replace the arc.exe file and then start the service.

Just go to the Arc URL, by default it is servername:7070 and you will be able to use the new version of Arc.

If Arc is just open as a local prompt, just close it, replace the arc.exe file and double click into the new arc.exe file.

That’s it!

A new tab will open with the new version of Arc.

Tips: If you double click on the arc.exe file and nothing shows up, it is likely due to the fact that Arc might already by running as a service or someone else has already started it on your server.

Arc System Requirements

Arc Prerequisites

Arc is multi-platforms, it supports Windows, Linux and Mac OS.

Arc is officially supported on TM1 11+ (Planning Analytics 2+). Most features will work with TM1 10.2.2 but a number of important APIs are only present in TM1 11+.

The TM1 REST API is required for Arc to work, it can be enabled by setting the HTTPPortNumber parameter in the tm1s.cfg file, i.e. HTTPPortNumber=8111. See: code.cubewise.com/blog/enabling-the-tm1-rest-api.

To enable Turbo Integrator debugging you must also add EnableTIDebugging to the tm1s.cfg file, i.e. EnableTIDebugging =true You need to restart the TM1 service for these settings to take effect.

Server Configuration

Arc supports all TM1 security modes that require a password, Windows Authentication and CAM Single Sign On is not supported at this stage.

Web Browser

  • Internet Explorer 10+

  • Any other modern browser: Firefox, Chrome, Safari, etc.

Getting Started

Prerequisites

TM1 version

Arc is officially supported on TM1 11+ (Planning Analytics 2+). Most features will work with TM1 10.2.2 but a number of important APIs are only present in TM1 11+.

TM1 Rest API Enabled

The TM1 REST API is required for Arc to work, it can be enabled by setting the HTTPPortNumber parameter in the tm1s.cfg file, i.e. HTTPPortNumber=8111. See: code.cubewise.com/blog/enabling-the-tm1-rest-api

Debugging

To enabled Turbo Integrator debugging you must also add EnableTIDebugging to the tm1s.cfg file, i.e. EnableTIDebugging =true

You need to restart the TM1 service for these settings to take effect.

Server configuration

Arc supports multiple platforms (Windows, Linux and Mac). It can be run as either a standalone application or a service. There are additional dependencies.

TM1 security

Arc supports all TM1 security modes that require a password, Windows Authentication and CAM Single Sign On is not supported at this stage.

Where to install Arc

Arc should be installed on the same server that TM1 is running, this allows Arc to access both the ODBC data sources and text files on the TM1 server. If you install Arc on a desktop or separate server Arc will function as normal with the exception of the ODBC and Text preview in Turbo Integrator processes for TM1 10.2 FP7 and earlier versions.

Getting started with Arc

Arc requires just a few minutes to setup, just pick the instructions below based on the platform where Arc will be installed:

Adding Arc path to the linux user's environment

To execute Arc, just by typing arc in the command line, you need to add Arc path to the user’s environment.

Arc is in a separate folder inside $HOME/utilities/arc

Open bash_profile file by typing vim ~/.bash_profile:

Once editing the .bash_profile file with the text file editor of your preference, ensure that path to the arc executable is set in the Path, in the following example we defined the variable ARCPATH  pointing to /home/ec2-user/arc and then adding ARCPATH to the PATH:

  • ARCPATH=$HOME/utilities/arc

  • PATH=$PATH:$HOME/.local/bin:$HOME/bin:$ARCPATH

Then refresh the environment variables of the user by executing Executing:

source ~/.bash_profile

The user will now being able to execute arc using arc from any location, without specifying the PATH.

To execute arc in the background, use the command: arc&

Getting started with Arc on Windows

Since Arc v1.3.0, Arc is on available on multiple platforms (Windows, Linux and Mac). This article explains the steps to getting started with Arc on Mac.

Download Arc for Windows

  1. Go to code.cubewise.com/arc-download

  2. Download the correct Arc version, in this example we download Windows 64 bits:

Starting Arc

  1. Unzip the arc.x.x.x_win64.zip folder

  2. To execute Arc, just double click on the arc.exe file

If you see the message “Server running on port: 7070”, it means that Arc started successfully.

To access it, opens a web browser and go to the URL https://localhost:7070/. If this is the first time Arc is starting on your Mac you will see this:

Trialling or Buying Arc

If this is the first time, Arc starts on your laptop, you will then need to validate your license by either trialling or Buying Arc:

Connect to TM1 instances

Arc uses the TM1 REST API to connect to IBM TM1 and Planning Analytics instances, therefore it can connect to any instances assuming the TM1 REST API is enabled for this instance and the httpPortNumber is open on the server.

To access all TM1 instances on a specific server, you will need to update the adminhost parameter in the settings.yml file:

To connect to an instance on the IBM Could, follow the instructions in this article:

If Arc can’t connect to your TM1 instances:

  1. Check first that you can access the TM1 REST API using your browser.

  2. Double check your credentials (CAM Namespace is case sensitive).

Setting up Arc as a Windows service

Where to find support?

If you still can’t connect to your instances, create a new issue on GitHub:

Getting started with Arc on Linux

Since Arc v1.3.0, Arc is on available on multiple platforms (Windows, Linux and Mac). This article explains the steps to getting started with Arc on Mac.

Download Arc for Linux

  1. Go to code.cubewise.com/arc-download

  2. Download the correct Arc version, in this example we copy the download link for the Linux 64 bits:

linux1.png

Starting Arc

  1. You can use the the wget command to download.

  2. Unzip the arc_linux.zip folder

  3. AssigTn executable permissions  to arc using the command: chmod +x arc

  4. To execute Arc, use the command ./arc.

After this, arc should accessible through the port https://servername:7070

Trialling or Buying Arc

If this is the first time, Arc starts on your laptop, you will then need to validate your license by either trialling or Buying Arc:

Connect to TM1 instances

Arc uses the TM1 REST API to connect to IBM TM1 and Planning Analytics instances, therefore it can connect to any instances assuming the TM1 REST API is enabled for this instance and the httpPortNumber is open on the server.

To access all TM1 instances on a specific server, you will need to update the adminhost parameter in the settings.yml file:

To connect to an instance on the IBM Could, follow the instructions in this article:

If Arc can’t connect to your TM1 instances:

  1. Check first that you can access the TM1 REST API using your browser.

  2. Double check your credentials (CAM Namespace is case sensitive).

Getting started with Arc on Mac

Since Arc v1.3.0, Arc is on available on multiple platforms (Windows, Linux and Mac). This article explains the steps to getting started with Arc on Mac.

Download Arc for Mac

  1. Go to code.cubewise.com/arc-download

  2. Download the correct Arc version, in this example we download Mac 64 bits:

To find out if you need 32 or 64bit version, Go to the Apple Menu and select "About this Mac". If you have a Core Duo processor, you have a 32-bit CPU. Otherwise (Core 2 Duo, Xeon, i3, i5, i7, anything else), you have a 64-bit CPU.

Starting Arc

  1. Unzip the arc.x.x.x_mac64.zip folder

  2. In the example below we copied the arc.app file into a new Arc folder in Documents.

  3. Open Mac Terminal

  4. Navigate to the folder where arc.app is, using the command cd

  5. Once in the folder, to start Arc type ./arc.app &

If you see the message “Server running on port: 7070”, it means that Arc started successfully.

To access it, opens a web browser and go to the URL https://localhost:7070/. If this is the first time Arc is starting on your Mac you will see this:

Trialling or Buying Arc

If this is the first time, Arc starts on your laptop, you will then need to validate your license by either trialling or Buying Arc:

Connect to TM1 instances

Arc uses the TM1 REST API to connect to IBM TM1 and Planning Analytics instances, therefore it can connect to any instances assuming the TM1 REST API is enabled for this instance and the httpPortNumber is open on the server.

To access all TM1 instances on a specific server, you will need to update the adminhost parameter in the settings.yml file:

To connect to an instance on the IBM Could, follow the instructions in this article:

If Arc can’t connect to your TM1 instances:

  1. Check first that you can access the TM1 REST API using your browser.

  2. Double check your credentials (CAM Namespace is case sensitive).

Where to find support?

If you still can’t connect to your instances, create a new issue on GitHub:

Generating an Arc license

These instructions are for customers who have purchased Arc. If you are new to Arc and just want to try it out see this article on setting up a trial:

Click the Buy Now button

To generate the license you need first to click the Buy Now button:

If you get the message below, it means that the browser does not have an internet connection. If you are accessing Arc in a browser on a server using remote desktop try instead using a browser on your desktop or laptop. To do this use the server name and port like so: http://ServerName:7070 (Remember to change ServerName to your server). You may have to open a the 7070 port in the servers firewall.

The steps to generate an Arc license without internet connection are defined here:

Continue reading through this article if you are seeing this:

Request License from Existing Account

To request a license, you can use either the customer ID received by email or enter the email used to buy the subscription:

After clicking the request license button, an email (from software@cubewise.com) will be sent to the email used to purchase the subscription with the License ID:

To validate the license, copy the License ID from the email and paste it in the Validate License tab:

If the Buy Now button disappears, it means that your license is now active:


Trialling and Buying Arc

IMPORTANT: To trial, buy or update licenses the browser hosting the Arc user interface needs to be able to access the internet. If you are accessing Arc on a server it is possible that you will not be able to connect to the internet, if you have issues connecting try using your desktop computer instead.

1. Download Arc

To purchase Arc, you will need first to download it. The latest version of Arc will always be available on the Arc download page:

2. Start Arc

Once downloaded, unzip the folder and copy arc.exe file into the folder where you want to install Arc. In this example we copy Arc to C:\Arc folder:

To start Arc, just double click on the arc.exe.

Arc can be installed as a Windows service by following the steps described in this article:

3. Start Trial

Once started you can access Arc using the URL http://localhost:7070 if you are on the server or http://ServerName:7070 to access it from your desktop (replace ServerName with the name of your server):

NOTE: Arc will show the available TM1 instances only after starting a trial or purchasing Arc.

You will need to choose if you are an organization or an individual and you will then have to agree to the terms and conditions by clicking Agree and Start Trial:

You should now be able to see your TM1 instance on the left hand side:

arc-license7.png

4. Buy Now button

Once the trial period has expired to continue using Arc you will have to purchase a subscription by clicking to the Buy Now button:

Step 1: Choose between Organization and Individual

The first step in the purchase process is to select if you are an organization or an individual/contractor/consultant:

Step 2: Choose the subscription type

If you selected an organization, you will be able to choose between a monthly or yearly fee. Only the Monthly option is available to an individual:

Step 3: Agree to the license agreement

The third step is to agree to the license terms by clicking Agree to Terms:

Step 4 of 5: Customer Details

The fourth step is to enter your email. This is the email which will receive al information about the subscription.

If you have selected an organization, you will be able to choose how many users you want to purchase. You need to buy a user for each TM1 developer/administrator that will be accessing Arc. You can change the number of users after you purchase Arc.

Step 5 of 5: Payment Method

In the last step, you can either enter the credit card detail to the card which will be charged every month or year depending on your subscription or choose the offline payment option. When using a credit card you will be sent a notification 3 days before the subscription is renew so you can cancel if required.

NOTE: Credit card is the preferred payment method, it will allow you to use Arc immediately.

If you choose the Offline Payment option, an invoice with payment details will be sent to the email entered in the contact details.

NOTE: Your subscription starts immediately, licenses will ONLY be able to be generated when we can verify payment has been made.

After clicking on the Start Yearly button, you will then receive an email with information about your Customer ID:

Request License from Existing Account

To generate an Arc license, go to the following article:

Connecting to the IBM Cloud remotely with Arc

As it is explained in this article Using Arc on the IBM Cloud with Security Mode 5 you can use Arc with the IBM Cloud by uploading Arc to the Remote Desktop System. In this article, we explain how you can use Arc from your laptop/desktop and connect remotely to the IBM Cloud via the REST API.

The key to connecting to the REST API is to have the correct URL for your TM1 instance, then added it to the settings.yml file like so:

REST API URL

The REST API that you need to use look like this:

https://CUSTOMER-NAME.planning-analytics.ibmcloud.com/tm1/api/INSTANCE-NAME

or

https://SERVER-NAME/tm1/api/INSTANCE-NAME.

You need to replace CUSTOMER-NAME with your IBM Cloud name and INSTANCE-NAME with the name of the TM1 instance you want to connect to. NOTE: The URL is case-sensitive, CUSTOMER-NAME is normally lower-case.

Credentials

As discussed in this article Using Arc on the IBM Cloud with Security Mode 5 you need to use your TM1 automation credentials unless you change to security mode 1.

Using Arc on the IBM Cloud

This article describe the steps to use Arc with the IBM Cloud from the Remote Desktop System they provide. The instructions are based on using TM1 security mode 5 (the default):

Setting up Arc on the Remote Desktop System

  1. Upload the Arc executable to your Remote Desktop System. The easiest way to do this is to use FTP upload facility.
  2. Create a folder named Arc in your Documents
  3. Save arc.exe to Documents\Arc.
  4. Double-click on the Arc executable to start the Arc server.
  5. Open settings.yml in Wordpad and change the admin host from https://localhost:5898 to https://data:5898
  6. Save settings.yml

Login into TM1 in Arc with TM1 Automation Credentials

  1. Navigate to the http://localhost:7070
  2. Go to the About page of Arc (top right icon) and tick TM1 Credentials > Store Credentials.
  3. Click on your TM1 instance to login, you need to use the TM1 automation credentials provided in your welcome pack:
    • CAM Namespace: LDAP
    • User Name: customername_tm1_automation
    • Password: password provided by IBM

Give the TM1 Automation Account Admin Access

After you have logged in you will need to add the TM1 automation user to the Admin group if it hasn’t been added already. To do this:

  1. Login in to Architect with your IBM Id
  2. Right-click on the server: Security > Clients/Groups
  3. Find the TM1 automation user and tick the Admin group box.
  4. Close the browser and log back into Arc.

NOTE: The alternative to using the TM1 automation credentials is to change TM1 to security mode 1

Connect Arc to a TM1 instance

Arc uses the TM1 REST API to connect to a TM1 instance. You can either connect to a TM1 instance using the adminhost REST API port or using the TM1 REST API port of a specific TM1 instance.

Connect to all TM1 instances from an adminhost

In the settings.yml file if you define an Adminhost with the Admin host REST API port (5898 is the default one), Arc will be able to connect to all TM1 instances on this admin host:

settings.yml connections to TM1.png

To connect to multiple admin hosts, just follow the steps in the following article:

Connect to one TM1 instance via REST API

Another way to connect to a TM1 instance is to use the REST API port of a TM1 instance (HttpPortNumber in tm1s.cfg). This will be beneficial if you are connecting to a cloud environment and only the REST API port has been opened.

settings.yml connections to TM1.png

More details in the following article:

FAQ

General

+ What is Arc ?

Arc is an integrated development environment (IDE) for TM1 and Planning Analytics. It provides a centralized platform for all your TM1 development, access all of your on-premise and cloud environments from one location. Built from the ground up to take advantage of the new features in Planning Analytics (TM1 11+) such as hierarchies and debugging of Turbo Integrator.

+ How much does it cost ?

Arc comes with a three months trial period. If you want to continue using Arc after this period, you will have to subscribe to Arc. Arc works by subscriptions, details about the pricing can be found here.

Configuration

+ Arc prerequisites

Arc is officially supported on TM1 11+ (Planning Analytics 2+). Most features will work with TM1 10.2.2 but a number of important APIs are only present in TM1 11+.

The TM1 REST API is required for Arc to work, it can be enabled by setting the HTTPPortNumber parameter in the tm1s.cfg file, i.e. HTTPPortNumber=8111. See: code.cubewise.com/blog/enabling-the-tm1-rest-api To enabled Turbo Integrator debugging you must also add EnableTIDebugging to the tm1s.cfg file, i.e. EnableTIDebugging =true You need to restart the TM1 service for these settings to take effect.

+ Server configuration

Arc supports all TM1 security modes that require a password, Windows Authentication and CAM Single Sign On is not supported at this stage.

+ Where to install Arc?

Arc should be installed on the same server that TM1 is running, this allows Arc to access both the ODBC data sources and text files on the TM1 server. If you install Arc on a desktop or separate server Arc will function as normal with the exception of the ODBC and Text preview in Turbo Integrator processes.

Connect to a TM1 instance directly via the REST API

As well as connecting to an admin host you can also add connections directly to a REST API port, this will be beneficial if you are connecting to a cloud server and only the REST API port has been opened.

In the settings.yml replace the [] for the connections parameter with:

  • url: https://<server name portnumber>:<HttpPortNumber of TM1 instance>
  • name: name to be displayed on Arc.

Arc uses the TM1 REST API to connect to the TM1 instance, the TM1 REST API is not enabled by default. The instructions how to enable it can be found here:

How to start Arc

Where to install Arc?

Arc should be installed on the same server that TM1 is running, this allows Arc to access both the ODBC data sources and text files on the TM1 server. If you install Arc on a desktop or separate server Arc will function as normal with the exception of the ODBC and Text preview in Turbo Integrator processes.

How to run Arc?

Arc is a single executable, after downloading the file, you just need to double click on arc.exe:

A window will pop-up saying an error because Arc can't find the configuration file:

The first time Arc runs it will create a file called settings.yaml with the default settings:

How to access Arc?

To access Arc, if you are logging on the same server where Arc is running you can access Arc using:

  • http://localhost:7070/

You should be able to see on the left all TM1 instances running on the server where Arc is running:

By default Arc will connect to the local admin host, if you have installed Arc on a separate computer to the TM1 server you will need to edit settings.yaml and change the admin host URL. 5898 is the default port for the TM1 admin host REST API.

If you are having problems accessing the admin host check the Windows firewall and see that you can access the admin host by using your web browser and the following URL: https://servername:5898/api/v1/Servers (replace servername with your TM1 server)

NOTE: After changing the settings restart Arc by closing the command line window and then double-clicking on Arc again.