Removing attributes from the outline template

Sterling™ Order Management System Software provides an ability to disable indexing of attributes in the application-provided entity XML definition.

By default, the commonly used searchable attributes in order and related entities are enabled for indexing. You must assess and consider to disable them from indexing, if your search and display requirements do not need these attributes. You can view the application-provided outline template from Index Management console in System Management Administrator or retrieve by using the getIndexStatus API.

You can disable the attributes from indexing and outline template by extending the entity and specifying Ignore="Y". For example, the OrderName attribute is enabled for indexing under the YFS_ORDER_HEADER entity in the application-provided XML entity XML definition. To remove it from the indexable attributes, extend the YFS_ORDER_HEADER entity and add the following:

<Entity TableName="YFS_ORDER_HEADER">
   <Attributes>
      <Attribute ColumnName="ORDER_NAME">
         <UsedForIndexing Ignore="Y" />
      </Attribute>
   </Attributes>
</Entity>

The DayPhone attribute of the YFS_PERSON_INFO entity is enabled for Order index. Extend the YFS_PERSON_INFO entity as follows to remove this attribute from Order index.

<Entity TableName="YFS_PERSON_INFO">
   <Attributes>
      <Attribute ColumnName="DAY_PHONE">
         <UsedForIndexing>
            <Entity EntityName="Order" Ignore="Y" />
         </UsedForIndexing>
      </Attribute>
   </Attributes>
</Entity>

Setting Ignore="Y" at the <UsedForIndexing> node ignores the association for this attribute with any index. Setting Ignore="Y" at the <Entity> node disassociatesß this attribute from the given index.

Similar settings are applicable at the entity relationship level to disable the attributes from the child entities. For example, in the application-provided definition of the Order index, the attributes from BillToPersonInfo are included. Whereas, the attributes from ShipToPersonInfo are not included.

Extend the Order entity as follows to remove PersonInfoBillTo from the Order index and add PersonInfoShipTo instead.

<Entity TableName="YFS_ORDER_HEADER">
   <RelationShips>
      <RelationShip Name="PersonInfoShipTo">
         <UsedForIndexing>
            <Entity EntityName="Order" />
         </UsedForIndexing>
      </RelationShip>
      <RelationShip Name="PersonInfoBillTo">
         <UsedForIndexing Ignore="Y" />
      </RelationShip>
   </RelationShips>
</Entity>

Note:

Sterling Order Management System Software does not provide a way to remove the entities enabled for indexing.
Removal of any attribute from the outline template may impact the existing search UIs that contain the attribute. The attribute does not exist in the outline document, and hence it is not available to search against the index.

Build and deploy your extensions to update the system with your extensions. For more information about extending entity definitions, see Extending the database.