ROWS / FILAS

English (Español a continuación)

Various commands used to format Report Script rows are discussed below.

1.- ROWREPEAT

This command repeats the names of the row members on each line.

  • By default, the members of the rows are not repeated as long as the member does not change.

Its syntax is:

  • {ROWREPEAT}

This command is placed at the top of the Report Script, before entering the Page / Column / Row definition.

Let’s look at an example:

a) Default presentation:

b) Presentation after applying this command:

To nullify its impact, use the command:

  • {NOROWREPEAT}

If a Report Script consists of different Reports (each of them ending with the corresponding “ ! ” sign), if initially the {ROWREPEAT} command has been used but in a later block we want to annul its effect, we use the {NOROWREPEAT} command.

2.- SUPNAMES

Suppresses member names in rows.

  • By default, the names of these members are shown in the Report Script.

Syntax:

  • {SUPNAMES}

This command is placed at the top of the Report Script, before entering the Page / Column / Row definition.

Let’s see how the previous example looks after applying this command:

To nullify its impact, use the command:

  • {NAMESON}

If the Report Scripts consists of several blocks (each of them ending with its corresponding “ ! ” sign) and the {SUPNAMES} command has been used, if you want the names to appear in a specific block, you can include this command at the beginning of that block.

3.- INDENT

This command is used to indent the member names from the first name column (column 0).

Syntax:

  • {INDENT [number]}

Number: it is optional and represents the number of positions of the indentation; can take values:

  • Negatives: indenting to the left, although with the limit of the left margin of the page.
  • Positives: intenting to the right, maximum value 100.
  • If a number is not specified, it takes its default value, which is 2.

This command is placed at the top of the Report Script, before entering the Page / Column / Row definition.

In the following example we compare the default output of the Report Script with the output after applying the {INDENT 20} command (indentation of 20 positions to the right):

 4.- INDENTGEN

Indents the name of row members based on the generation they belong to.

Generations are counted from top to bottom:

  • The upper level of the dimension is the 1st generation, the next is the 2nd generation, and so on as you go down the outline, the number of the generation increases.

By default, Essbase indents -2 positions as you go down the generations of row dimensions:

  • Starting from the members of a generation, the members of the next generation are placed 2 characters to the left; those of the next another 2 characters to the left, and so on as you go down through the generations.
  • This indentation applies to all row dimensions.

Syntax:

  • {INDENTGEN Number}

This command is placed at the top of the Report Script, before entering the Page / Column / Row definition.

Number: It is optional and indicates the number of characters of the indentation.

  • If the number is positive, Essbase places the members of the 1st generation shown in the Report Script in the leftmost part of the page and as it goes down through generations, the elements have increasing indentation to the right.
  • If the number is negative, Essbase places the members of the last generation in the leftmost part of the Report Script and as the generations go up, the elements have increasing indentation to the right.
  • If this value is not defined, Essbase applies the value -2 by default.

In the following example we compare the default output of the Report Script with the output after applying the {INDENTGEN 20} command (indentation of 20 positions to the right):

If you don’t want generation-based indentation (default) and all member names to be left-aligned, use the command:

  • {NOINDENTGEN}

5.- UCHARACTERS

This command underlines the row of the member after which it is included.

  • Underlines all characters except blank spaces.

Its syntax is:

  • {UCHARACTERS [underscore character]}

