Create the custom properties to the SmartPlant Foundation authoring schema - Integration - Update 44 - Help - Hexagon

Create and add a new schema file to a configuration file

1. Open the SmartPlant Schema Editor without opening any existing configuration or schema files.

2. Click File > New > Schema File.

   You can also click the New button above the Schema File button in the Workflows dialog box to create a schema extensions file.

3. In the New Schema File dialog box, define the name and location for your schema extension file, and then click Save.

   For this example, save the file as Schema_EFCustom.

4. Close and reopen the Schema Editor.

5. In Schema Editor, click File > File Configurations > Open Configuration to open the configuration file that includes the delivered schema files on which you want to build your custom schema extensions.

6. Click File > Open > Another Schema File. Browse to the newly created schema file, Schema_EFCustom, and click Open.

7. Click File > File Configurations > Edit Configuration. The Edit Configuration dialog box appears.

8. Using the check boxes in the last column on the right, choose the delivered schema files on which the new file will be dependent.

9. In the Active schema file box, select the custom extension file.

10. In the last row of the table, find the custom extension file and make sure the value in the Editable? column is Yes. If the value is No, click the cell to switch the value to Yes.

11. Switch the values in other cells in the Editable? column as necessary to ensure they are all set to No.

    

12. Close the Edit Configuration dialog box.

13. Click File > File Configurations > Save As Configuration to create a new configuration file that will provide the working environment for you to create custom schema objects.

    Do not click Save Configuration as this will replace the delivered configuration file.

    When prompted, be sure to save the changes made to the custom extension file. Information saved in the configuration file includes a list of the editable files and the name of the active file, but file dependency information is saved in the extension file.

It is best to save the .cfg and schema file to your own custom directory. This means that the relative paths in the .cfg file will no longer point to the delivered schema files. Open the configuration file in a text editing application, and replace the relative paths with full paths.

The following image is an example of a .cfg file.

Create the custom document properties

1. From the Schema Editor window, click View > Schema All.

2. From the tree, expand InterfaceDef > ISPFDocument > Exposed Property Definitions.

3. Right-click the Exposed Property Definitions node, and click Add/delete ExposedPropertyDefs relationships.

4. Click New on the Possible ExposedPropertyDefs for ISPFDocument dialog box.

5. In the New Property Definition window, type DocGrade in Name box.

   Make sure you provide the same name for the custom property as you used when you added the custom property to the SmartPlant Schema.

6. Type the DocGrade in the Display name box.

7. For a Scoped by property type, choose string.

8. Click OK.

9. Use the same steps to add the DocNote custom property to the ISPFDocument interface definition.

   

10. Click Tools > Schema > Validate > Display Results to validate the schema.

11. Click File > Save As and save the file extension, Schema_EFCustom.

12. Close the schema editor.

Schema Editor creates the UID of a property based on the name value. To maintain unique UIDs when you create properties with the same name, you must edit the Schema_EFCustom file manually to change the UIDs of the custom properties and ensure that they are unique.