Contract Entity

User Guide › Reports › Report Types › Booklets Overview › Template Design › Contract Entity

Contract Entity

Using the Contract Entity requires generating that booklet with a Contract context

Field Name	Description (value replaced by)
Commit Justification	Justification given by user when committing this version. Available from second contract version up. Otherwise replaced with nothing.
Currency	Currency of contract
Date Format	Date format of contract
Fee	Contract fee
Name	Name of the contract
Notes	Notes related to contract
Provider	Name of the contract provider
Receiver	Name of the contract receiver
Seats	Number of contract seats
Services	A comma-separated list of the services in this contract
Status	Current status of contract (for example, Preliminary, Effective)
Time Zone	Time zone of contract
Total Versions	Total number of versions for this contract
Type	Contract type (Underpinning, SLA, OLA)
Valid From	Start date of contract
Valid To	End date of contract
Version Number	Contract version number
Version Originally Valid To	Original end date of contract version, according to the time zone of the contract. If the contract version was canceled or partially overridden by a later version, this tag shows the original end date. Otherwise, it is equivalent to the version end date.
Version Status	Status of the contract version selected.
Version Valid From	Start date of contract version according to the time zone of the contract.
Version Valid To	End date of contract version According to the time zone of the contract. If the contract version was canceled by a later version, this date is equivalent to the version start date.

Custom Attribute Entity

Using the Custom Attribute entity requires a Contract Context.

When selecting Custom Attribute "Details" or "Fields" from the ribbon, then a condition on the custom attribute is required to uniquely identify the custom attribute.

Field Name	Description (value replaced by)
Description	Custom attribute description.
Name	Custom Attribute name
Type	Custom Attribute type
Value	Custom Attribute value

Service Entity

Using the service entity requires a Contract Context. When selecting a Service "Details" or "Fields" from the ribbon, then a condition on the service name is required to uniquely identify the service.

Field Name	Description (value replaced by)
Description
Fee
Name
Seats
Service Counter	A local index of the current service within a Service List.

Metric Entity

Using the Metric entity requires a Contract Context. When selecting a Metric "Details" or "Fields" from the ribbon, then a condition on the metric name is required to uniquely identify the metric.

Field Name	Description (value replaced by)
Business Logic Name
Business Logic Text	Text of the business logic formula related to the metric
Cluster Items
Cluster Name
Contract Section	Contract section name for which the metric belong to
Description	Metric description
Domain Category	Domain category related to a metric (or set of metrics).
Main Indicator	The metric's main indicator
Metric Counter	A local index of the current metric within a Metric List.
Name	Metric name
Notes	Additional notes regarding the metric.
Objective Statement	Metric's objective statement
Registration Description	The metric's registration description
Registration Statement	The metric's registration statement
Service	Service related to a metric (or set of metrics),
Service Domain	Service domain related to the metric (or set of metrics). Metric section or Service Domain header.
Service Level Target	Service level target of metric
Target Unit	The metric's target unit
Target Value	The metric's target value.
Timeslot	Timeslot type (weekly, yearly, compound) of metric
Timeslot Excluded	If the rule uses a compound Timeslot: a comma-separated list of the timeslots excluded from the compound timeslot. Otherwise, replaced with nothing.
Timeslot Included	If the rule uses a compound timeslot: a comma-separated list of the timeslots included in the compound timeslot. Otherwise, replaced with nothing.
Timeslot type	Timeslot type (weekly, yearly, compound) of rule
Tracking Period	Tracking period of metric
Type	The metric's type
Unit	Metric consumption unit
Unit Symbol	The metric's unit of consumption symbol

Parameter Entity

Using the parameter entity requires a Contract Context. If the "Parameter" entity is placed inside a Metric entity, then it is treated like a Metric Parameter. Otherwise, it is treated like a Contract Parameter.

This entity refers to all types of parameters except Table parameters.

When selecting a Parameter "Details" or "Fields" from the ribbon, then a condition on the parameter name is required to identify the parameter.

Field Name	Description
Description	Description of the parameter.
Name	Name of the parameter.
Type	Type of the parameter.
Value	Value of the parameter.

Table Parameter Entity

Using the Table Parameter entity requires a Contract Context.

It allows extracting all or some of the data contained within a Table Parameter.

