Rule builder

The rules that you create on the Rule Builder page determine which documents are retrieved from the external repositories. Those documents are then federated to the specified object store folder as a member of the specified document class.

On the Rule Builder page, you can create property searches and full-text-based content searches to operate against a single external repository. Property-based searches support standard operators (=, <, >, <>, >=, =<, and Like). Full-text searches support single words or phrases.

Note:
  • Rule names cannot contain spaces.
  • The star (*) character is a wildcard value for query searches. For example:
    DocumentTitle | LIKE | docu* locates all documents that begin with docu.
    DocumentTitle | LIKE | *docu* locates all documents that contain the string docu anywhere in the title.
Important: If you are using the sweeping feature to limit federation results to documents that were created or updated after the last time the rule was run, any updates to an existing rule will cause all documents that are selected by that rule to be refederated the next time that the rule is run, regardless of whether the documents were updated. Refederating all the documents that are selected by a rule can have significant performance implications because most of the documents did not change and causes the system to perform unnecessary work. Update federation rules only when you want to narrow the document selection criteria. If you want the rule to select a broader category of documents, it is usually better to define a new rule that selects only the additional documents rather than updating an existing rule so that it selects more documents. Updating any value on the Rule Builder page, followed by clicking Apply, constitutes a change that causes full refederation the next time the rule is run.

The following tables describe the federation service source and target repository settings that are used for Content Platform Engine.

Source repository settings

Field Type Description
Data Map List The data map defined by IBM® Content Integrator that contains the mapping information between the object store properties and the source attributes.
Repository Name List The source repository names that are associated with the data map.
Max Results Integer The maximum number of documents to federate each time that a rule is run.
Document Class List The source document class name to narrow the query.
Full Text Criteria String The keyword for querying the documents on the source repository. This option works only if the source repository supports full text searching.
Property Criteria String/List  

Target repository settings

Field Type Description
Object Store   The target object store that the federated documents are imported into.
Folder   The target folder that the federated documents are filed in.
Do not file Boolean Selecting this option ignores the target folder. The federated documents appear in the Unfiled Documents folder.
Document Class List The target document class that the federated documents are associated with.
Content Operation List Determines the content operation for the rule.
  • Federate: Federate the metadata and keep the content in the source repository.
  • Move: Federate and move the metadata and content. The source document is deleted after the move content operation is completed.
  • Lockdown: Lock down the content in the source repository at federation time for newly federated versions. Content that is locked down cannot be deleted from that repository.
    Important: Existing document versions that were federated without the lockdown option cannot later be locked down by modifying the content behavior and re-executing the rule.
Destination Storage Area List The target storage area. This option is enabled only when the move content operation is selected.