Set up occurrence properties for indexing

To enable users to filter structures based on occurrence-related information, you must configure specific properties for indexing. Smart Discovery supports the indexing of:

• Occurrence notes
• Properties of the PSOccurrence business object, including Integer, String, Array, Typed Reference, Compound, Float, and Boolean types.
• Properties of the Fnd0AbstractOccAttrs business object, including Integer, String, Array, Typed Reference, Float, and Boolean types.

Smart Discovery indexes the occurrence properties:

• That are explicitly marked for indexing and filtering.
• That support absocc override are also supported for indexing and filtering.

Smart Discovery indexes the configured runtime properties for PSOccurrence, Occurrence notes, and Fnd0AbstractOccAttrs.

Note: The runtime properties are not supported for Smart Discovery Indexing.

The configured properties appear on the BOM line in the following formats:

Object name	Example of a property	Format of the configured runtime property on BOM line
PSOccurrence	seq_no	bl_occ_<PropertyName> (e.g. bl_occ_seq_no)
Occurrence notes	AIE_Exported	AIE_Exported
Sdt0OccAttrs (sub-class of Fnd0AbstractOccAttrs)	occ_prop1	bl_occ_<Object_Name>_<PropertyName> (e.g. bl_occ_Sdt0OccAttrs_occ_prop1)

Procedure

1. Launch Business Modeler IDE (BMIDE).

2. Open an existing BMIDE template project or create a new one, for example, a5occurrenceproperties. Ensure that aws2 and activeworkspacebom are selected as the dependent templates.

3. Set up required properties for indexing:

   For occurrence notes:

   • Click Extensions > Options > List of Note Types to view the list of available occurrence notes.
   • Locate the BOMLine business object, and verify that the occurrence note that you want to index is listed as one of the properties of BOMLine. You will later map these properties with the Awb0Element and its sub-classes.

   For PSOccurrence properties:

   • Go to the Properties tab of PSOccurrence, and verify that the property you want to index is available here. If it is not there, you can add a new Persistent or Compound property.

     Note: You cannot set a property of the type Array for indexing if the Teamcenter version is 13.2 or lower.

   • The newly added properties are automatically added to BOMLine.

   For Fnd0AbstractOccAttrs properties:

   • Create a child business object under Fnd0AbstractOccAttrs.
   • In the Properties tab of the newly created child business object, create Persistent properties.
   • The newly added properties are automatically added to BOMLine.

4. Map the BOMLine properties to a subclass of Awb0Element:

   By default, the subclass Awb0DesignElement is already marked as indexable. To map the BOMLine properties to a subclass other than Awb0DesignElement, open the subclass and set the values of the following business object constants:

   Business object constant	Value
   Awb0BOMToOccurrence	BOMLine
   Awp0SearchIsIndexed	true

   To map a BOMLine property with Awb0DesignElement (the same steps apply for other subclasses of Awb0Element):

   • In the Properties tab of BOMLine, select the property, and click Map Property.

     The BOMLine business object is a runtime business object and the Properties tab of the BOMLine business object displays the runtime configured properties. Thus, the Awb0Element business object and its subclasses also show the configured property names.

     Properties of the PSOccurrence business object are prefixed with bl_occ_ on the Properties tabs of the BOMLine, Awb0Element, and its subclasses. For example, if seq_no is the property name of the PSOccurrence business object, it displays as bl_occ_seq_no.

     Properties of the Fnd0AbstractOccAttrs business object and its sub-classes are shown as bl_occ_<business object name>_<property name>.

     Example: if fnd0SkipAlignment is the property name of Fnd0OccAlignmentAttrs (a sub-class of Fnd0AbstractOccAttrs), the display name is bl_occ_Fnd0OccAlignmentAttrs_fnd0SkipAlignment.

   • In Map To Type, select Awb0DesignElement.

   • Click OK, then click Finish.

   • Open Awb0DesignElement and in the Property Constants tab, set the following values:

     Property constant	Value
     Awb0StructureCanFilter	true
     Awp0SearchIsIndexed	true
     Awp0SearchFilterPriority	Integer (lower value = higher precedence, displayed higher on the Filter panel)

   • OR — manually add the configured runtime properties of BOMLine (for occurrence note, PSOccurrence property, or a property of a subclass of Fnd0AbstractOccAttr) as runtime properties of Awb0DesignElement. Select each property, go to its Property Constants tab, and set:

     Property constant	Value
     Awb0BOMToOccurrence	Name of the configured runtime property of BOMLine
     Awb0StructureCanFilter	true
     Awp0SearchIsIndexed	true

   • To index Typed Reference properties of PSOccurrence or a subclass of Fnd0AbstractOccAttrs, select each such property in the target business object (e.g. Awb0DesignElement) and set:

     Property constant	Value
     Awb0BOMToOccurrence	Name of the selected configured runtime property of BOMLine (e.g. bl_occ_occ_type for occ_type)
     Awb0StructureCanFilter	true
     Awp0SearchIsIndexed	true
     Awp0SearchPropFromRefType	Name of the property on the referenced type business object to index (e.g. name on PSOccurrenceType)
     Awp0SearchRefTypeNames	Name of the referenced type business object (e.g. PSOccurrenceType)

     You can only include first-level persistent properties of PSOccurrence that are directly located under Typed Reference. If a property is flagged for localization, the Filter panel displays the data of the master locale even if the user is logged on using a different locale.

5. Click BMIDE > Save Data Model.

6. Click BMIDE > Generate Software Package. Make a note of the path in Target folder.

7. Navigate to the folder on your computer where you have installed Teamcenter, and launch TEM.

8. Click Next until you reach the Features panel.

9. Click Browse and navigate to the location of the Target folder noted earlier.

10. Select the custom template under Extensions, for example, a5occurrenceproperties. Additionally, select Extensions > Occurrence Attribute Object in the Features panel.

11. To deploy the changes, run the bmide_modeltool utility:

    bmide_modeltool -u=admin_user_name -p|-pf=admin_user_password -g=dba -tool=all -mode=install -target_dir=TC_DATA

12. Click Next until you reach the Confirmation panel and then click Start.

13. Update and merge the schema file.

14. By default, users cannot view the values of the indexed occurrences in the Filter panel for any structure element they do not have read access to. This is because the default value of the QSEARCH_enable_access_check_for_occurrence preference is True. If you want users to view the values even when they do not have read access to the structure element, change the value of the preference to False.

15. If you want to index the custom queries, type them in the QSEARCH_products_to_index_saved_queries preference. You must also ensure that the User Entry L10N Key and User Entry Name fields are empty when you build the custom query.

16. Run TC_ROOT/TcFTSIndexer/bin/runTcFTSIndexer -task=discovery:sync. This step can take time depending on the size of the database.

17. Restart all the required services to launch Active Workspace.

18. On Active Workspace, search for a structure that is already indexed using Smart Discovery (it has an indicator next to it). Click Filter and verify if the newly added runtime property is displayed on the Filter panel. If the properties are not listed, follow the troubleshooting steps to fix the issue.

Note: If no structures are indexed yet, first create the Smart Discovery index and then set up the recurring task to update the index.

At this point, you can choose to set the item revision properties for indexing, if not already set, after which you can close BMIDE.