Reglas

Las variables son palabras especiales que podemos usar para crear reglas. Estas variables asumen o proporcionan datos específicos que pueden o no variar dependiendo de la ejecución de la regla. El nombre de la variable puede estar compuesto por letras y/o números o el carácter (guión bajo o guion bajo), no pudiendo tener más de 30 (treinta) caracteres y debiendo comenzar, necesariamente, con una letra.

Toda variable debe ser declarada al inicio de la regla, mediante el comando Definir (ver comandos), asignándole un tipo, nombre y, si es necesario, el número de ocurrencias de esta variable.

Las constantes son información que no cambia durante la ejecución de una regla. Estos son los números que ingresa en la regla. Ejemplo: cuando dices que VlrAux = 200; el número “200” es la constante.

Las tablas son las unidades básicas para almacenar datos. Se componen de filas y columnas.

Columnas, también llamadas "Campos", las columnas se utilizan para representar el valor de datos ingresado debajo de cada columna y tienen las siguientes propiedades:

• Cada columna tiene un nombre único;
• Están ordenados de izquierda a derecha;
• Líneas: las líneas se pueden ver como "registros" en un archivo, las líneas tienen las siguientes propiedades:
• Las líneas no están ordenadas;
• Cada fila de una tabla tiene solo un valor para cada columna de esa tabla;
  Cada fila de una tabla debe ser única;
• Como se utilizan en todos los lugares donde se definen reglas o fórmulas, tenemos la tecla F8 que nos trae la relación de las tablas con los datos existentes en el sistema.

Luego puede desplazarse por la lista de tablas con las flechas, hacer clic en el signo "+" que se muestra en el lado izquierdo del nombre de la tabla, para abrir la lista de campos que pertenecen a la tabla, coloque el cursor sobre el nombre del campo y haga clic en en el botón Seleccionar, para que los datos se desplacen al texto de la regla en la posición del cursor. Se pueden seleccionar varios campos a la vez, sin embargo, todos se incluirán en la regla, comenzando desde la posición del cursor.

Conociendo el nombre de la tabla y el nombre del campo, estos datos se pueden digitar, separando el nombre de la tabla y el nombre del campo por un “." (Puntaje).

Describimos los operadores, que se utilizan en las reglas y fórmulas:

Operadores logicos

Signo de	Descripción
=	Signo igual: Se utiliza en comparaciones/operaciones aritméticas
>	Más grande que: Usado en comparaciones del comando "Si"
<	Menos que: Usado en comparaciones del comando "Si"
<>	Diferente de: Usado en comparaciones del comando "If"
>=	Mayor o igual a: Usado en comparaciones del comando "Si"
<=	Menos que o igual a: Usado en comparaciones del comando "If"
y	Se usa con el comando "Si", para vincular varias condiciones, donde todas deben ser verdaderas para que el resultado de la comparación sea verdadero.
o	Se usa con el comando "Si", para vincular múltiples condiciones, donde al menos una de las condiciones debe ser verdadera para que el resultado de la comparación sea verdadero.

Operadores aritméticos

Signo de	Descripción
=	Signo igual: Se utiliza en comparaciones/operaciones aritméticas
+	Añadir signo: Se utiliza en operaciones aritméticas para sumar
-	Signo de resta: Operaciones aritméticas usadas para restar
/	Signo de división: Se utiliza en operaciones de división aritmética.
*	Asterisco: Se utiliza en operaciones de multiplicación aritmética
++	+1 incremento: Se utiliza para aumentar el valor de una variable, uno por uno.
--	Disminución de - 1: Se utiliza para disminuir el valor de una variable, uno por uno.

Operadores adicionales

Signo de	Descripción
@	A: Delimitador utilizado para incluir comentarios que tienen como máximo una línea.
/*	Comienzo del comentario.
*/	Fin del comentario.

Los comandos reconocidos por el sistema son:

