Business context model

You can use the business context model to create a rule that can link documents in Document Management to a screen in an ERP.

After the rule is created, when a user visits the specified screen in an ERP, the linked documents are displayed in the Related Information context app. Only the first 50 results are displayed.

Add/edit a rule

When you add or edit a rule, a window with two sections, Key and XQuery, is displayed.

Key
The key consists of four fields. Use this key to define the screen to which you want to link the documents. None of the key fields are required but you must use at least one. Each field progressively provides more control over which screens the rules apply to.

This table shows the key fields:

Field Description
Entity This field describes the type of object that is being mapped to. To find a screen’s entity, look for the entity type object in the context viewer. See this example:
"entities": [
      {
        "entityType": "InforDocument",

In this example, “InforDocument” is the entity. When used in a rule with no other fields, the rule applies to all screens with the matching entity type. For example, if there are screens in multiple products that have the InforDocument entity, then the rule applies to all of those screens.

Product This is the product in which the screen is located. To find the business context name for a product, look for the screenId in the context viewer. The screenId is a combination of the product and screen names, separated by an underscore. See this example:
"screenId": "daf_JTR_Doc"

In the example, daf is the product name and JTR_Doc is the screen name. When used in a rule with no other fields, the rule applies to all applicable screens within the designated product.

Note: You must use the business context name of a product instead of the name of the application. You can find the business context name in the context viewer.

For example, daf is the business context name for Document Management. If you try to create a rule and use IDM as the product, it does not work.

Screen This is the specific screen to which the rule applies. To find the business context name for a product, look for the screenId in the context viewer.

The screenId is a combination of the product and screen names, separated by an underscore. See this example:

"screenId": "daf_JTR_Doc"

In the example, daf is the product name and JTR_Doc is the screen name. When used in a rule with no other fields, the rule applies only to screens with the matching screen name. If multiple products have screens with the same name, the rule applies to all products.

Document Type This field causes the rule to be applied only to screens on which the selected document type is displayed.

Example:

You create a rule and use the aforementioned screenId, and select the “Invoice” document type. Of the matching screenId’s, only ones that show Invoice documents receive the rule.

XQuery
The second section in the window contains the XQuery. This query is used to show the documents for the selected screen. Document Management runs a search of the XQuery and shows the matching documents in the Related Information context app.

You can use dynamic mapping so that specific documents are applied to specific screens, even though all the screens are using the same rule.

For example, you use this XQuery: /JTR_Doc[@Status = "{id8}". The Related Information app only shows documents that meet these two conditions:
  • The document type is JTR_Doc.
  • The value of the Status attribute is the same as the value of “id8” of the current screen.

In the example, “id8” refers to the business context attribute. In the Document Type page of the Control Center, you can map document attributes in Document Management to business context attributes. You can use the context viewer to view the business context attributes for a screen.