TEXT / TEXTO

English (Español a continuación)

This command allows to enter texts in the Report Script.

Syntax:

  • {TEXT Position “Text”}

Position: place of the line where to start the text.

  • Must be an integer.
  • If 0 is selected, the text is placed on the left margin of the page.
  • If c is selected the text is centered on the page.

Text: text to include in the Report Script (maximum length: 500 characters).

Example:

  • {TEXT c “ANNUAL SALES”}

It includes a line and in its central position the text “ANNUAL SALES”.

More than one text can be included.

  • {TEXT Position “Text” / Position “Text” /… }

Example:

  • {TEXT c “ANNUAL SALES”
  • TEXT 2 “Sales Department”}

It includes, in addition to the previous line, a second line and in the 2nd position, starting from the left, the text “Sales Department”.

Keywords can be included in the text: they must be preceded by the symbol * and must be between “ “. Some examples:

  • *APPNAME”: Name of the application.
  • “*ARBOR”: Essbase version.
  • “*CALC”: The value of a calculated row.
    • Syntax: {TEXT Position “*CALC [Column number]” “Name of the calculated row”}
      • [Column number]: it is optional; designates the column from which to display the value.
    • Examples: {TEXT 15 “*CALC 5” “Obj_2021”}
      • Includes the calculation corresponding to column 5 of the calculated row “Obj_2021” and places it starting at position 15.
  • “*DATE”: Report Script execution date.
  • “*DATETIME”: Date and time of execution of the Report Script.
  • “*DBNAME”: Name of the database from which the Report Script is created.
  • “*PAGESTRING”: Page number.
  • “*USERNAME”: Name of the user who has executed the Report Script.
  • “*COLHDR Number 1 Number 2”: Selects members of the column headers:
    • Number 1: Number of the column dimension from which the member is selected.
    • Number 2: Number of the member of the selected dimension.
  • Example: Suppose a Report Script with the following definition of columns:
    • <COLUMN(“Markets”,”Months”)
    • Spain
    • Germany
    • January
    • February
    • March
  • “*COLHDR 1 1”: Selects from the 1st dimension (“Markets”) the 1st member: Spain.
  • “*COLHDR 2 3”: Selects from the 2nd dimension (“Months”) the 3rd member: March.

The “TEXT” command can be placed at the top of the Report Script (before the Page / Header / Column definition):

  • It is very useful to define specific page headers: it must be included within the commands {STARTHEADING … ENDGEADING} and it goes without the braces “{ }”.

Let’s look at an example:

  • {STARTHEADING
    • TEXT
    • 10 “Annual sales”
    • c “EUROPEAN MARKETS”
    • SKIP
    • TEXT
    • 2 “*PAGESTRING”
    • TEXT
    • c “*DATE”
  • ENDHEADING}
  • <ROW…

The instructions we have used:

  • TEXT: Enter a line in the header:
    • In position 10 (starting from the left) the text “Annual sales” appears.
    • The text “EUROPEAN MARKETS” appears in the center of the line.
  • SKIP: Enter a blank line.
  • TEXT: Defines a new line in the header:
    • In position 2 (starting from the left) is the page number.
  • TEXT: Defines a new line in the header:
    • The day on which the Report Script is executed appears in the center of the line.

The “TEXT” command can also go at the bottom of the Report Script, after the Page / Header / Column description, so that it goes as a footer.

Examples:

  • <PAGE …
  • <ROW…
  • <COLUMN …
  • {TEXT 10 “*USERNAME”
  • TEXT 10 ”*DBNAME”
  • TEXT 10 “*DATETIME”}

We introduce as a footer:

  • A first line, and in position 10 the user who has executed the Report Script.
  • A second line, and in position 10 the name of the database from which this Report Script has been created.
  • A third line, and in position 10 the date and time of execution of the Report Script.

Español

Este comando permite introducir textos en el Report Script.

Sintaxis:

  • {TEXT Posición “Texto”}

Posición: lugar de la línea donde iniciar el texto.

  • Debe ser un número entero.
  • Si se selecciona 0 el texto se sitúa en el margen izquierdo de la página.
  • Si se selecciona c el texto se centra en la página.

Texto: texto a incluir en el Report Script (longitud máxima: 500 caracteres).

