Administration Tasks: Installing 3D XML Modelica Libraries

When installing the Dymola Behavior Modeling app, administrators can import the 3D XML files containing the Modelica behavior libraries.

You can access numerous Modelica libraries with Dymola Behavior Modeling. Some are free to use, some need dedicated licenses. The main general library is the Modelica Standard Library provided. For a general list of all Modelica libraries available in the distribution, and some general information, see About Behavior Libraries.

The 3D XML files are by default located in two places:

  • Most of the libraries are located as "content media", for a list of these files see Modelica Libraries.
    Note: A 3D XML file can contain more than one library, for a full list of libraries see Modelica Libraries.
    Important: To be able to import these files, you must specify, in Me > Preferences > Common Preferences General > Cache and Performance, in the Content group, the Location as, typically C:\Program Files\Dassault Systemes\B424_Content\win_b64.

    Notes:
    • For Cloud installation, the B424_Content part of the file path must be changed to B424_Cloud_Content.
    • The path may differ depending on the installation and version.

  • The following 3D XML files are located in the "app media":
    Name of library 3D XML to be installed
    CATIAMultiBody CATIAMultiBody_*.3dxml
    CATIAPiping CATIAPiping_*.3dxml
    Optimization Optimization_*.3dxml
    SignalOperators SignalOperators_*.3dxml
    These files are stored in the app install repository, typically C:\Program Files\Dassault Systemes\B424\win_b64\resources\DBM_Libraries\3DXMLData. The first part of the file path, up to and including \B424\, may be different depending on installation and version. As an example, for Cloud installation, the B424_Content part of the file path must be changed to B424_Cloud_Content. The last part of the path is always the same.

Note: If you have 3D XML files of Modelica libraries stored in other locations than the above, you can specify these locations in Me > Preferences > App Preferences > 3D Modeling > Systems Modeling and Execution > Dymola Behavior Modeling , the Libraries tab, the preference Additional 3DXML´s location. For more information about this setting, see Libraries.

If you give a command from the action bar that is associated with a 3D XML file, and that file is not installed, the file is searched for. The search is done in the following locations, in that order:

  1. The paths specified in Additional 3DXML´s location above, if any.
  2. The path to the "app media", see the second item in the item list above.
  3. The path to the "content media", see the first item in the item list above.
Note: The search is not performed in any subfolder with name Deprecated.
If the file is found in any of these locations, it is automatically installed, as Reference.

The first time the Dymola Behavior Modeling app is started, the availability of the Modelica libraries in the database is checked. If the libraries are not found in the database, the command Import All Libraries is launched automatically. For more information, see Import All Libraries with a Command,
Tips:
  • To update installed libraries, the process is identical with installing them in the first place.
  • In a batch mode, do not forget to select the Import as Reference option. If you do not select this option, the imported libraries are duplicated.
  • Administrators must update the imported libraries every time a new version is installed. This ensures that users access the last version of these libraries.
  • For installing libraries for the app on the Cloud, see Installing Native Apps Using the Compass from the Cloud.
Important: For import of a library with external licensing, see Import a Modelica Library with External Licensing.

This task shows you how to:

Import a Single Library with a Command

You can import a single Modelica library using a command.

For more information about importing single 3D XML files using a command, see Exchange Management User´s Guide: Import: Import 3D XML: Importing 3D XML Files.

  1. From the top bar, select Add > Import.
  2. In the Import dialog box, from the Required section:
    1. From the Format list, select with authoring (*3dxml).
    2. Click Open the chooser to browse after the Filename field.
    3. In the Select a File dialog box, browse for the file, and click Open.
      • The file name appears in the Filename field.
      • The path appears in the Location field.
  3. In the Import dialog box, from the Options section, from the General tab, select As Reference.
  4. Click OK.
    • The library is imported.
    • The library opens in a new tab.
  5. Optional: If required you can change the maturity.

    The maturity status is included in the 3D XML file.

    For information how to change maturity, see Collaborative Lifecycle: Changing Maturity.

Import All Libraries with a Command

You can import all Modelica libraries, except deprecated libraries, using a command.

Note: The first time the Dymola Behavior Modeling app is started, the availability of the Modelica libraries in the database is checked. If the libraries are not found in the database, the command is automatically launched. This is also the case if the 3DEXPERIENCE settings are deleted, then the following start of Dymola Behavior Modeling is seen as a first start.

  1. From the Behavior Tools section of the action bar, click Import All .
    The Import All Libraries dialog box appears.
  2. To import all 3D XML files, click Import Files.

    Important: This is an administrator task.

    All the Modelica libraries are searched for in the same locations and order as specified above for a command from the action bar.

    Notes:
    • When a library is found in one of the locations above, the search is not performed in any location with lower priority.
    • The search is not performed in any subfolder with name Deprecated.
    • If a library is already imported, no action is performed for that library.
    • The libraries are imported As Reference, to keep the maturity specified in the 3D XML files.
    • The libraries are not opened.
  3. Optional: If required you can change the maturity.

    The maturity status is included in the 3D XML file.

    For information how to change maturity, see Collaborative Lifecycle: Changing Maturity.

Import with Batch

You can import a Modelica library using a batch.

Below a short instruction, assuming a correct batch parameter setup. If required, for details and for how to define batch parameters, see 3DEXPERIENCE Native Apps: Native Apps Common Services: Tools: Batches: Defining the Batch Parameters.

For more information about 3D XML import with batch, see also Exchange Management User´s Guide: Import: Import 3D XML: Running the Import 3D XML Batch.

  1. From the Tools section of the action bar, click Utility .
    The Batch Monitor appears.
    Tip: You can also open the Batch Monitor from the command line. See Native Apps Common Services: Tools: Batches: Accessing the Batch Monitor.
  2. In the Batch Monitor, double-click Import 3D XML file.
  3. In the Import 3D XML file dialog box:
    1. Browse for the Location where the 3d xml files reside.
    2. Enter the Filename, for example DymolaCommands_1_1.3dxml.
    3. Select the Import as Reference option.
    4. Optional: Click Save to save the selected options.
    5. Click Run to execute the batch.
    6. Optional: Click Open Main HTML Report to see the result of the import.

      You can define the name and location of the generated report.

    7. Close the Import 3D XML file dialog box.
  4. Close the Batch Monitor.
  5. Optional: If required you can change the maturity.

    The maturity status is included in the 3D XML file.

    For information how to change maturity, see Collaborative Lifecycle: Changing Maturity.

Check the Libraries Import

Once the library import is successfully completed, you can check that the Modelica library is imported only once and with the proper maturity level.

Before you begin: In this scenario, all libraries containing the name Modelica are checked.
  1. Open a session.
  2. In the Search field of the top bar, enter dbl:*Modelica* as a search string.

    Notes:
    • dbl is used for Dymola behavior library.
    • You can replace *Modelica* with the name of your Dymola behavior library.
    • The use of dbl:* to search for all libraries is not supported.

  3. Click Search .
    The Search Results panel is displayed, and lets you check that these libraries are properly imported.