NextGen Consulting

Data Paths and Expressions (Part 1)

About DataPath

A DataPath is a mechanism for defining data stored in a database (Amdocs CRM database or external database) or application memory structure such as Smart Client.

Paths identify data items related to a focus object

Data path may describe a database field, XML Node, HttpServletRequest, BO, LoadBean, any POJO (Plain Old Java Object) or run-time data structure such as Java Map, Xdo or Cdo. The data path is defined relative to a known starting point known as the context object known also as Focus Object.

Path Definition

A Path consists of a series of relations terminated by a field. A colon (:) is used to separate the relations and the final field. A path that is just a field identifies a field on the focus object

Path Context

A context refers to the source of data where the data path originates. For example, in the path given below, the context is a focus object given by $Case:

$case:case_reporter2site:cust_primaddr2address:address

The contexts are of two types:

1. Fixed context             – these are global and not runtime dependent.
2. Run time context    – names that must resolve at run time to context object instance.

Data Path Fixed Contexts

 

Data Path Run Time Contexts

 

Focus Object

The focus objects is not explicitly part of the path but is determined by context. For example:  the focus object for a Case query is Case, for a Subcase query it is subcase, for a Smart Client form it is a reference to a specific form.

Path Examples:

• Last name of contact for subcase

subcase2case:case_reporter2contact:last_name

The path starts at a beginning point (Subcase), traverses through the database, and locates the object at the end (contact’s last name)

• Site Id of the currently logged-in Smart Client user:

Dataset:DataModel:emplUserDM:p_site_id

The path starts at a beginning point (global form named CrmGlobal), traverses through the form’s Dataset, the data model emplUserDM and locates the object at the end (site_id)

The run-time beginning point defined as:

$WorkspaceForm:com.nextgen.crm.workspace.CrmGlobal:

Where are Paths used in CRM?

Paths and Expressions are widely used both at servers and clients across the CRM environment and its complementary peripheral applications such as Smart Client and Process Manager.

The following list and example demonstrate the most notable areas where paths and their derivate expressions are used:

• Database Queries
• Business rule properties
• Auto-destination rules
• Smart Client form elements
• Smart Client version selectors
• Role-based Authorization
• Pre-filters for selection
• Routing rules
• Extended Filters
• Output parameters of Services
• Define where the results should be stored
• Used within expressions (will be elaborated)

 

Usage Examples

• Database Queries

The following example use path to define the CBO relatedFilter property

• Business rule properties and recipient aliases – prop_name object

The following example shows the definition of a property named ‘Originator’ related to the a Case focus object. The focus object named here ‘Object Type’:

• Auto-destination rules –  rule object

The following example shows a path used within an Auto Destination Rule. The implicit focus object here is the Case object. The Case focus object is explicitly defined in table_rule.title field.

• Smart Client form elements: Forms, Actions, Data Models, Communications

The following example shows path used in Smart Client Action’s Request Map definition:

• Smart Client version selectors

This example shows the use of a path within a condition expression defined for selecting the form version to be displayed. The focus object is $WorkspaceForm.

• Role-based Authorization

Path used as part of an expression which defines conditional authorization role. The focus object is $Var.

• Pre-filters for selection

The focus object in this example is the table ‘con_bus_role’.

The path filter a role related to specific address identified by a Vo primary key (objid) passed from the client.

• Routing rules

The following example shows a path used within a routing rule. The focus object (called here ‘source type’) is a Case.

• Extended Filters (XFilters)

The following example shows a path used within an extended filter to describe named properties (called here ‘friendly name) which define business entities by their absolute path from the focus object – a view named opp_view_xfilter.

• Used within expressions

See also Version Selector, Conditional Role Base Authorization, pre-filter and Routing-Rule examples.

 

See next part:  Database Path Contexts (Part 2)

25/04/2011 - Posted by Yuval R. | Amdocs, Backend, CRM, CRM, Development, Front End, Smart Client, Technology