Inicio o { (abre llaves) =>Indica el inicio de un bloque de comandos, cuando está subordinado a una condición o conjunto de condiciones (Se o Senao).

Sintaxis: Inicio o {

Fin o } (cerrar llaves) =>Indica el final de un bloque de comandos, cuando está subordinado a una condición o conjunto de condiciones (Se o Senao).

Sintaxis: Fin; o }

Definir =>Define una variable o función. Si la variable no está definida, se considerará de tipo Número.

Sintaxis: Definir <Tipo> <Nombre_Variable>
Donde el Tipo puede ser: Alfa, Número, Tabla, Función o Cursor.

Alfa: Variable alfanumérica. Puede contener letras y/o números.

Ejemplo: Establecer Alpha Vname[30];

Número: Variable que solo puede almacenar números. Estos pueden ser números enteros o con decimales.

Ejemplo: Establecer número Vvalue;

Tabla: Variable que puede almacenar valores en forma de tabla, donde tienes filas y columnas. Cada columna es un nombre con un tipo específico de información. Las filas están indexadas de 1 a "N".

Ocupación: Es un conjunto de comandos, cuyo objetivo es calcular uno o más valores y devolverlos para su uso en la regla. La ventaja de la función es que si hay una operación que se repite en muchas reglas, puede crear la función y llamarla en cada regla, sin tener que implementarla nuevamente.

Una función puede tomar parámetros y devolver valores. Imagina la siguiente situación: En varios puntos de la regla, de Control Horario y Comedor, necesitas pasar las horas de una situación a otra. Para ello se podría crear la siguiente función:

Nótese que la función está definida y se le asocian dos parámetros, definiendo el tipo para cada uno. el tipo de parámetrono puede ser alfanumérico. El nombre de la función es “AltSituacao” y sus parámetros son SitOri (Situación Origen) y SitDes (Situación Destino). Es importante recordar que los valores cambiados dentro de la función también se cambiarán fuera de ella. Por ejemplo, si se cambia HorSit[ ] dentro de la función, se cambiará automáticamente en la regla principal.

Para usar la función en la regla, debe declararse al principio de la regla.

Es interesante reservar, por ejemplo, la regla 001 solo para implementar funciones.

Si:Se utiliza para comparar. Ejecuta el bloque vinculado a la condición, solo si es verdadera.

Sintaxis: Si ( )

Si no:Se usa junto con el comandosi. El comando Senao se ejecutará cuando la condición especificada en el comando If no sea verdadera.

Sintaxis: De lo contrario

Para:Comando utilizado para bucle de comandos. Es decir, hacer que un bloque de comandos se ejecute un cierto número de veces. Se indica un <valor inicial> y este valor se incrementa con el valor del <contador> hasta que la <condición> sea falsa.

Sintaxis: Hasta (<valor inicial>; <condición>; <contador>)

Tiempo:Comando utilizado para bucle de comandos. Es decir, hacer que un bloque de comandos se ejecute un cierto número de veces hasta que la <condición> sea falsa.

Sintaxis: Mientras (<condición>)

Deténgase:Interrumpe la ejecución de un bloque de comando.Para oTiempo. Detener simplemente hace que el sistema abandone el bloque de comandos y continúe ejecutando el resto de las reglas.

Sintaxis: Detener;

Cancelar (1):Si se usa en la regla de evento “Antes de Imprimir” de una sección, cancela la impresión de la sección. Si se usa en el evento “Al Imprimir” de un campo, cancela la impresión de este campo.

Sintaxis: Cancelar(1);

Cancelar (2):Debe usarse junto con las variables de sistema ValStr o ValRet y solo en el Evento "On Print". El valor alfa asignado a ValStr seguido de Cancelar (2) se imprimirá en el campo donde se implementó la regla.

Sintaxis: Cancelar(2);

Mensaje:Muestra un mensaje al usuario mientras se ejecuta la regla.

Sintaxis: Mensaje (<tipo_mensaje>,"<mensaje>");