Underscore character: is optional; The character must be enclosed in quotation marks (for example: “-”).

  • The underscore character must have a single position.
  • If it is not included, its defaults value is “ = “. This default character can be modified with the {UNDERLINECHAR} command:
    • {UNDERLINECHAR “Underline character”}
    • For example: {UNDERLINECHAR “#”}

Let’s look at an example: suppose the following row definition:

  • <ROW(Countries,Products,Indicators)
  • Spain.
  • Germany,
  • Mobile
  • Computers,
  • Printers,
  • Sales,
  • {UCHARACTERS “x”}
  • Costs,
  • Profits,

The rows that correspond to the “Sales” indicator will be underlined with “x”.

6.- UCOLUMNS

This command has a similar effect to the previous one: it underlines the row of the member after which it is included.

  • The difference with the {UCHARACTERS} command is that while this does not underline the blank spaces (although it belongs to the width of the column), the {UCOLUMNS} command does.

Its syntax is:

  • {UCOLUMNS [underscore character]}

Underscore character: is optional; the character to be underlined must be enclosed in quotation marks (for example: “x”):

  • The underscore character must have a single position.
  • If not specified, its defaults value is “=“. This default character can be modified with the command {UNDERLINECHAR “Underline character”}

Let’s see the previous example but applying this command:

7.- UNAME

This command is used to underline the names in the name columns, but without underlining the data.

  • Underlines the row of the member after which it has been included.

Syntax:

  • {UNAME “Underline character”}

Underscore character: is optional; is the character with which the underscore is performed (for example, “x”).

  • The underscore character must have only one position and must be enclosed in quotation marks.
  • If not specified, the default character “=” is applied. This default character can be modified with the command {UNDERLINECHAR “Underline character”}

Let’s look at an example:

8.- UDATA

This is another underline command, but unlike the previous ones, it only underlines the data, not the row names.

  • Underlines the row of the member after which it has been included.

Its syntax is:

  • {UDATA [underscore character]}

Underscore character: is optional; You must include the character in quotes (for example: “x”).

  • The underscore character must have only one position.
  • If not specified, the default character “=” is applied. This default character can be modified with the command {UNDERLINECHAR “Underline character”}

Let’s look at an example:

9.- UNAMEONDIMENSION

Inserts an underlined line each time the member of the dimension to which the indicated member belongs changes.

  • This command is placed at the top of the Report Script, before entering the Page / Column / Row definition.

Syntax:

  • {UNAMEONDIMENSION “member”}

Member: any member of the dimension that you want to underline when its members change.

Some considerations:

  • Various UNAMEONDIMENSION commands can be included, selecting different dimensions.
  • By default, it uses “ = “ as the underscore character, but it can be modified with the command {UNDERLINECHAR “Underline character”}

Let’s see an example: we apply the command {UNAMEONDIMENSION «Products»} (we use the underscore character «x» that we have defined with the UNDERLINECHAR command).

If later in the Report Script you want to annul the effect of this command, use the {NOUNAMEONDIM} command.

  • If the Report Scripts consists of several blocks (each of them ending with its corresponding sign “ ! “) and the {UNAMEONDIMENSION} command has been used, if in a later block you want to cancel its effect, this command {NOUNAMEONDIM} is used.

Your syntax:

  • {NOUNAMEONDIM “member”}

Member: Any member of the dimension that was used in the {UNAMEONDIMENSION} command whose effect you now want to override.

If used with other commands the execution order is:

  • {UNAMEONDIMENSION}
  • {SKIPONDIMENSION}
  • {PAGEONDIMENSION}

10.- SKIPONDIMENSION

This command is used to include a blank line each time the member of the specified dimension changes.

  • This command is placed at the top of the Report Script, before entering the Page / Column / Row definition.

Its syntax is:

  • {SKIPONDIMENSION Member}

Member: Any member of the dimension that you want to use to include blank lines.

Let’s see an example: we apply the command {SKIPONDIMENSION “Products”}

If used with other commands, the execution order is:

  • {UNAMEONDIMENSION}
  • {SKIPONDIMENSION}
  • {PAGEONDIMENSION}

If you want to cancel the effect of this command later, use the {NONSKIPONDIMENSION} command.

Its syntax is:

  • {NONSKIPONDIMENSION Member}
  • Member: Any member of the dimension used before in the command {SKIPONDIMENSION}

11.- SKIP

This command allows to include blank lines in the Report Script after the member after which it has been included.

Its syntax is:

  • {SKIP n}

n: number of blank lines to include.

  • If not mentioned, 1 blank line is included.

Let’s look at an example: suppose the following row definition:

  • <ROW(Countries,Products,Indicators)
  • Spain.
  • {SKIP 2}
  • Germany,
  • Mobile
  • Computers,
  • Printers,
  • Sales,
  • Costs,
  • Profits,

Español

A continuación se analizan diversos comandos que sirven para dar formato a las filas del Report Script.

1.- ROWREPEAT

Este comando repite los nombres de los miembros de las filas en cada línea.

  • Por defecto no se repiten los miembros de las filas mientras no cambie el miembro.

Su sintaxis es:

  • {ROWREPEAT}

Este comando se sitúa en la parte superior del Report Script, antes de entrar en la definición de Página / Columna / Fila.

Veamos un ejemplo:

a) Presentación por defecto:

b) Presentación tras aplicar este comando:

Para anular su impacto se utiliza el comando:

  • {NOROWREPEAT}

Si un Report Script consta de diferentes Reports (cada uno de ellos finalizado con el correspondiente signo “ ! “), si inicialmente se ha utilizado el comando {ROWREPEAT} pero en un bloque posterior se quiere anular su efecto utilizamos el comando {NOROWREPEAT}.

2.- SUPNAMES

Suprime los nombres de los miembros en las filas.

  • Por defecto los nombres de estos miembros se muestran en el Report Script.

Sintaxis:

  • {SUPNAMES}

Este comando se sitúa en la parte superior del Report Script, antes de entrar en la definición de Página / Columna / Fila.

Veamos cómo queda el ejemplo anterior tras aplicar este comando:

Para anular su impacto se utiliza el comando:

  • {NAMESON}

