Property constants

The following property constants are unique to Active Workspace: Awp0FilterPropFromRefType Applicable only when the property to be indexed is a reference type or a compound property whose source property is a form data file property. You can use the awp0MasterFormStorageClass compound property, available by default on all Master forms for ItemRevision and its subtypes, to index and filter the properties of the form. Specify a comma-separated list of properties that are a subset of the properties listed in the Awp0SearchPropFromRefType property constant. For example, you can set the following constants for the property constant reference type you want to filter: Awp0SearchIsIndexed Set the Boolean value to true to search on the property. Awp0SearchCanFilter Set the Boolean value to true to filter on the property. Awp0SearchPropFromRefType Enter the list of properties to index. Awp0FilterPropFromRefType Enter the list of properties to filter. Awp0SearchRefTypesNames Enter the referenced object type names. Awp0InboxCanFilter Indicates that tasks shown in the inbox can be filtered on a specific property of a workflow business object (EPMTask and its subtypes). The following example shows tasks found when selecting the Team tab. By default, the following properties are shown as filters for workflow business objects in the inbox: object_type – The type of object. due_date – The date the object is due. fnd0Assignee – The user to whom the task is assigned. fnd0Priority – The priority of the task. fnd0WorkflowInitiator – The user who initiated the workflow on the task. Awp0InboxFilterPriority Sets the priority of the property of a workflow business object (EPMTask and its subtypes). It determines the property’s order in the list of filters displayed in the inbox. The lower the value, the higher its priority and, therefore, the higher its position in the list of filters. Siemens Digital Industries Software recommends that you assign values from a range to accommodate additional properties in the future. For example, assign priorities such as 100, 200, and 300, instead of 1, 2, and 3. Awp0SearchCanFilter Indicates that the search results can be filtered on the specific property. It assumes that the property was marked for indexing using the Awp0SearchIsIndexed property constant. For the filters to show up correctly in the user interface, this property constant should be set for the property on its source business object. In a Multi-Site Collaboration environment, apply Awp0SearchCanFilter to published record objects so that they can be indexed using the POM_owning_site property. Awp0SearchFilterPriority Sets the priority of the property that determines its order in the list of filters displayed in the client—the lower the value, the higher the priority. This means that the filter is positioned higher in the list of filters shown in the filters panel. Siemens Digital Industries Software recommends that you assign values from a range in order to accommodate additional properties in the future. For example, assign priorities such as 100, 200, and 300, instead of 1, 2, and 3. For the filters to show up correctly in the user interface, this property constant should be set for the property on its source business object. When a Table type property is marked for filtering, all valid properties of the referenced TableRow type are available as filters. All the table row properties get the same filter priority, so they are displayed together, vertically listed in the filter pane. Awp0SearchIsIndexed Indicates that the property on the business object will be indexed for searching by the indexing engine. This information is propagated through the business object hierarchy. For example, if object_type on ItemRevision is marked for indexing, all business objects under ItemRevision (such as Part Revision and DocumentRevision) also have their object_type property indexed. The following constraints apply when indexing properties: Only attribute, compound, table, reference, and publication record properties can be indexed. Indexing of runtime and relation properties is not supported. For multi-site searching the POM_owning_site property can be indexed out of the box. Apply the Awp0SearchIsIndexed to published objects to enable indexing. To index compound properties, they must reference attribute properties from the source object. Note If the compound property value comes from a form, the compound property must use the form storage class in the property definition rather than the form itself, or indexing fails. To index reference properties, the Awp0SearchRefTypeNames and Awp0SearchPropFromRefType property constants must contain valid values. Table type property indexing is only supported for properties that reference Fnd0TableRow and its subtypes. Indexing is not supported for Fnd0NameValue and its subtypes. When a table type property is marked for indexing, all the valid properties of the referenced table row type are indexed. You do not need to mark individual table row properties. Incorrect values are omitted from indexing; no message appears. Awp0SearchPropFromRefType Applicable when the property to be indexed is a reference type or a compound property whose source property is a form data file property. You can use the awp0MasterFormStorageClass compound property, available by default on all Master forms for ItemRevision and subtypes, to index and filter the properties of the form. Specify a comma-separated list of properties that are on the business objects specified in the Awp0SearchRefTypeNames property constant. For example, on the owning_user reference property on ItemRevision, specify a value of user_id,user_name. The following rules apply: You can only specify attribute and compound properties. Note If the compound property value comes from a form, the compound property must use the form storage class in the property definition rather than the form itself, or indexing fails. Each property in the list specified for Awp0SearchPropFromRefType is matched against each business object in the list specified for the Awp0SearchRefTypeNames property constant. Only properties that are valid and applicable on a business object are considered for indexing. In addition, if filtering is enabled on the reference property, only the first property from the list is used. The first property in the list must be a string property. Incorrect values are omitted from indexing; no message appears. Awp0SearchRefTypeNames Applicable only when the property to be indexed is a reference type or a compound property whose source property is a form data file property. Specify a comma-separated list of business object names that the reference property can contain. For example, on the owning_user reference property on ItemRevision, specify a value of User. The following rules apply: If no value is specified on typed reference properties, the business object that is specified as the referenced type is used as the type. For example, release_status_list results in ReleaseStatus. On untyped reference properties, if no value is specified, the POM_object is used as the type. Incorrect values are omitted from indexing; no message appears. Cm1ChangeCanFilter Indicates that the changes in the Changes page can be filtered on a specific property of the change business object (ChangeItemRevision and its subtypes). The following example shows the changes found when clicking the Submitted tab. The default properties of a change object that can be filtered are: creation_date – The date the change was created. CMMaturity – The degree of completion of the overall change process (its Maturity). object_type – The type of change. cm0Analyst – The user assigned as the analyst. cm0ChangeSpecialist1 – The user assigned as the change specialist. cm0Requestor – The user who created the change. Cm1ChangeFilterPriority Sets the priority of the property of the change object (ChangeItemRevision and its subtypes). It determines the property’s order in the list of filters displayed in the Changes page. The lower the value, the higher its priority and, therefore, the higher its position in the list of filters. Siemens Digital Industries Software recommends that you assign values from a range to accommodate additional properties in the future. For example, assign priorities such as 100, 200, and 300, instead of 1, 2, and 3. Note Compound properties presume that the security level of the source property of the source object is read access. This is because the compound property belongs to the target object related to the source object through the compound property. For example, Object B has a compound property that is related to its source property on Object A. When Object B and its compound property are indexed, the indexer presumes that Object A has a security level of read access to everyone. That means that anyone with read access to the compound property of Object B could also find the source property on Object A, regardless of its security level. Enabling searching and filtering on referenced objects or forms Enable searching and filtering for a referenced object using a property value defined on the referenced object. You need to add or update the property constants for the property of the referenced object. In the first example, an ItemRevision object has a referenced Item object, where the description contains the value Example Text. In the Business Modeler IDE, find the template containing your object definitions, and find the ItemRevision object. On the property that references the Item object, add or update the following property constants: Awp0SearchIsIndexed Set the Boolean value to true to index this property. Awp0SearchRefTypesNames Set the referenced object type name, Item in this example. Awp0SearchPropFromRefType Set the list of properties on the referenced object type specified in Awp0SearchRefTypesNames. In this example, the property is description. To filter the search results by the preceding property values, add or update the following property constants: Awp0SearchCanFilter Set the Boolean value to true to filter on the property. Awp0FilterPropFromRefType Set the list of properties on the referenced object. In the example, the property is description. Awp0SearchFilterPriority This property constant is optional. You can set a numeric value for priority. The lower the value, the higher the priority. Example: Search properties of a related Master or custom form Enable searching and filtering using the properties of a related Master or custom form. You need to add or update the property constants for the property of the related form. By default, the awp0MasterFormStorageClass compound property is configured for ItemRevision. The compound property references the data file on the Master form for ItemRevision. An ItemRevision has a subtype Awp0TestItemRevision with a Master form Awp0TestItemRevisionMaster: The Master form has two properties: Awp0TestItemRevMasterS is the storage class name for the form. awp0MasterFormStorageClass is a compound property that references the data file of the Master form. Configure the Master form storage class property awp0MasterFormStorageClass with the property constants that enable indexing, searching, and filtering. Example: Search properties of an Item Master form Enable searching and filtering of an Item Master form using a compound property. You need to create a compound property on a persistent attribute of the Item Master data_file storage class. The compound property references the data file for the Master form of the Item. You need to create a compound property for every attribute you want to search. In the example, the compound property a2ItemMasterAttr1 is created on user_data1, which is a persistent attribute on the Item Master data_file storage class. Be sure to set the index, search and filter property constants on the new compound property.