The base object is the object for which the content area is showing data. All class-based content areas and content areas with a base object definition via a query have a base object when opened by a user. The REFSTR object class property value of the base object is available as information to all subordinate parts of the content area. Many standard views depend on a base class. They are designed to show content for a single object of a specific object class. The same applies to object class property groups and data workbenches. Configured reports, indicator cards, and grouped indicator cards can be defined to show data for a specific object.
In queries, the base object can be referenced with the Alfabet parameter@BASE . If you want to limit the data displayed in a report to the information about the object that is the base object of the content area the report is assigned to, you must define a WHERE condition comparing the REFSTR object class property of the object class the report is about with the Alfabet parameter @BASE.
Alfabet query parameters
You can use Alfabet query parameters in both native SQL queries and Alfabet queries to refer to the current context in the Alfabet user interface. For example, to refer to the object the user is currently working with, the user executing the report, or the current workflow being executed in WHERE clauses. During execution of the Alfabet query, the Alfabet parameter is substituted with the current return value. If no value is returned, the Alfabet query is executed without the WHERE statement.
Write Alfabet parameters as:
For example:
- WHERE APPLICATIONGROUP.BELONGSTO CONTAINS @BASE
finds all application groups subordinate to the application group the user is currently working with on execution of a native SQL query.
The following Alfabet parameters can be used for Alfabet queries and native SQL queries:
| Parameter Name |
Description |
|
BASE
|
Returns the value of the REFSTR property of the current object. |
|
CURRENT_PROFILE
|
Returns the value of the REFSTR property of the current user profile. |
|
CURRENT_USER
|
Returns the value of the REFSTR property of the current user. |
|
CURRENT_MANDATE
|
Returns the current mandate of the user. The Alfabet parameter can be used for example to limit search results to objects that are assigned to the mandate the user is currently logged in with, for example:
- ALFABET_QUERY_500
- FIND ICTObject
- WHERE ICTObject.MANDATEMASK CONTAINS @CURRENT_MANDATE
NOTE: The parameter CURRENT_MANDATE (and the whole statement it is used in) is ignored if the user has no mandate assigned or is working as mandate master. |
|
CURRENT_CULTURE
|
Returns the Microsoft® Windows® Locale identifier (LCID) of the current culture of the Alfabet user interface.
Please note that the culture that is selected as default culture is always returned as 127, which means default, independent from the LCID of the culture. |
|
TODAY
|
Returns the current date. |
|
ALFA_SERVER_URL
|
Returns the value of the attribute Web Server of the server alias configuration of the Alfabet component processing the query. The attribute Web Server is editable in the Overview tab of the server alias configuration editor. |
|
BASE<number> |
For queries defined in the context of layered diagrams and grid reports only! If the report is configured to allow cascading queries, and more than one level of related objects us defined, BASE0 returns the value of the REFSTR property of the parent object in the directly superordinate level of the diagram. BASE1 returns the ancestor object in the level superordinate to the parent object level etc. |
|
WIZARDBASE
|
For queries defined in the context of wizard configuration only! Return the value of the REFSTR property of the base object of the wizard. The base object of the wizard can be different from the base object of a wizard step. This parameter allows to refer to the base object of the wizard for example in pre-conditions of steps that have a different base object than the overall wizard. |
|
WORKFLOW
|
For queries defined in the context of workflow configuration only! Returns the value of the REFSTR property of the workflow. Each workflow corresponds to an object Workflow in the Alfabet database. The parameter is useful when defining queries that refer to properties of the class Workflow, like for example the workflow owner or the workflow initiator. . |
|
WORKFLOWBASE
|
For queries defined in the context of workflow configuration only! Returns the value of the REFSTR property of the base object of the workflow. The base object of the workflow can be different from the base object of a workflow step. This parameter allows to refer to the base object of the workflow for example in pre-conditions of steps that have a different base object than the overall workflow. |
|
LAST_EXECUTION
|
For queries defined in the context of monitors only. Returns the date of the last execution of the monitor. |
The following query will return a single result when executed in a content area with a base object:
- SELECT app.REFSTR, app.NAME, app.VERSION
- FROM APPLICATION app
- WHERE app.REFSTR = @BASE
You can also define the base object on the level of content pages and content items. You can design a content area about one object including a content page displaying information about another object. Or you can add a content item in a content page displaying information related to another object than the base object of the content area or content page. In clas-sless content areas, you can add content items or content pages with a base object to add information about a single object. You can, for example, add information about the current user to the home content area of a user profile.
A base object definition on a low level in the hierarchy of content area definition supersedes a definition on a higher level in the hierarchy. If a content area for a contract has a content page with a base object query finding the vendor the contract has been signed with, the content page will show data about that vendor and all other pages in the content area will show data about the contract. You can also define a base object query for a content item in the content page about the vendor and add, for example, data about the contact person communicating with the vendor.
- You cannot add an object class property group two times to a content page. If you want to add object class property groups with a changed base object, the object class properties of the two objects for which content is available on the page must be in different object class property groups.
- Evaluation cards cannot be added to content pages with a base object definition. This feature will be added in a future release.
- Base object queries can only be defined for content items displaying indicator cards if those indicator card items are added to a content page with a base object definition. If the content page has a base object definition, all indicator cards for all object classes are displayed in the selector. If no base object is defined for the content page, only indicator cards for the base object of the content area are listed in the selector and you cannot define the item for a different object class.
- If the base object query returns no data, the content item or the content items in the content page will show up empty. For example, if you add an object class property group with contact details from the user information of the architect for the application to the class-based content area for applications, the object class property group will be empty if the application has no architect defined.
- If the base object is changed for a content page, the Manage Content on Page functionality will show content for the new base object if the user opens it for that content page.
Base objects are defined in the Base Object Query attribute of content pages and content items. Definition of the base object query follows the same rules on all levels of the content area:
- The query can be defined in Alfabet query language or in native SQL. An Alfabet query builder is not available. The query must be defined in a text editor.
- The query must return the REFSTR of a single object. Any additional data about the object is ignored.
- You can use Alfabet parameters referring to the current environment in the query. The Alfabet parameter @BASE can be used in class-based content areas to refer to the base object of the content area or in content pages with a base object definition to refer to the base object of the content page. The Alfabet parameter @WORKFLOWBASE can be used in content areas or content pages for workflows and workflow steps to refer to the base object of the workflow.
Alfabet query parameters
You can use Alfabet query parameters in both native SQL queries and Alfabet queries to refer to the current context in the Alfabet user interface. For example, to refer to the object the user is currently working with, the user executing the report, or the current workflow being executed in WHERE clauses. During execution of the Alfabet query, the Alfabet parameter is substituted with the current return value. If no value is returned, the Alfabet query is executed without the WHERE statement.
Write Alfabet parameters as:
For example:
- WHERE APPLICATIONGROUP.BELONGSTO CONTAINS @BASE
finds all application groups subordinate to the application group the user is currently working with on execution of a native SQL query.
The following Alfabet parameters can be used for Alfabet queries and native SQL queries:
| Parameter Name | Description |
|---|
| BASE | Returns the value of the REFSTR property of the current object. |
| CURRENT_PROFILE | Returns the value of the REFSTR property of the current user profile. |
| CURRENT_USER | Returns the value of the REFSTR property of the current user. |
| CURRENT_MANDATE | Returns the current mandate of the user. The Alfabet parameter can be used for example to limit search results to objects that are assigned to the mandate the user is currently logged in with, for example:
- ALFABET_QUERY_500
- FIND ICTObject
- WHERE ICTObject.MANDATEMASK CONTAINS @CURRENT_MANDATE
NOTE: The parameter CURRENT_MANDATE (and the whole statement it is used in) is ignored if the user has no mandate assigned or is working as mandate master. |
| CURRENT_CULTURE | Returns the Microsoft® Windows® Locale identifier (LCID) of the current culture of the Alfabet user interface.
Please note that the culture that is selected as default culture is always returned as 127, which means default, independent from the LCID of the culture. |
| TODAY | Returns the current date. |
| ALFA_SERVER_URL | Returns the value of the attribute Web Server of the server alias configuration of the Alfabet component processing the query. The attribute Web Server is editable in the Overview tab of the server alias configuration editor. |
| BASE<number> | For queries defined in the context of layered diagrams and grid reports only! If the report is configured to allow cascading queries, and more than one level of related objects us defined, BASE0 returns the value of the REFSTR property of the parent object in the directly superordinate level of the diagram. BASE1 returns the ancestor object in the level superordinate to the parent object level etc. |
| WIZARDBASE | For queries defined in the context of wizard configuration only! Return the value of the REFSTR property of the base object of the wizard. The base object of the wizard can be different from the base object of a wizard step. This parameter allows to refer to the base object of the wizard for example in pre-conditions of steps that have a different base object than the overall wizard. |
| WORKFLOW | For queries defined in the context of workflow configuration only! Returns the value of the REFSTR property of the workflow. Each workflow corresponds to an object Workflow in the Alfabet database. The parameter is useful when defining queries that refer to properties of the class Workflow, like for example the workflow owner or the workflow initiator. . |
| WORKFLOWBASE | For queries defined in the context of workflow configuration only! Returns the value of the REFSTR property of the base object of the workflow. The base object of the workflow can be different from the base object of a workflow step. This parameter allows to refer to the base object of the workflow for example in pre-conditions of steps that have a different base object than the overall workflow. |
| LAST_EXECUTION | For queries defined in the context of monitors only. Returns the date of the last execution of the monitor. |
The following query changes the base object for a content item in the class-based content area of an information flow to the source application of the information flow. The query refers to the current base object of the content area with the Alfabet parameter @BASE
Alfabet query parameters
You can use Alfabet query parameters in both native SQL queries and Alfabet queries to refer to the current context in the Alfabet user interface. For example, to refer to the object the user is currently working with, the user executing the report, or the current workflow being executed in WHERE clauses. During execution of the Alfabet query, the Alfabet parameter is substituted with the current return value. If no value is returned, the Alfabet query is executed without the WHERE statement.
Write Alfabet parameters as:
For example:
- WHERE APPLICATIONGROUP.BELONGSTO CONTAINS @BASE
finds all application groups subordinate to the application group the user is currently working with on execution of a native SQL query.
The following Alfabet parameters can be used for Alfabet queries and native SQL queries:
| Parameter Name | Description |
|---|
| BASE | Returns the value of the REFSTR property of the current object. |
| CURRENT_PROFILE | Returns the value of the REFSTR property of the current user profile. |
| CURRENT_USER | Returns the value of the REFSTR property of the current user. |
| CURRENT_MANDATE | Returns the current mandate of the user. The Alfabet parameter can be used for example to limit search results to objects that are assigned to the mandate the user is currently logged in with, for example:
- ALFABET_QUERY_500
- FIND ICTObject
- WHERE ICTObject.MANDATEMASK CONTAINS @CURRENT_MANDATE
NOTE: The parameter CURRENT_MANDATE (and the whole statement it is used in) is ignored if the user has no mandate assigned or is working as mandate master. |
| CURRENT_CULTURE | Returns the Microsoft® Windows® Locale identifier (LCID) of the current culture of the Alfabet user interface.
Please note that the culture that is selected as default culture is always returned as 127, which means default, independent from the LCID of the culture. |
| TODAY | Returns the current date. |
| ALFA_SERVER_URL | Returns the value of the attribute Web Server of the server alias configuration of the Alfabet component processing the query. The attribute Web Server is editable in the Overview tab of the server alias configuration editor. |
| BASE<number> | For queries defined in the context of layered diagrams and grid reports only! If the report is configured to allow cascading queries, and more than one level of related objects us defined, BASE0 returns the value of the REFSTR property of the parent object in the directly superordinate level of the diagram. BASE1 returns the ancestor object in the level superordinate to the parent object level etc. |
| WIZARDBASE | For queries defined in the context of wizard configuration only! Return the value of the REFSTR property of the base object of the wizard. The base object of the wizard can be different from the base object of a wizard step. This parameter allows to refer to the base object of the wizard for example in pre-conditions of steps that have a different base object than the overall wizard. |
| WORKFLOW | For queries defined in the context of workflow configuration only! Returns the value of the REFSTR property of the workflow. Each workflow corresponds to an object Workflow in the Alfabet database. The parameter is useful when defining queries that refer to properties of the class Workflow, like for example the workflow owner or the workflow initiator. . |
| WORKFLOWBASE | For queries defined in the context of workflow configuration only! Returns the value of the REFSTR property of the base object of the workflow. The base object of the workflow can be different from the base object of a workflow step. This parameter allows to refer to the base object of the workflow for example in pre-conditions of steps that have a different base object than the overall workflow. |
| LAST_EXECUTION | For queries defined in the context of monitors only. Returns the date of the last execution of the monitor. |
- SELECT app.REFSTR
- FROM APPLICATION app
- INNER JOIN INFORMATIONFLOW inf ON inf.A_FROM = app.REFSTR
- WHERE inf.REFSTR = @BASE