Si el Report Scripts consta de diversos bloques (cada uno de ellos finalizados con su correspondiente signo “ ! “) y se ha utilizado el comando {SUPNAMES}, si en un bloque concreto se quiere que figuren los nombres se puede incluir este comando al comienzo de ese bloque.

3.- INDENT

Este comando se utiliza para sangrar los nombres de los miembros de la primera columna de nombres (columna 0).

Sintaxis:

  • {INDENT [número]}

Número: es opcional y representa el número de posiciones del sangrado; puede tomar valores:

  • Negativos: sangrado hacia la izquierda, si bien con el límite del margen izquierdo de la página.
  • Positivos: sangrado hacia la derecha, valor máximo 100.
  • Si no se especifica un número toma su valor por defecto que es 2.

Este comando se sitúa en la parte superior del Report Script, antes de entrar en la definición de Página / Columna / Fila.

En el siguiente ejemplo comparamos la salida por defecto del Report Script con la salida tras aplicar el comando {INDENT 20} (sangrado de 20 posiciones hacia la derecha):

4.- INDENTGEN

Introduce sangrado en el nombre de los miembros de las filas en función de la generación a la que pertenecen.

Las generaciones se cuentan de arriba abajo:

  • El nivel superior de la dimensión es la generación 1ª, la siguiente la generación 2ª, y así sucesivamente a medida que se desciende por el outline se va incrementando el número de la generación.

Por defecto, Essbase aplica un sangrado de -2 posiciones a medida que se desciende por las generaciones de las dimensiones de las filas:

  • Partiendo de los miembros de una generación, lo miembros de la siguiente generación se sitúan 2 caracteres a la izquierda; los de la siguiente otros 2 caracteres a la izquierda, y así sucesivamente a medida que se descienden por las generaciones.
  • Este sangrado se aplica a todas las dimensiones de las filas.

Sintaxis:

  • {INDENTGEN Número}

Este comando se sitúa en la parte superior del Report Script, antes de entrar en la definición de Página / Columna / Fila.

Número: Es opcional e indica el número de caracteres del sangrado.

  • Si el número es positivo Essbase sitúa los miembros de la 1ª generación que se muestre en el Report Script en la parte más a la izquierda de la página y a medida que se va descendiendo por generaciones los elementos llevan sangrado creciente hacia la derecha.
  • Si el número es negativo Essbase sitúa los miembros de la última generación en la parte más a la izquierda del Report Script y a medida que se va ascendiendo por generaciones los elementos llevan sangrado creciente hacia la derecha.
  • Si no se define este valor Essbase aplica por defecto el valor -2.

En el siguiente ejemplo comparamos la salida por defecto del Report Script con la salida tras aplicar el comando {INDENTGEN 20} (sangrado de 20 posiciones hacia la derecha):

Si no se quiere sangrado en función de la generación (opción por defecto) y que todos los nombres de los miembros estén alineados a la izquierda, se utiliza el comando:

  • {NOINDENTGEN}

5.- UCHARACTERS

Este comando subraya la fila del miembro a continuación del cual se ha incluido.

  • Subraya todos los caracteres a excepción de los espacios en blanco.

Su sintaxis es:

  • {UCHARACTERS [carácter de subrayado]}

