Adding Business Object Types

When you add a new type to your database, you need to update the CloudView server index with this new type. This is done by adding the business object type to the config.xml file and running the update searchindex MQL command.

Before you begin:
  • Add the new type to your database using MQL. For more information, see the MQL Guide.
  • Open your working config.xml file (or the file to use for the indexing process). The default config.xml file is in SERVER_INSTALL\Apps\BusinessProcessServices\VERSION\Modules\ENOFramework\AppInstall\Programs.
  • Review Config.xml Parameters for information on the different parameters used in the file.
See Also
About the Index Configuration File
Adding Applications
Adding Business Types Files and File Extensions
Adding Attributes to a Business Object Type
Using Aggregation Rules
Reference Information: MQL Indexing Commands
  1. To add a new business object type, add a BOTYPE parameter to the config.xml file.

    For example, to add the Shipping Form, enter: 

    <BOTYPE name="Shipping Form"/>

  2. Optional: To define the fields (BOTYPEFIELDS parameter) to index for this business object type, add an includes parameter.

    For example, to index the fields belonging to documentfields for Shipping Form: 

    <BOTYPE name="Shipping Form" includes="documentfields"/>
<BOTYPEFIELDS name="documentfields">
  <FIELD name="LABEL_TYPE" select="attribute[labeltype]" type="STRING,PARAMETRIC"/>
</BOTYPEFIELDS>
    Note: If no BOTYPEFIELDS has been specified for a BOTYPE, all BOTYPEFIELDS listed in config.xml are indexed for that BOTYPE.

  3. Optional: To specify that the BOTYPE must include all the BOTYPEFIELDS of the parent BOTYPE, add the inheritfields parameter to the BOTYPE parameter:

    Parameter setting Description
    true The BOTYPE includes all fields for its parent BOTYPE.
    • If the parent also sets inheritfields="true", then the BOTYPE also includes the fields for that parent's parent.
    • The BOTYPE inherits the fields included for the first parent BOTYPE that does not define the inheritfields attribute or sets the inheritfields attribute to false
    • The inheritfields attribute only works for BOTYPEFIELDS and does not change any excludetypes, excludepolicies, or excludestates definitions.
    false The BOTYPE does not include the BOTYPEFIELDS included on the parent.
    Not defined The BOTYPE does not include any BOTYPEFIELDS included on the parent.

  4. Using MQL, set the context and apply the config.xml file.

    For more information, see Applying configuration.

  5. Run the update searchindex command in MQL to update the index with the new business object type.

    For example, to update the index with the type "Shipping Form", run: 

    update searchindex type 'Shipping Form';

  6. Register the new type in Business Process Services.

    For more information, see Installation and Setup | 3DEXPERIENCE Platform | 3DEXPERIENCE Platform Administration | 3DSpace | Collaboration and Approvals | Adminstrative Utilities | Property Registration | Working with Administrative Properties | Registering Your Own Administrative Objects.

  7. Reload the cache in the Search UI to read in the new config.xml file.
  8. Launch the Search page to see the new field.