Donde el tipo de mensaje puede ser:

Error:Muestra el mensaje y detiene la ejecución de la regla.

Devoluciones:Muestra el mensaje, con botones de opción. En este caso, tendríamos la siguiente sintaxis:

Mensaje (Retorna "¿Desea finalizar la ejecución de la regla? [&Sí,&No]");

En este caso, "Devoluciones" devolverá 1 si se hace clic en la primera opción y 2 si se hace clic en la segunda opción.

Ir: Desvía la ejecución de la regla a la <etiqueta> dada.

Sintaxis: Vapara <etiqueta>;

Regla:Llama a otra regla, identificada por <número de regla>.

Sintaxis: Regla (<número_regla>);

continúa:Continúa la ejecución de un bucle realizado por el comandoPara. Es decir, si desea que el bucle no se ejecute en un caso determinado, pruebe la condición y use el comando junto con ella.

Sintaxis: Continuar;

Final:Se utiliza en la definición de una función para indicar qué parámetro devolverá un valor.

Sintaxis: Prueba de función (fin <tipo de parámetro> <nombre de parámetro>);

Abierto:Abre el <archivo introducido>, en el <modo de apertura> deseado. Si el archivo no existe, se crea. Devuelve un identificador de archivo.

Sintaxis: File_handler = Open (“<nombre_archivo>”,<modo_abrir>);
Donde el Modo Abierto puede ser:Leer oPara registrar.

Cerca:Cierra el archivo abierto por la función Abrir.

Sintaxis: Cerrar (<file_handler>)

Leer:Lee un <número de caracteres> del archivo especificado en el <controlador de archivos> y arroja el valor de lectura en una <variable>.

Sintaxis: Read(<file_handler>, <variable>,<size>);

Para registrar:Escribe el valor de una <variable o constante> en el <controlador de archivos>.

Sintaxis: Write(<file_handler>,<variable o constante>,<tamaño>);

Leer:Lea una línea en el archivo indicado por el <controlador de archivos> y arroje el valor de lectura en una <variable>.

Sintaxis: Lernl (<file_handler>,<variable>);

Registro:Escribe una línea en el archivo indicado por el <controlador de archivos> con el valor contenido en la variable especificada.

Sintaxis: Gravarnl(<file_handler>,<variable o constante>);

Insertar:Hace que el sistema inserte un archivo en la regla actual, en tiempo de ejecución/compilación.

Sintaxis: Inserte “<nombre_de_archivo>”;

ValStr:Usado solo en el generador, para cambiar la descripción de un campo Descripción. El texto pasado a ValStr se imprimirá en lugar de la descripción del campo original.

Los cursores no son más que un SELECT en una regla, devolviendo registros que satisfacen la condición informada en la propiedad SQL de un Cursor.

Los siguientes comandos se utilizan junto con los cursores:

SQL: Se utiliza para definir un comando SQL para el cursor.

Sintaxis: <nombre_cursor>.SQL “<comando_SQL>”;

Cursor abierto: Abre un cursor.

Sintaxis: <nombre_cursor>.OpenCursor();

Cerrar Cursor: Cierra un cursor.

Sintaxis: <nombre_cursor>.CloseCursor();

Próximo: Lee el siguiente registro desde el cursor.

Sintaxis: <nombre_cursor>.Next();

<campos> Se puede acceder directamente a los campos pertenecientes al cursor. Los campos son de “Solo Lectura”, es decir, no se pueden modificar.

Sintaxis: <nombre_cursor>.<nombre_campo>

El pensó: Devuelve verdadero si encuentra alguna línea de cursor.

Sintaxis: <nombre_cursor>.Found

No encontró: Devuelve verdadero si no se encontraron líneas de cursor.

Sintaxis: <cursor_name>.Not Found

Las funciones son comandos predefinidos por el sistema, que realizan operaciones específicas y que pueden o no devolver valores. Generalmente, una función cuando se ejecuta, necesita parámetros.

