User Guide › Reports › Report Types › Booklets Overview › Creating a Booklet › Creating Booklets in .docx Format › Booklet and Contract Export Tags › Understanding Tags

Understanding Tags

Each of the tags explained, contains the following information:

• Tag Name
  • The syntax of parameters in the template is: <<TAG_NAME>>
  • Tag names are case sensitive. Always use capital letters.
  • The enclosing << and >> signs must be adjacent to the name without any spaces or tabs.
• Value Replaced With
  • Most of the tags are replaced by values. If no value exists (for example, the customer has no fax number defined in CA Business Service Insight), the tag is left blank.
  • There are some special tags that are not replaced by a value. These tags either define a special block in the document (a section or a header) or perform an operation, such as changing the order of metrics in the document or filtering a specific set of metrics.
• Contract Context Required

  When exporting a contract from a specific contract version, the template receives the context of that contract version. All the tags are replaced, based on the data contained in that version; however, when you create a report booklet, the contract context is optional. If you do not provide a context, and your template still contains tags that require a contract context, these tags will be replaced with nothing.

• Tag Context

  It is important to note that a tag is replaced only when it is placed in the correct context. The context may be one of the following:

  • Main: The main document, outside of any section or header.
  • Section: Examples of sections include metrics, penalties, services and favorites. Sections are used to repeat the same block in the document for each item in the contract or report.
  • Header: Headers can be used within a metric section only. Examples include: Service, Service Domain and Domain Category headers.