If the "Table Parameter" entity is placed inside a Metric entity, then it is treated a Metric Table Parameter, else it is treated as a Contract Table Parameter.

Table Parameter Tag Options.

Entire table	Insert the entire contents of the Table Parameter as is.
Single Value	Insert a specific cell of the Table Parameter, by specifying its identifying column name and row number.
Select Columns	Insert a subset of the Table Parameter, by specifying which column(s) to extract, and optionally a range of rows

Report Entity

The Report entity can be used for the reports of the following types: Freeform, Simple, and Compound.

Group Reports are not supported within the Booklet (the user must add the individual reports to the booklet template and have greater control on the look and feel of the booklet).

A Contract Context is required in certain scenarios when using its entity.

Report (Freeform) Entity

The parameters of a freeform report can be specified within the booklet.

Field Name	Description (value replaced by)
Chart
Data (HTML)	Report data in a format ss defined in the web UI.
Data (Word Style)	Report data in a format that can be controlled within Word
Filter
Folder
Name
Single Value

As an example, consider the following freeform report with a parameter:

Query:

select '@PRM1' prm1 from dual

Parameters: (snippet)

</params>

When adding a Parameter, then the "Field" corresponds to the freeform parameter display name, in our case "PARAM 1".

The "Value" corresponds to the value that this parameter should have.

You can specify a freetext value for the parameter, or you can choose from a set of predefined parameters.

Freeform parameter value	Description	Precondition
Freetext	User entered parameter value	None
SLA_ID	Contract Context ID	Contract Context
SLA_NAME	Contract Context name	Contract Context
SLA_VERSION_ID	Contract Context Version ID	Contract Context
SLA_VERSION_NUMBER	Contract Context Version Number	Contract Context
CONTRACT_PARTY_ID	Contract Context Contract Party ID	Contract Context
CONTRACT_PARTY_NAME	Contract Context Contract Party Name	Contract Context
METRIC_NAME	Parent Metric name	Report placed with a Metric entity
SERVICE_NAME	Parent Service name	Report placed with a Service entity
EXTERNAL_CONTRACT_PARTY_NAME	The name of the User parameter "Contract party" selected	User parameter "Contract party" selected
EXTERNAL_CONTRACT_NAME The name of the User parameter "Contract" selected User parameter "Contract" selected EXTERNAL_SERVICE_NAME	The name of the User parameter "Service" selected	User parameter "Service" selected
EXTERNAL_FROM	The from Time Range. This can be mapped to a DATE freeform parameter	User parameter "Time Range" selected
EXTERNAL_TO	The to Time Range. This can be mapped to a DATE freeform parameter	User parameter "Time Range" selected

Freeform parameter value

Description

Precondition

Freetext

User entered parameter value

None

SLA_ID

Contract Context ID

Contract Context

SLA_NAME

Contract Context name

Contract Context

SLA_VERSION_ID

Contract Context Version ID

Contract Context

SLA_VERSION_NUMBER

Contract Context Version Number

Contract Context

CONTRACT_PARTY_ID

Contract Context Contract Party ID

Contract Context

CONTRACT_PARTY_NAME

Contract Context Contract Party Name

Contract Context

METRIC_NAME

Parent Metric name

Report placed with a Metric entity

SERVICE_NAME

Parent Service name

Report placed with a Service entity

EXTERNAL_CONTRACT_PARTY_NAME

The name of the User parameter "Contract party" selected

User parameter "Contract party" selected

EXTERNAL_CONTRACT_NAME

The name of the User parameter "Contract" selected

User parameter "Contract" selected

EXTERNAL_SERVICE_NAME

The name of the User parameter "Service" selected

User parameter "Service" selected

EXTERNAL_FROM

The from Time Range. This can be mapped to a DATE freeform parameter

User parameter "Time Range" selected

EXTERNAL_TO

The to Time Range. This can be mapped to a DATE freeform parameter

User parameter "Time Range" selected

Report (Simple/Compound) Entity

Field Name	Description (value replaced by)
Chart
Data (HTML)	Report data in a format specified within the free form xml
Data (Word Style)	Report data in a format that can be controlled within Word
Filter
Folder
Name
Single Value

If a booklet has some of the "User Parameters" checkboxes enabled, then generating the booklet will require choosing these parameters.

These parameters are then used to override the parameters defined within the simple/compound report itself.