Funciones generales

ConvertDataBank (Fuente_Fecha, Destino_Fecha): Esta función convierte cualquier fecha al formato de fecha de la base de datos.

Parámetros:

Date_Origin: es el campo de la tabla o la variable de tipo de fecha que desea convertir.

Data_Destino: es una variable tipo Alpha, que contendrá el retorno de la conversión.

ConvertMask(Tipo_datos,Valor_origen,Alfa_origen/Destino,Máscara): Esta función convierte un valor dado, que está en una máscara específica, a otra máscara, llevando la conversión a la variable especificada en Alpha_Source/Destination.

Parámetros:

Tipo_de_datos: Puede ser: 1=Número, 2=Dinero (cantidad), 3=Fecha, 4=Hora, 5=Alfa.

Source_Value: Campo/Variable/Valor a convertir.

Alpha_Origin/Destination: Variable alfa que recibirá el resultado de la conversión.

Máscara: especifique el formato en el que se debe mostrar el resultado de la conversión.

Utilizado en: Informes, siempre que sea necesario cambiar la máscara de edición de algún valor en el momento de la ejecución del informe. Uno de los casos es el ejemplo anterior.

InsertAlpha (Source_Text, Destination_Variable, Initial_Position): Esta función inserta uno o más caracteres en una Variable/Campo, comenzando desde la posición indicada. Es decir, si el campo alfa en el que se va a insertar el texto ya contiene información, los de la posición indicada se desplazarán hacia la derecha y todo lo que supere el tamaño definido del campo/variable se truncará.

Parámetros:

Source_Text: variable de texto/alfa a insertar.

Destination_Variable: Variable de tipo alfa, en la que se quiere insertar el texto.

Initial_Position: Posición inicial de Destination_Variable, desde donde se insertará el source_text.

Usado en: Siempre que sea necesario tratar parte de una variable alfa.

Leer PositionAlpha (Origen, Destino, Posición): Esta función identifica qué carácter está en una determinada posición del campo/variable de origen.

Parámetros:

Origen: Tipo alfa de campo/variable que desea verificar.

Destino: Variable numérica que recibirá el carácter leído.

Posición: Posición del campo/variable de origen que desea identificar el carácter.

DeleteAlpha (Variable/Campo, Posición, Cantidad): Esta función borra (borra) un cierto número de caracteres de una variable/campo, comenzando desde la posición informada.

Parámetros:

Variable/Campo: Nombre del campo o variable alfabética del que se van a borrar los caracteres.

Posición: Posición del campo/variable del cual se deben borrar caracteres.

Cantidad: Número de caracteres que se deben eliminar de la posición ingresada.

CopyAlpha(Origen,Init_Position,Cantidad): Esta función copia parte del contenido de una variable/campo a la variable/campo de origen.

Parámetros:

Fuente: Variable/Campo Alfa de donde se va a copiar parte del contenido.

Initial_Position: Posición desde la que copiar los caracteres.

Cantidad: número de caracteres que se copiarán desde Initial_Position.

SizeAlpha (Origen,Tamaño): Esta función comprueba el tamaño del campo alfa especificado en Fuente.

Parámetros:

Origen: Campo/Variable Alfa cuyo tamaño desea conocer.

Tamaño: Número de tipo de variable que devolverá el tamaño del campo/variable especificado en Origen.

PositionAlpha (Texto_Búsqueda, Campo_Búsqueda, Posición): Esta función busca un fragmento de texto dentro de un campo/variable de tipo alfabético y regresa donde comienza el texto.

Parámetros:

Search_Text: Ingrese el texto que está buscando entre comillas.

Field_Research: Nombre del campo/variable de tipo alfa en el que desea buscar.

Posición: Devolverá la posición inicial del texto buscado, dentro del Field_Research.

IntToAlpha (Source_Num, Destination_Alpha): Esta función convierte un número a formato alfanumérico, sin tener en cuenta los lugares decimales.

