Welcome to this short "Getting Started" guide. In a few simple steps you have OCTO up and running.
The setup contains the following steps:
- Install the TD/OMS OCTO Rest Server on your IBM i
- Create an OCTO account
- Create an Organization
- Create an OCTO TD/OMS Perspective
- Configure OCTO to talk to your IBM i
- Explore the Work Management View
Install, configure and start the REST server
In order to open the TD/OMS database, the TD/OMS OCTO REST Server must be installed. Sit with your system administrator and let them execute the following command which can be found in the TD/OMS library.
Configure for HTTPS (SECURE):
- CFGRESTSRV ACTC(*ADD) SSLPORT(45111) SSLAPP(SSL_APP_NAME_HERE) TRGLIB(TDOMS) LIBL(TDOMS)
Configure for HTTP (INSECURE):
- CFGRESTSRV ACTC(*ADD) SSL(*NO) TRGLIB(TDOMS) LIBL(TDOMS)
This will create an Apache configuration file in the /var/www/tdoms directory. You can change the config file to fine tune the web server.
Start the Server
Start the server with:
- STRTCPSVR SERVER(*HTTP) HTTPSVR(TDOMS)
Finally check if TD/OMS server is running by visiting the page with HTTPS or HTTP:
Create an OCTO account
To create an OCTO account, head over to https://octo.remainsoftware.com and register for an account.
The account should conform to the following:
- A user with the given email may not already exist.
- The password length must be at least 10. It must contain a capital letter, a number and a symbol
After the account has been created, you will receive an email with the link confirmation. It should arrive in your inbox, but when it takes too long, please also check your spam box.
Create an Organization
An organization is where everybody from your company works in. So a good name for a organization is your company name. Make sure to make it one word with just letters and numbers.
After an organization is created, you can invite people to join your organization. An organization's User Interface only needs to be set-up once. After that everybody in your organization can use Octo web without having to configure anything.
After logging into Octo, you can find the 'New Organization' button in the toolbar.
After you have added your organization, click on the organization name to open it. This is the URL you want to bookmark!
Create a Workspace
A workspace is a set of related information panels. Sometimes you want to create a multi-panel workspace (like in an IDE) and sometimes you want to make a a single information panel (e.g., for a dashboard or a Kanban board).
Now we will create a Workspace to host the TD/OMS panels.
First click the 'Create a Workspace ...' link in the middle of the screen and then:
- Provide the workspace name
- Select 'Multiple sections layout'
- Select 'Organization' (it means everyone in your organization can access it)
- Press Create.
Install plug-ins
We can install plug-ins in each of the sections that appears. We will install the 'Work Management' plug-in in the leftmost panel.
To open the Plug-in store, click on the 'Install plugin...' link on the left:
- Type 'work' to filter the Work Management plug-in
- Click on 'Install' to install the plug-in
Install other plug-ins
Please go ahead and install the following plug-ins in their respective locations
- in the middle, install the source editor plug-in
- on the right, install the item editor plug-in
- in the bottom install the 'Components' plug-in
You can stack additional plug-ins by pressing the boxed plus button in the toolbar
Creating a configuration
Now we want to create a configuration that points to the rest server that we made in the first step. This will allow Octo to communicate with TD/OMS.
To do this, hover over the Work Management plug-in until the toolbar appears. The press the settings icon to make a new configuration.
On the panel that appears enter the following information:
- Press the 'New Configuration' icon
- The description of the machine
- The URL to your IBM i with the port and the TDOMS library
- Set as 'Default configuration'
- Press Save
You are now able to logon to the IBM i with your user name and password.
Explore the Work Management View
After logging in, you should see a list of your open tasks. You can try the following.
- Select an Application from the Application drop down list
- Use the filter to filter for the task you want to see
After you see a list of tasks. Press any task to open the item editor on the right side. (1)
Open a Source Editor
In the Item Editor plug-in, select any object with a source to open the editor. You will also notice that the Components editor is populated with your objects.
Troubleshooting
No SSL certificate on the IBM i
Out of the box, Octo can only communicate with HTTPS back-ends. If you do not have a certificate on your IBM i, you should get one.
If you want to keep using HTTP then you have to tell your browser. How this is done is explained here.
Self-signed certificate on the IBM i
Browsers do not accept self-signed certificates out of the box. In order to trust the SSL certificate you can open the https URL in a separate browser page and the use the normal 'Accept the Risk and continue' dialog.