Creating a File Connection and your First Set of Documentation
With QUBEdocs Cloud, you can use a file based connection to connect your on premise TM1 or PA model. With this method a metadata package is created on your server that can be uploaded to QUBEdocs Cloud to generate the QUBEdocs documentation. The package can be uploaded manually or based on a schedule with the QUBEdocs API (or File API Token).
The process for manual uploads is outlined below (to see how to upload documentation via the File API Token method, please see this article).
Step 1: Login into QUBEdocs
Login to QUBEdocs 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.
Step 2: Set up a connection to your model
Simply click on the "Connect a New Model" tile in the main page and fill out the model details.
For a file based connection select "File" for the connection type to connect to both on-premise or cloud based PA / TM1 instances. Once selected you will need to give the connection a name, description and specify which environment the connection is for (production or non-production etc).
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.
A metadata package called "QDPackage.7z" will be generated in the directory specified above.
Step 5: Generate the Documentation
Click on the drop down menu on the right hand side of the connection.
For manual file uploads:
- Select "Upload Metadata Package"
- The next step discusses how to create the metadata package (which would have already been created in the previous step):
- Navigate to the QDPackage.7z that you have created:
- Documentation will begin generating:
Once generated you will be able to browse the documentation version by selecting "View Documentation" from the model tile.