Parámetros:

Num_Origem: Número de tipo de campo/variable que se convertirá.
Alfa_Destino: Campo/variable tipo alfa que recibirá el resultado de la conversión.

Usado en: Cuando existe la necesidad, por ejemplo, de concatenar el número a otro campo/variable de tipo alfabético.

AlphaToInt(Alpha_Source,Num_Destination): Esta función convierte un número almacenado en un campo de tipo alfabético en un campo de tipo numérico, sin tener en cuenta los lugares decimales. En caso de imposibilidad de conversión, el resultado será CERO.

Parámetros:

Alpha_Origin: Campo/variable de tipo alfa que contiene el número a convertir.

Num_destino: Campo/Variable tipo Número que recibirá el resultado de la conversión.

Usado en: Cuando existe la necesidad, por ejemplo, de realizar operaciones aritméticas con este número.

CharacterToAlpha(Carácter,Destino): Esta función convierte un carácter (que está almacenado por el código Ascii) al valor alfanumérico correspondiente.

Parámetros:

Carácter: Campo/Variable tipo Número/Carácter, que contiene el código Ascii de un carácter.

Destino: Variable tipo Alfa que recibirá el resultado de la conversión.

MountDate (Día, Mes, Año, Fecha): Esta función concatena tres variables, formando una fecha.

Parámetros:

Día: Variable que contiene el día de la fecha a generar.

Mes: Variable que contiene el mes de la fecha a generar.

Año: Variable que contiene el año de la fecha a generar. Es importante recordar que el año debe tener 4 lugares, es decir debe tener, por ejemplo, 1998.

Fecha: Número de tipo variable que recibirá el resultado de la conversión.

Fecha de desmontaje (fecha, día, mes, año): Esta función desensambla una fecha, separando la información de Día/Mes/Año de la fecha en tres variables.

Parámetros:

Fecha: Campo/Variable tipo fecha a desmantelar.

Día: Número de tipo variable que recibirá el día de la fecha a desmontar.

Mes: Número de tipo variable que recibirá el mes de la fecha a desmontar.

Año: Número de tipo variable que recibirá el año de la fecha a desmontar.

Utilizado en: Siempre que exista la necesidad de probar los elementos de una fecha de forma aislada.

Duración de la fecha (fecha, duración):Esta función genera la extensión de una fecha determinada.

Parámetros:

Fecha: Campo/Variable tipo fecha a partir de la cual se va a generar la prórroga.

Duración: Variable de tipo alfa que recibirá la duración de la fecha.

ThisNull(Variable,Retorno); Esta función comprueba si un campo de tipo alfabético es nulo o no.

Parámetros:

Variable: Tipo de campo/variable alfa que desea verificar.

Retorno: Número de tipo de variable que devolverá UNO si la variable es nula y CERO si no lo es.

Último día (fecha): Esta función comprueba cuál es el último día del mes/año de la fecha informada, devolviendo esta nueva fecha día/mes/año en la variable indicada.

Parámetros:

Fecha: Campo/Variable de tipo fecha de la que se quiere saber el último día del mes.

Longitud (Valor,Tamaño_Línea1,Tamaño_Línea2,Tamaño_Línea3,Línea1,Línea2,Línea3): Esta función genera la longitud de un valor.

Parámetros:

Valor: Campo/Variable del que se quiere obtener el extenso.

Size_Linha1: Número de caracteres que se utilizarán en la primera línea para generar la extensión.

Size_Linha2: Número de caracteres que se utilizarán en la segunda línea para generar la extensión.

Size_Linha3: Número de caracteres que se utilizarán en la tercera línea para generar la extensión.

Line1: Variable tipo Alpha que recibirá la primera línea de la extensión de valor.

Línea2: Variable tipo Alfa que recibirá la segunda línea de la extensión de valor.

Línea3: Variable tipo Alfa que recibirá la tercera línea de la extensión de valor.

