IBM have started requiring that you use SFTP to manage files, if your instance does not support FTPS we recommend that you use the new Planning Analytics REST API connector.
With QUBEdocs Cloud, you can use a FTPS based connection to connect to your TM1 or PA Cloud model. With this method a metadata package is created that is uploaded to QUBEdocs Cloud over FTPS in order to generate the QUBEdocs documentation. The generation can also be scheduled to ensure that the documentation is always up to date. The process to do this is outlined below.
Step 1: Login into QUBEdocs
Login to QUBEdocs Cloud using the credentials that you registered the account with. Note that when you register for the first time you will automatically receive a 14 day free trial which will enable you to generate documentation for one Planning Analytics or TM1 model.
To connect to your model you can either setup a file or FTPS based connection.
Step 2: Set up a FTPS connection to your model
Simply click on the "Connect a New Model" tile in the main page and fill out the model details.
When prompted, select "FTPS" as the connection type and enter the remote FTPS path and credentials to your PA/TM1 model file share.
The remote path will be in the following format: ftps://<PA server name>:<port>/<relative path to model>.
(QUBEdocs Cloud currently supports Port 21 for FTPS connections. Contact QUBEdocs Support if you have different port requirements)
The file share details will be included in the IBM PA Welcome Pack or additional credentials can be requested through IBM support.
The connection will not validate successfully until the "Setup TM1 model" step has been completed.
The "Scheduled" option does not need to be selected at this stage. A schedule can be defined later by editing the connection once the documentation has been generated successfully for the first time.
We recommend setting the schedule to weekly and setting a time when your TM1 server is not in high demand.
Step 3: Setup PA/TM1 to work with QUBEdocs
Select "Setup TM1 server" from the connections settings menu or the profile menu and follow the instructions. This will direct you to download and deploy the TM1 files into your environment. Follow the steps in the wizard to download and configure your TM1 server.
Following the wizard instructions will result in you successfully installing the QUBEdocs Package Creator into your TM1 environment.
Step 4: Run the QUBEdocs Create Package Process
The process QUBEdocs Create Package will be installed as part of the QUBEdocs Package Creator. Navigate to the process in your TM1 instance. Right click and Run the process.
You will need to enter a location for the package to export to. If you enter .\ , it will export into the data directory.
Step 5: Generate the Documentation
Click on the drop down menu on the right hand side of the connection and select the "Upload Metadata Package" option. You will be prompted with instructions on how to generate / refresh and upload your PA / TM1 metadata package. Once generated you will be able to browse the documentation version by selecting "View Documentation" from the model tile.
Step 6: Schedule a Regular Model Refresh
IMPORTANT: If you are wanting to refresh the documentation frequently you will need to setup a chore to automatically refresh the QUBEdocs package based on a schedule.
Please follow the instructions below if you wish to use this feature.
1. Create a TM1 chore and schedule the QUBEdocs Package Creator process within.
2. Include the as the ".\" as the parameter value so that the package is written directly to the data directory.
3. Select a time period and a date from which you want the chore to begin. Ensure you have clicked Activate Chore, and click Finish.
Note: You will want to ensure that this chore is completely executed well before the time that you used in the FTPS schedule in step 2.
If you did not set a time for the scheduled refresh to take place, please navigate to QUBEdocs Cloud. Select the options symbol in the top right corner of the model you have been generating documentation for.
Click the menu dropdown and select Edit Settings. Enter the schedule details that you wish and click Save. Please ensure that the scheduled time is set at least 10 minutes after the chore has run.
You have now successfully set up your QUBEdocs Cloud connection to generate documentation from your model, automatically at your chosen times.