You can execute the CATIA FLXML Exporter plugin by using the command line interface both on the server and on the client machine.
Important
- Before starting, learn how to run modeling tools and plugins by using the command line.
- When running the CATIA FLFML Exporter plugin in the command line, follow the recommended usage of the plugin described above. Any other usage of the plugin must be avoided
- Before starting, you must study the model and find out what data you want to export to an FLXML file.
Each client can have a different configuration (e.g., Windows, Linux, etc.), so the execution of the plugin should be adapted to the client configuration.
To run the plugin and export model data to an FLXML file by using the command line
- Download the generate_flxml.properties file.
- In the generate_flxml.proprties file, specify project and export-related properties.
Run the CATIA FLXML Exporter plugin and export model data in one of the following ways:
Download and execute the script_commandline.bat script.
Executing the script_comandline.bat script
Before executing the script, make sure to replace the placeholders between <> with the actual values for the following properties:
- %MAGICDRAW_HOME% - specify the path to the modeling tool installation directory.
- properties - specify the path to the generate_flxml.properties file.
Implement the com.nomagic.magicdraw.commandline.CommandLineAction interface as described in Running programs in batch mode.
The CATIA FLXML Exporter plugin options
To export model data to an FLXML file by using the command line interface you have to specify the following properties in the generate_flxml.properties file.
| Property | Mandatory | Description |
|---|---|---|
| project | Yes | Specify the path to the project you want to use to generate an FLXML file, e.g., e:\\data\\Aircraft Avionic.mdzip |
| schema | Yes | Specify the RFLP schema used to convert model elements to FL objects during export. You can use the default RFLP schema - SysML to FL or specify a custom schema. |
| destination_folder | Yes | Specify the path to the folder where the FLXML file should be saved. If the folder does not exist, it will be created during file generation. |
| scope_elements | Yes | Specify the list of elements to be exported to an FLXML file. Separate each element by a semicolon (;). Elements can be specified as:
Example: White box::Logical architecture::Logical architecture;id:_19_0_1_1a800cf_1559826887570_81532_41786;id:_19_0_1_1a800cf_1559826887379_499848_41443 |
| no_flxml_if_error | No | Set to true (the default value) for the command line execution to stop automatically if an error occurs while generating an FLXML file. In addition, the error text will be displayed in the console. Set to false to generate the FLXM file even if any generation errors occur. |
| log_results | No | Set to true if you want to generate a file with model data export results. The file includes export errors and both converted and not converted objects. It is saved in the same directory as the generated FLXML file. Otherwise, set to false (the default value). |
| log_format | No | The log_format property is only valid if the log_results property is set to true. Specify the file format for the model data export results (the log_results property). The possible values are:
|
| log_info | No | The log_info property is only valid if the log_results property is set to true. Set to true (the default value) if you do not want the annotations of converted and not converted objects to be included in the model data export results (the log_results property). Otherwise, set to false. |
| option_auto_ports | No | Set to true to automatically generate interfaces in the FLXML file if ports or pins do not exist in the UML/SysML model. Otherwise, set to false (the default value). |
| option_escalated_links | No | Set to true to generate and manage the escalated link. Otherwise, set to false (the default option). |
| option_reference_out_of_scope_elements | No | Set to true (the default value) to automatically manage the references to elements located outside of the model data export scope (the scope_elements property). Otherwise, set to false. |
| option_dependecy_relationships | No | Set to true to automatically discover dependency relationships for each element (can be time-consuming). Otherwise, set to false (the default value). |
| option_create_top_refref_implement_links | No | Set to true to automatically create REF-REF implement links for an OCC-OCC link if the REF-REF implement links do not exist. Otherwise, set to false (the default value). |
option_manage_effectivity | No | Set to true to generate effectivity files and a modified FLXML file to support effectivity. Otherwise, set to false (the default value). |
| option_export_image_for_diagrams | No | Set to true to generate images for symbol diagrams that you can later import to the 3DEXPERIENCE platform. Otherwise, set to false (the default value). |
option_flxml_preview | No | Set to true (the default value) to generate an RFLXML file to be imported to the CATIA Systems Traceability in the 3DEXPERIENCE platform. Otherwise, set to false. |
| option_export_element_image | No | Set to true to generate images for FL references of the elements with the «CustomImageHolder» stereotype. Otherwise, set to false (the default value). |
| import_xml_file | No | Specify the path to the file that defines the XMLModel used by CATFLEditorImportBatch. This will allow you to modify XmlPath (and ImagePath if required). For more information about the file, see https://dsdoc.dsone.3ds.com/3DEXPERIENCER2021x/en/English/DSDocDSExa.htm?show=SadUserMap/fle-r-BatchForImportExport.htm&XMLToc=DSDocDS.xml&contextscope=onpremise |