Extensión del mes (fecha, extensión): Esta función ensambla la extensión del mes de una fecha dada.

Parámetros:

Fecha: Campo/Variable tipo fecha a partir de la cual se va a obtener la duración del mes.

Extensiva: Variable tipo Alfa que recibirá la extensión del mes.

ExtendWeek (fecha, duración): Esta función ensambla la extensión del día de la semana de una fecha dada.

Parámetros:

Fecha: Campo/Variable de tipo fecha a partir de la cual se quiere obtener la duración del día.

Extensiva: Variable tipo Alfa que recibirá la extensión del día de la semana.

BreakText(Texto,Tamaño_de_línea,Cantidad_de_línea):Esta función toma el texto indicado y realiza asignaciones de saltos de línea de acuerdo con Line_Size especificado, y devuelve el número de líneas que se utilizarán para imprimir el texto.

Parámetros:

Texto: Tipo de campo/variable alfa que desea imprimir en más de una línea.

Line_Size: número máximo de caracteres por línea.

Qtde_Linhas: Variable de tipo Número que devolverá el número de líneas que serán necesarias para imprimir el texto.

BuscarLinhaTexto (Texto,Nro_Linha,Texto_Linha):Esta función se utiliza para imprimir las líneas de texto que ha dividido la función Textwrap.

Parámetros:

Texto: Será el mismo Campo/variable tipo Alfa indicado en la función Salto de Texto.

Line_Number: Número de línea a imprimir.

Text_Line: Variable de tipo alfa que devolverá la parte del Texto que se imprimirá.

RemainderDivision (Dividendo, Divisor, Resto):Esta función devuelve el resto de dividir un número por otro.

Parámetros:

Dividendo: Campo/Variable tipo Número que se dividirá.

Divisor: Campo/Variable tipo Número por el cual se dividirá el Dividendo.

Resto: Número de tipo variable que recibirá el resto de la división.

TruncarValor (Valor): Esta función elimina los decimales del valor pasado, sin realizar ningún tipo de redondeo.

Parámetros:

Valor = Campo/Variable desea mantener solo la parte entera del valor.

RoundValue (Valor,Cantidad_Casas): Esta función redondea un determinado valor, según el número de decimales informado.

Parámetros:

Valor: Campo/Variable que será redondeado.

Cant_Casas: Número de decimales a redondear. Si se informa 0 (cero), se redondea a la parte entera del resultado.

Concatenar (Texto1, Texto2, Texto3, Destino): Esta función concatena hasta 3 campos/variables alfa, formando una sola variable.

Parámetros:

Texto1: Tipo de campo/variable alfa que se concatenará.

Texto2: Campo/variable tipo alfa que se concatenará.

Text3 : Tipo alfa de campo/variable que se concatenará.

Destino: variable de tipo alfa que recibirá el resultado de la concatenación.

CalculateQtyMinutes (DatIni,HorIni,DatFim,Horfim,Qty_Minutes): Esta función calcula el número de minutos entre una fecha/hora de inicio y una fecha/hora de finalización.

Parámetros:

DatIni: Campo/Variable tipo fecha, inicial.

HorIni: Campo/Variable tipo tiempo, inicial.

DateFim: Campo/Variable tipo fecha, fin.

EndHor: Campo/Variable tipo tiempo, fin.

Qty_Minutos: Devuelve el número de minutos entre la fecha/hora de inicio y la fecha/hora de finalización.

Funciones sin parámetros

FechaSis:Devuelve la fecha actual del sistema.

DaySis:Devuelve el día del mes a partir de la fecha del sistema

Mes: Devuelve el mes del sistema

AñoSis:Devuelve el año del sistema con 4 posiciones

ExtSis:fecha completa

HorSis:hora del sistema

PagNum:Número de página de los informes.

Nombre de usuario: nombre de usuario registrado

Desenchufar: Descripción de la plantilla a utilizar en el pie de página.