Admin - Managing your Models

Creating Models

There are two main types of models that QUBEdocs Cloud offers: the File based model and the API based model.

With File based models, a metadata package (called "QDPackage") will be generated in your environment and provided to QUBEdocs Cloud to generate your documentation. There are two ways to use File models, manually or via a File API token. Please see these articles for more information:

• Connecting QUBEdocs Cloud to PA / TM1 Local (File Models - Manual Upload)
  
  
• Connecting QUBEdocs Cloud to PA / TM1 Local (File Models - File API Token Upload)

With API based models, QUBEdocs Cloud will connect directly to your model to read the information it needs to generate your documentation. Please see this article for more information:

• Using the Planning Analytics REST API

Editing Model Settings

Click on the options button in the top-right corner of your model, and select "Edit Settings"

Here a menu will appear that provides access to some advanced settings including options for modifying your model settings, building customer mapping rules for environment diagrams, generating an API key for pushing metadata files up to the QUBEdocs Cloud servers and advanced settings for object types to include or exclude from your snapshots. 

 

Deleting Models

On the QUBEdocs home page, on the Models tab, select the "view" dropdown and select "model details".

From here, you'll see a list of each of your models with a pencil button to edit, as well as a trash can button to delete the model

Warning!  Deleting a model will also delete all snapshots related to that model. Deleted snapshots can not be recovered.  You will receive a pop-up warning to confirm deletion to avoid any accidental deletions.