DOCX Booklet Template Design

This article contains the following topics:
bsi835
This article contains the following topics:
When you open the booklet, Microsoft Word prompts you to update the TOC.
If the popup does not appear, verify that the value of the Allow TOC update parameter is Y in Advanced Settings, Reports, Booklets. To disable the prompt, set Allow TOC update to N. For more information, see Advanced Settings, Booklets.
If an error occurs,
CA Business Service Insights
adds a comment to the booklet to describe the error.
Template Design
The following table describes the tags as they appear on the Clarity BSI ribbon in Microsoft Word:
Section
Tag
Global
Fields
Contract Party
Details
Fields
Contract
Details
Fields
Custom Attribute
Details
List
Table
Fields
Service
Details
List
Table
Fields
Metric
Details
List
Table
Fields
Parameter
Details
List
Table
Field
Table Parameter
Report
Setting
Source Settings
Global Entity
The global entity contains tags that can be used within any of the other entities
Field Name
Description
Current Date Time
The current date and time
Contract Party Entity
Field Name
Description
Additional Phone Number
Second phone number of contract party
Address
Address of contract party
Class
Contract party class (a to z)
Contact
Contact of contract party
Country
The country of the contract party
Description
Description of contract party
Fax Number
Fax number of contract party
Mail Address
Address of contract party
Name
Contract party name
Notes
Mailing address of contract party
Phone Number
Phone number of contract party
Registration date
The registration date of the contract party
State
The state of the contract party
Type
Contract party type
Contract Entity
Field Name
Description
Commit Justification
The justification that the user gives 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
Description
Custom attribute description.
Name
Custom Attribute name
Type
Custom Attribute type
Value
Custom Attribute value
Service Entity
Field Name
Description
Description
Service description
Fee
Service Fee
Name
Service name
Seats
Number of seats
Service Counter
A local index of the current service within a Service List.
Report Data Entity
To view the entity, launch the Clarity BSI plugin, select
Settings
,
Template Specific
, and
Report Data
. The
Report
entity is renamed to
Report Data.
You can now set a custom message for each report. Earlier this functionality was available only at the booklet level.
In the
Fields
section of the
Insert Tag
window, the
Report Data
field displays the default value that is defined in the Booklet settings window. To modify the value for a particular report, navigate to the
Fields
section of
Insert Tag
window, and select the
Data (Word Style)
option.
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
Business Logic Name
Name of the business logic formula related to the metric
Business Logic Text
Text of the business logic formula related to the metric
Cluster Items
If the metric is clustered statically: a comma-separated list of the cluster items
Cluster Name
Cluster name (if metric is clustered)
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 main indicator of the Metric
Metric Counter
A local index of the current metric within a Metric List.
Name
Metric name
Notes
Additional notes regarding the metric.
Objective Statement
The objective statement of the Metric
Registration Description
The registration description of the Metric
Registration Statement
The registration statement of the Metric
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 target unit of the Metric
Target Value
The target value of the Metric
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 type of the Metric
Unit
Metric consumption unit
Unit Symbol
The unit of consumption symbol of the Metric
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 columns 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. Add the individual reports to the booklet template.
A Contract Context is required in certain scenarios when using its entity.
Report (Free Form) Entity
The parameters of a freeform report can be specified within the booklet.
Field Name
Description
Chart
Report data is displayed in charts.
Data (HTML)
Report data in a format as defined in the web UI.
Data (Word Style)
Report data in a format that can be controlled within Word.
Filter
Filter section of the report is displayed.
Folder
Folder contains the reports.
Name
Name of the report.
Single Value
The value of the (1,1) co-ordinate in the data table.
As an example, consider the following Free Form report with a parameter:
Query:
select '@PRM1' prm1 from dual
Parameters: (snippet)
<params>
<param name="@PRM1" disp_name="PARAM 1" type="TEXT" size="10"><value></value></param>
</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.
When entering a value, do not use > or <. These characters make the parameter definition invalid and
CA Business Service Insights
cannot generate the report. Use escape characters as necessary.
Example:
Replace < with &lt;
Specify a freetext value for the parameter, or select 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, which can be mapped to a DATE freeform parameter
User parameter "Time Range" selected
EXTERNAL_TO
The to Time Range, which can be mapped to a DATE freeform parameter
User parameter "Time Range" selected
The Conditional Formatting adds color to the values that are defined according to the condition. The Conditional Formatting is applied only on Free Form reports with fields type "Data(Word Style)". For example, when you want to display values that are less than 10 in Yellow in the report. Follow these steps:
  1. Click
    Add
    and a dialog opens to add the condition.
  2. Define the values:
    Operator
    as lower than or equals,
    Value
    as 10, and
    Color
    as Yellow.
  3. Click
    Add
    .
Report (Simple/Compound) Entity
Field Name
Description
Calculation Status
The status of the calculation.
Chart
Report data is displayed in charts.
Data (HTML)
Specify the report data in the free form XML.
Data (Word Style)
Report data in a format that can be controlled within Word.
Filter
Filter section of the report is displayed.
Folder
Folder contains the reports.
Name
Name of the report.
Last Completed Calculation
The last date and time the calculation that happened to generate the report.
If a booklet has some of the "User Parameters" enabled, generating the booklet requires the selection of these parameters. These parameters override the parameters that are defined in the simple/compound report.