ClientActivityLinkScreen

Use ClientActivityLinkScreen business rule to customize the behavior invoked by client data type. To understand the use of this business rule, follow the procedure:

  1. Go to a customer in OIPA Screen.
  2. Select Add Activity from the left entity navigation.
  3. Select an activity that has a field of Client data type. Clicking the Client data type field, the Client pop-up screen opens with the following two tabs:
    • Find Client
    • New Client

ClientActivityLinkScreen business rule controls the presentation of the Find Client and New Client tabs in Client pop-up screen. You can use this rule to:

  • Configure The content of each tab.
  • Enable and disable one or the other tab on the Client pop-up.
  • Enable both tabs and change the landing to the non-default landing tab.
  • Define non-default behavior of the Client pop-up screen by transaction, plan or product.
  • Alter the options list on the drop-down, and the field and their validations on the Find Client and New Client tabs.

Note: This is an optional rule. When it does not exist, the client pop-up screen opens with Find Client as landing tab, and New Client as the other tab.

ClientActivityLinkScreen: Elements and Attributes
Element/Tag Attributes Parent Element Description Element/Attribute Value

ClientActivityLinkScreen

 

  

The opening and closing elements of the screen rule.

 

<ScreenMath>

 

<ClientActivityLinkScreen>

Optional:

OIPA's common screen math functionality with access to the extended activity/transaction context.

Note: When the Client pop-up opens from an activity field configured with the Client data type, the screen math for ClientActivityLinkScreen can reference the initiating transaction by using Transaction:TransactionGUID and Transaction:TransactionName.

 

<Math>

  

<ScreenMath>

Required, Repeatable:

This provides a section of configured logic that establishes common variables for use throughout the rule. There is no practical use for repeating the element in this rule. However, if multiple <Math> sections exist, then it gets executed with its variables based on the ID attribute value.

 
 

ID

<Math>

Required:

Provides a name for the Math section. To access to the <Math>'s variables, use the ID attribute value as prefix. Throughout the rule, access to a math variable in a condition requires a prefix of the math section in which the variable was established. If other math sections have duplicate variable names, the prefix explicitly tells the system which variable to access.

literal

  
 

GLOBAL

<Math>

Optional:

Allows the variables in the <Math> section to be visible throughout the rule.

Applicable value is Yes. The default value is No. Because of the position of this <Math> element within the rule, the only logical value is Yes. This <Math> element is meant to automatically execute upon loading the rule and to produce variables that can be used throughout the rule.

If multiple <Math> elements have GLOBAL=Yes, only the first defined element will be executed.

<Transaction>

  

<ClientActivityLinkScreen>

Required, Repeatable:

The element provides a set of common behaviors to apply to the Client pop-up for a unique list of transactions. The element is repeated for an additional set of common behaviors for a unique list of transactions. Execution follows the order of definition. When the NAME attribute is not provided, execution will always process the element's contents for its behaviors with no regard to the transactions that initiate the Client pop-up.

  
 

NAME

<Transaction>

list of transaction names

Optional:

The value of this attribute is a comma delimited list of defined transaction names (not translated names), that will share a common set of behaviors to apply to the client pop-up.

<ScreenMath>

  

<Transaction>

Optional:

OIPA's common screen math functionality with access to the extended activity/transaction context.

 

<Math>

  

<ScreenMath>

Required, Repeatable:

This provides a section of configured logic that establishes local variables for the list of transactions in the parent <Transaction> element. There is no practical use for repeating the element in this rule. However, if multiple <Math> sections exist, it gets executed with its variables based on the ID attribute value.

 
 

ID

<Math>

literal

Required:

Provides a name for the Math section. Within this <Transaction> element access to a math variable in a condition requires a prefix name of the math section in which the variable was established. If the multiple math sections have duplicate variable names, the prefix explicitly tells the system which variable to access.

 
 

GLOBAL

<Math>

Optional:

Allows the variables in the <Math> section to be visible throughout the rule.

Applicable value is NO. The default value is NO. Because of the position of this <Math> element within the rule, the only logical value is NO. This <Math> element is meant to automatically execute when the transaction initiates the rule and it produces variables that can be used throughout the <Presentation> elements contained by this <Transaction> element.

<Presentation>

  

<Transaction>

Required, Repeatable:

This element defines the behavior to apply to the Client pop-up for the listed transactions. The element may be repeated to apply different behavior for the same list of transactions with different conditions.

 

<Tests>

  

<Transaction>

Optional:

The container element for the test expression configuration.

Note: When multiple <Test> elements are configured, it is expected that all <Test> elements resolve to TRUE for the overall <Tests> to be considered TRUE (logical AND operation) and then execute other parts of the configuration associated to <Tests> element. The default process is to unconditionally execute the behavior within the parent element.

 

<Test>

  

<Tests>

conditional statement

Required, Repeatable:

This element defines a conditional expression that resolves to TRUE or FALSE. Evaluation of all <Test> elements within a <Tests> element must evaluate to true in order for the rest of the associated configuration to execute.

<ClientScreen>

  

<Presentation>

Optional:

This element indicates when the New Client tab is enabled.

The value of the element may be a math variable which must resolved to a Yes or No.

Either <ClientSearchScreen> or <ClientScreen>, or both must be valued with Yes. The default value is Yes.

<ClientSearchScreen>

  

<Presentation>

Optional:

This element indicates when the Find Client tab is enabled.

The value of the element may be a math variable which must resolved to a Yes or No.

Either <ClientSearchScreen> or <ClientScreen>, or both must be valued with Yes. The default value is Yes.

<LandingPage>

  

<Presentation>

Optional:

This element indicates the tab upon which the user first lands.

Note: If this rule is not applicable, then ClientSearchScreen is the default landing page.

The value must be any of the following.

  • ClientScreen: Represents the New Client tab.
  • ClientSearchScreen: Represents the Find Client tab.
  • A math variable: The value of the variable must resolve to ClientScreen or ClientSearchScreen.

XML Schema

<ClientActivityLinkScreen>
<ScreenMath>
<Math ID="[name]" GLOBAL="Yes">...</Math>
</ScreenMath>
<Transaction NAME="[transaction name list]">
<ScreenMath>
<Math ID="[name]" GLOBAL="No">...</Math>
</ScreenMath>
<Presentation>
<Tests>
<Test>[condition]</Test>
<Test>[condition]</Test>
</Tests>
<ClientScreen>[Yes|No|math variable]</ClientScreen>
<ClientSearchScreen>[Yes|No|math variable]</ClientSearchScreen>
<LandingPage>[ClientScreen|ClientSearchScreen|math variable]</LandingPage>
</Presentation>
<Presentation>...</Presentation>
</Transaction>
<Transaction NAME="[transaction name]">...</Transaction>
<Transaction>...</Transaction>
</ClientActivityLinkScreen>