Creating, Managing and Deploying Knowledge Applications Resources Using RADE Tools and SCM

This section describes the recommended methodology.

We assume that:
  • A CATIA version (install, download, release source) is located in a <CATIA_folder> folder, where <CATIA_folder> may be:
    • c:\Program Files\Dassault Systemes\V5R16
    • e:\users\yyy\Download\server\CXR16
    •  \\server\CXR16.
  • The architect builds only one application.

When working with SCM, you have to create a Buildtime view that is managed by SCM and a Runtime view to open CATIA. CATIA cannot be started from the Buildtime view and SCM cannot deal with files stored in the Runtime view. So both views have to be split.

Creating the Application

The very first thing to do consists in creating a CAA workspace whose structure is identical to the one shown below.

  1. Create the Buildtime view manually. It must be identical to the view below.

    A Buildtime view is a workspace containing frameworks including code modules and CNext directories.
    The RADE tool to be used at this stage is SCM. SCM integration consists for the application architect in locating the resource at the right place in the framework directory, and in checking in and checking out the files.
    Files like CATScript, CATGScript, CATNls can be checked-out concurrently by several users because it is possible to merge the information. Other objects (CATPart, .catalog for example) cannot be automatically merged. As a consequence, they cannot be concurrently checked out. The conflicts will have to be managed outside the tool. To share the application with other users, the architect promotes his work to its father workspace or publishes his work to his children workspaces.
  2. From the Start menu, select Programs>CATIA>Tools>Environment Editor V5R16.

  3. Select Environment>New from....

  4. Check Add a new path to this environment and enter a new path in the NewPath field.

  5. Enter the name of the application you want to create and click OK when done.

  6. Valuate the CATKnowledgeBuildPath setting with the path of the "knowledge" directory of your Buildtime view.

    • Select Tools > Options. The Options dialog box is displayed.
    • Choose the General category in the left-hand box. Click the Parameters and measure  category.
    • Click the Knowledge Environment tab and select the desired directory in the Architect Resources Creation Path field.
      Note that:
      • This setting value can be modified several times during a CATIA session, so that you can create/modify resources in all frameworks of your workspace without restarting CATIA.
      • If you use SCM, all modifications of files belonging to the Buildtime part (code and resources) are managed by SCM, so that concurrent engineering is supported.
  7. Create the Runtime view. To do so, copy the CNext directory located in the Buildtime view into the <OS> directory of the Runtime view. The structure must be identical to the one below.

    Note that you can copy the CNext directory anywhere if this location is known by the environment, that is to say, provided you set the CATKnowledgePath environment variable properly.
    The RADE tool to be used at this stage is MAB. Use the mkrtv command then the mkGetPreq command (mkGetPreq -p <CATIA_folder>\BSF) to create the link between your code and CATIA code. The structure must be identical to the view above.
    • If the architect who creates and modifies an application needs to create, access, and modify resources during a CATIA session and wants its creations/modifications to be taken into account during the CATIA session, the resources must be located in the Runtime view.
    • If the architect wants its creations/modifications to be taken into account during the application delivery and wants to manage concurrent engineering of those resources (using SCM), the resources have to be located in the Buildtime view. So, the architect must create and modify its resources in his Buildtime view and not in the directories designated by the  CATKnowledgePath environment variable, then quit CATIA, run the mkrtv command and restart CATIA to see his modifications.
    Note that .CATfct, icons, and .CATnls files are not located in the CATKnowledgePath environment variable. So, when working with these files, you must use the mkrtv command so that your changes are taken into account.

Deploying the Application

  1. The administrator installs the CATIA version he used to develop his application on all client computers or on a server.

  2. The administrator copies the <OS> (directories structure and content), and more generally, the whole Runtime view of his directories structure on the client computer or on a server.

  3. The administrator sets the required variables:

    • If he copies the content ("code"/"resources"/ directories) of the <OS> structure under the corresponding <CATIA_folder>\<OS>, he won't have to modify any environment variable since the copied data is located in the directory known by CATIA.
    • If he copies the Runtime directories and structure at a location that is not known by CATIA, he has to set up his environment i.e. modify the content of some environment variables (CATMsgCatalogPath, CATKnowledgePath, CATGraphicPath, CATStartupPath...). To do so, he can:

      • Use the New From... command in the CATIA Environment Editor. In this case, a new path will be added before or after all variables depending on the selected option.
      • Use the New command in the CATIA Environment Editor. In this case, he must select the variables to which he wants to add a new path.
      For more information about the CATIA Environment Editor, see CATIA Infrastructure Installation Guide: Administering Version 5: Customizing Your Environment on Windows. For more information about these variables, see About the Knowledge Environment Variables and Settings.
  4. The administrator empties and locks the CATKnowledgeBuildPath setting on the client install. For more information about the way to lock settings, see CATIA Infrastructure Installation Guide: Administering Version 5: Locking Settings. The targeted user will access all knowledge resources i.e. CATIA native ones and the new deployed application resources.