Create a new configuration file and extension file for the authoring schema - SmartPlant Foundation - IM Update 46 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

The following steps explain how to create a new extension file in which to store your custom schema objects for the authoring schema and how to create a custom configuration file for managing the extension file. In addition, the procedure also provides details about creating a custom copy of a delivered file for editing with your customizations.

  1. Find the SCHEMA_MTRSPONonIntegration.xml file delivered at Smart Community. For more information, see Find sample data on Smart Community.

  2. Copy the SCHEMA_MTRSPONonIntegration.xml file and place it in your customization folder with the other files you have created as part of this process. .

    SHARED Tip Do not rename the file, but make sure that it is editable and not read-only.

  3. To create a new configuration file to manage your customizations, find the MTRSchema.cfg configuration file delivered at Smart Community. For more information, see Find sample data on Smart Community. .

  4. Create a copy of the MTRSchema.cfg file and give it a unique name, such as AcmeSchema.cfg. Save the file to your customization folder.

  5. To make sure that the new configuration file is editable and not read-only, right-click it, and click Properties.

  6. Clear the Read Only check box, and click OK.

  7. Right-click the new configuration file, and open it with a text editor, such as Notepad.

  8. Update the path for the SCHEMA_MTRSPONonIntegration.xml file to point to the copy you created at the beginning of this procedure in your customization folder.

    SHARED Tip You can use a relative path if both files are located in the same folder. Otherwise, use an absolute path to the file.

  9. Check the other paths listed in the file to make sure they are correct. By default, it assumes all files that have an absolute path are delivered under the C:\Program Files (x86) directory. If you installed the files in a different location, these paths must be updated.

  10. For files with relative paths, update the paths to the correct absolute paths.

    Do not to change the "AS" prefix or the "!N" suffix for lines when editing them.

  11. Save your changes and close the text editor.

  12. Right-click the configuration file again, and this time open the file in the SmartPlant Schema Editor.

  13. Click File > Open > Another Schema File.

  14. In the Another Schema File dialog box, browse to your customization folder that contains the integration customization file you created. In this example, the file was named SCHEMA_AcmeIntegration.xml.

  15. Click File > New > Another Schema File.

  16. In the Another Schema File dialog box, browse to your customization folder.

  17. Create a new file with a file name that indicates that the file will contain custom non-integration schema objects, such as SCHEMA_AcmeNonIntegration.xml.

    SHARED Tip Place this new XML file in your customization folder with the other files you have created as part of this process.

  18. In the Set Container Dependencies dialog box, select the following files:

    • SCHEMA_MTRSPONonIntegration.xml

    • SCHEMA_EFSchema.xml

    • SCHEMA_SPONonIntegrationForMTR.xml

    • The new XML file you created in the procedure Define a new custom property definition in the publish schema that contains the integration customizations. In this example, the file was named SCHEMA_AcmeIntegration.xml.

  19. Click OK.

  20. Click File > File Configuration > Save Configuration.

The new file is automatically set to be the active file in the .cfg file.