Ejemplo:

  • {TEXT c “VENTAS ANUALES”}

Incluye una línea y en su posición central el texto “VENTAS ANUALES”.

Se pueden incluir más de un texto.

  • {TEXT Posición “Texto” /  Posición “Texto” /… }

Ejemplo:

  • {TEXT c “VENTAS ANUALES”
  • TEXT 2 “Departamento de Ventas”}

Incluye, además de la línea anterior, una segunda línea y en la posición 2ª, empezando por la izquierda, el texto “Departamento de Ventas”.

En el texto se pueden incluir palabras claves: deben ir precedidas del símbolo * e ir entre “ “. Algunos ejemplos:

  • “*APPNAME”: Nombre de la aplicación.
  • “*ARBOR”: Versión de Essbase.
  • “*CALC”: El valor de una fila calculada.
    • Sintaxis: {TEXT Posición “*CALC [Número de columna]” “Nombre de la fila calculada”}
      • [Número de columna]: es opcional; designa la columna de la que se va a mostrar el valor.
    • Ejemplos: {TEXT 15 “*CALC 5” “Obj_2021”}
      • Incluye el cálculo correspondiente a la columna 5 de la fila calculada “Obj_2021” y lo sitúa comenzando en la posición 15.
  • “*DATE”: Fecha de ejecución del Report Script.
  • “*DATETIME”: Fecha y hora de ejecución del Report Script.
  • “*DBNAME”: Nombre de la base de datos de la que se elabora el Report Script.
  • “*PAGESTRING”: Número de la página.
  • “*USERNAME”: Nombre del usuario que ha ejecutado el Report Script.
  • “*COLHDR Número 1 Número 2”: Selecciona miembros de la cabecera de las columnas:
    • Número 1: Número de la dimensión de columna de la que se selecciona el miembro
    • Número 2: Número del miembro de la dimensión seleccionada.
  • Ejemplo: Supongamos un Report Script con la siguiente definición de columnas:
    • <COLUMN(“Mercados”,”Meses”)
    • España
    • Alemania
    • Enero
    • Febrero
    • Marzo
  • “*COLHDR 1 1”: Selecciona de la 1ª dimensión (“Mercados”) el 1er miembro: España.
  • “*COLHDR 2 3”: Selecciona de la 2ª dimensión (“Meses”) el 3er miembro: Marzo.

El comando “TEXT” se puede colocar en la parte superior del Report Script (antes de la definición de Página / Cabecera / Columna):

  • Es muy útil para definir cabeceras específicas de las páginas: debe ir incluido dentro de los comandos {STARTHEADING … ENDGEADING} y va sin las llaves “{ }”.

Veamos un ejemplo:

  • {STARTHEADING
    • TEXT
    • 10 “Ventas anuales”
    • c “MERCADOS EUROPEOS”
    • SKIP
    • TEXT
    • 2 “*PAGESTRING”
    • TEXT
    • c “*DATE”
  • ENDHEADING}
  • <ROW …

Las instrucciones que hemos utilizado:

  • TEXT: Introduce una línea en la cabecera:
    • En la posición 10 (comenzando por la izquierda) figura el texto “Ventas anuales”.
    • En el centro de la línea figura el texto “MERCADOS EUROPEOS”.
  • SKIP: Introduce una línea en blanco.
  • TEXT: Define una nueva línea en la cabecera:
    • En la posición 2 (comenzando por la izquierda) figura el número de página.
  • TEXT: Define una nueva línea en la cabecera:
    • En el centro de la línea figura el día que se ejecuta el Report Script.

El comando “TEXT también puede ir en la parte inferior del Report Script, tras la descripción de Página / Cabecera / Columna, para que vaya como pie de página.

Ejemplos:

  • <PAGE …
  • <ROW …
  • <COLUMN …
  • {TEXT 10 “*USERNAME”
  • TEXT 10 ”*DBNAME”
  • TEXT 10 “*DATETIME”}

Introducimos como pie de página:

  • Una primera línea, y en la posición 10 el usuario que ha ejecutado el Report Script.
  • Una segunda línea, y en la posición 10 el nombre de la base de datos de la que se ha elaborado este Report Script.
  • Una tercera línea, y en la posición 10 el día y hora de ejecución del Report Script.