Carácter de subrayado: es opcional; se debe incluir entre comillas el carácter con el que se va a subrayar (por ejemplo: “-”).

  • El carácter de subrayado debe de tener una sola posición.
  • Si no se incluye toma por defecto “=“. Este carácter por defecto se puede modificar con el comando {UNDERLINECHAR}:
    • {UNDERLINECHAR “Carácter de subrayado”}
    • Por ejemplo: {UNDERLINECHAR “#”}

Veamos un ejemplo: supongamos la siguiente definición de fila:

  • <ROW(Países,Productos,Indicadores)
  • España.
  • Alemania,
  • Móviles
  • Ordenadores,
  • Impresoras,
  • Ventas,
  • {UCHARACTERS “x”}
  • Costes,
  • Beneficios,

Las filas que correspondan al indicador “Ventas” van a ir subrayadas con “x”.

6.- UCOLUMNS

Este comando tiene un efecto similar al anterior: subraya la fila del miembro a continuación del cual se ha incluido.

  • La diferencia con el comando {UCHARACTERS} es que mientras éste no subraya los espacios en blanco (aunque pertenezca al ancho de la columna), el comando {UCOLUMNS} sí lo hace.

Su sintaxis es:

  • {UCOLUMNS [carácter de subrayado]}

Carácter de subrayado: es opcional; se debe incluir entre comillas el carácter con el que se va a subrayar (por ejemplo: “x”).

  • El carácter de subrayado debe de tener una sola posición.
  • Si no se especifica toma por defecto “=“.  Este carácter por defecto se puede modificar con el comando {UNDERLINECHAR “Carácter de subrayado”}

Veamos el ejemplo anterior pero aplicando este comando:

7.- UNAME

Este comando se utiliza para subrayar los nombres en las columnas de nombres, pero sin subrayar los datos.

  • Subraya la fila del miembro a continuación del cual se ha incluido.

Sintaxis:

  • {UNAME “Carácter subrayado”}

Carácter subrayado: es opcional; es el carácter con el que se realiza el subrayado (por ejemplo, “x”).

  • El carácter de subrayado debe de tener una sola posición y se debe incluir entre comillas.
  • Si no se especifica, se aplica el carácter por defecto “=”.  Este carácter por defecto se puede modificar con el comando {UNDERLINECHAR “Carácter de subrayado”}

Veamos un ejemplo:

8.- UDATA

Es otro comando de subrayado pero, a diferencia de los anteriores, tan sólo subraya los datos, no los nombres de las filas.

  • Subraya la fila del miembro a continuación del cual se ha incluido.

Su sintaxis es:

  • {UDATA [carácter de subrayado]}

Carácter de subrayado: es opcional; se debe incluir entre comillas el carácter con el que se va a subrayar (por ejemplo: “x”).

  • El carácter de subrayado debe de tener una sola posición.
  • Si no se especifica, se aplica el carácter por defecto “=”.  Este carácter por defecto se puede modificar con el comando {UNDERLINECHAR “Carácter de subrayado”}

Veamos un ejemplo:

9.- UNAMEONDIMENSION

Inserta una línea subrayada cada vez que cambia el miembro de la dimensión a la que pertenece el miembro indicado.

  • Este comando se sitúa en la parte superior del Report Script, antes de entrar en la definición de Página / Columna / Fila.

Sintaxis:

  • {UNAMEONDIMENSION “miembro”}

Miembro: un miembro cualquiera de la dimensión que se quiere subrayar cuando cambian sus miembros.

Algunas consideraciones:

  • Se pueden incluir diversos comandos UNAMEONDIMENSION recogiendo diferentes dimensiones.
  • Utiliza por defecto como carácter de subrayado “ = “, pero se puede modificar con el comando {UNDERLINECHAR “Carácter de subrayado”}

Veamos un ejemplo: aplicamos el comando {UNAMEONDIMENSION “Productos”} (utilizamos como carácter de subrayado “x” que hemos definido con el comando UNDERLINECHAR).

Si más adelante en el Report Script se quiere anular el efecto de este comando se utiliza el comando {NOUNAMEONDIM}.

  • Si el Report Scripts consta de diversos bloques (cada uno de ellos finalizados con su correspondiente signo “ ! “) y se ha utilizado el comando {UNAMEONDIMENSION}, si en un bloque posterior se quiere analizar su efecto se utiliza este comando {NOUNAMEONDIM}.

Su sintaxis:

  • {NOUNAMEONDIM “miembro”}

Miembro: un miembro cualquiera de la dimensión que se utilizó en el comando {UNAMEONDIMENSION} cuyo efecto se quiere ahora anular.

Si se utiliza con otros comandos el orden de ejecución es:

  • {UNAMEONDIMENSION}
  • {SKIPONDIMENSION}
  • {PAGEONDIMENSION}

10.- SKIPONDIMENSION

Este comando se utiliza para incluir una línea en blanco cada vez que cambia el miembro de la dimensión especificada.

  • Este comando se sitúa en la parte superior del Report Script, antes de entrar en la definición de Página / Columna / Fila.

Su sintaxis es:

  • {SKIPONDIMENSION Miembro}

Miembro: un miembro cualquiera de la dimensión que se quiere utilizar para incluir líneas en blanco.

Veamos un ejemplo: aplicamos el comando {SKIPONDIMENSION “Productos”}

Si se utiliza con otros comandos, el orden de ejecución es:

  • {UNAMEONDIMENSION}
  • {SKIPONDIMENSION}
  • {PAGEONDIMENSION}

Si se quiere anular más adelante el efecto de este comando se utiliza el comando {NONSKIPONDIMENSION}.

Su sintaxis es:

  • {NONSKIPONDIMENSION Miembro}

Miembro: un miembro cualquiera de la dimensión utilizada anteriormente en el comando {SKIPONDIMENSION}

que se quiere utilizar para incluir líneas en blanco.

11.- SKIP

Este comando permite incluir líneas en blanco en el Report Script después del miembro a continuación del cual se ha incluido.

Su sintaxis es:

  • {SKIP n}

n: número de líneas en blanco a incluir.

  • Si no se menciona se incluye 1 línea en blanco.

Veamos un ejemplo: supongamos la siguiente definición de fila:

  • <ROW(Países,Productos,Indicadores)
  • España.
  • {SKIP 2}
  • Alemania,
  • Móviles
  • Ordenadores,
  • Impresoras,
  • Ventas,
  • Costes,
  • Beneficios,