En esta sección: |
|
Este tema describe todos los comandos de Dialogue Manager.
-* señala el principio de una línea de comentarios.
Puede tener tantas líneas como estime oportuno, aunque cada línea debe comenzar por -*. Puede colocar la línea de comentarios al principio o al final de un procedimiento, o entre los comandos. Sin embargo, no puede estar en la misma línea que un comando.
Emplee las líneas de comentarios para documentar los procedimientos y aclarar su propósito e historial al resto de usuarios.
La sintaxis es:
-* textdonde:
Es un comentario. No es necesario introducir un espacio entre -* y text.
-? muestra el valor actual de una variable local.
La sintaxis es:
-? &[string]donde:
Es el nombre de una variable. Si no especifica este parámetro, se muestran todos los valores actuales de todas las variables locales, globales, definidas por el sistema y estadísticas.
-CLOSE cierra un archivo externo abierto con el comando -READ o -WRITE, mediante la opción NOCLOSE. La opción NOCLOSE mantiene el archivo abierto hasta que termine la operación -READ o -WRITE.
La sintaxis es:
-CLOSE filenamedonde:
Es un nombre simbólico asociado a un archivo físico, conocido por el sistema operativo.
Los comandos -DEFAULT establecen los valores por defecto de las variables locales o globales. La introducción de valores por defecto para las variables almacenadas en un procedimiento almacenado, ayuda a garantizar que la ejecución sea correcta.
Puede emitir múltiples comandos -DEFAULT para una variable. Si la variable es global, estos comandos -DEFAULT pueden emitirse en FOCEXECs independientes. El último comando -DEFAULT emitido siempre estará en vigor antes de usar otro método para establecer el valor de la variable.
Sin embargo, en cuanto se establezca el valor de la variable utilizando cualquier otro método (por ejemplo, emitiendo un comando -SET, recuperando un valor introducido por el usuario o leyendo el valor de un archivo), se ignorarán los comandos -DEFAULT posteriores, emitidos para esa variable.
La sintaxis es:
-DEFAULT &[&]name=value [...]
donde:
Es el nombre de una variable.
Es el valor por defecto asignado a la variable.
Los comandos -DEFAULTH establecen los valores por defecto de las variables ocultas.
Para inicializar una variable y evitar que sea utilizada con el aviso de parámetros de WebFOCUS, emplee el comando -DEFAULTH. Las variables inicializadas con -DEFAULTH no se devuelven junto con el XML que describe la información utilizada para el aviso de parámetros. Puesto que estas variables no pueden mostrarse con las características de aviso de parámetros, el usuario no puede verlas.
La sintaxis es:
-DEFAULTH &[&]name=value [...]
donde:
Es el nombre de una variable. Esta variable no se usa con el aviso de parámetro y permanece oculta al usuario.
Es el valor por defecto asignado a la variable.
-DOS ejecuta un comando del sistema operativo DOS desde un procedimiento.
La sintaxis es:
-DOS commanddonde:
Es un comando DOS.
-EXIT fuerza la terminación de un procedimiento. Se ejecutan todos los comandos apilados y el procedimiento finaliza. Si el procedimiento fue llamado por otro procedimiento, el procedimiento que efectuó la llamada continúa el procesamiento.
Emplee -EXIT para terminar un procedimiento después de procesar una bifurcación que completa la tarea deseada. La última línea de un procedimiento es un -EXIT implícito.
La sintaxis es:
-EXIT
-GOTO transfiere el control a una etiqueta especificada.
Si Dialogue Manager localiza la etiqueta, el procesamiento continúa por la línea inmediatamente posterior. Si Dialogue Manager no localiza la etiqueta, el procesamiento finaliza y aparece un mensaje de error.
La sintaxis es:
-GOTO label . . -label [TYPE text]
donde:
Es un nombre definido por el usuario, de hasta 64 caracteres, que especifica el destino de la acción -GOTO.
No use espacios en blanco insertados ni el nombre de otro comando de Dialogue Manager, excepto -QUIT o -EXIT. No emplee palabras que puedan confundirse con funciones, operaciones lógicas o aritméticas, etc.
Envía un mensaje a la aplicación cliente.
-HTMLFORM envía la salida del informe al archivo HTML que ha creado para la página Web, y muestra la página en el navegador. La salida también puede guardarse como archivo HTML que podrá mostrarse más adelante.
La sintaxis es:
-HTMLFORM filename [SAVE AS htmlpage]
o
-HTMLFORM BEGIN . . . -HTMLFORM END
donde:
Es el archivo HTML que contiene los marcadores de posición del informe, o informes, creado por WebFOCUS con el comando:
ON TABLE HOLD HTMTABLE AS reportIndica que la página HTML, creada al combinar el filename del archivo HTML y el informe, o informes, creado por WebFOCUS, se va a guardar.
Es el nombre del archivo de la página HTML creada al combinar el filename del archivo HTML y el informe, o informes, creado por WebFOCUS. Este archivo queda guardado para poder mostrarlo más adelante.
Señala el principio de un formulario HTML en línea, en un procedimiento.
Señala el final de un formulario HTML en línea, en un procedimiento.
-IF enruta la ejecución de un procedimiento basado en la evaluación de una expresión especificada.
Los comandos -IF que no tengan un ELSE especificado explícitamente y cuya expresión sea falsa, continúan procesándose con la línea inmediatamente posterior.
La sintaxis es:
-IF expression [THEN] GOTO label1; [ELSE GOTO label2;] [ELSE IF...;]
donde:
Es un nombre definido por el usuario, de hasta 64 caracteres, que especifica el destino de la acción GOTO.
No use espacios en blanco insertados ni el nombre de otro comando de Dialogue Manager, excepto -QUIT o -EXIT. No emplee palabras que puedan confundirse con funciones, operaciones lógicas o aritméticas, etc.
Es una expresión válida. Los valores literales no necesitan estar entre comillas simples a menos que contengan espacios en blanco o comas insertados.
Es un código opcional que mejora la legibilidad del comando.
Pasa el control a label2 cuando falla la prueba -IF.
Especifica una prueba -IF compuesta.
El punto y coma es obligatorio al final del comando, mientras que las líneas de continuación deben empezar por un guión.
-INCLUDE permite que un procedimiento llame a otro. Un procedimiento puede llamar a un número indeterminado de procedimientos. Puede anidar hasta cuatro comandos -INCLUDE.
El procedimiento llamado puede tener un código parcial o completamente ejecutable. No se puede bifurcar el procedimiento que está efectuando la llamada en una etiqueta perteneciente a un procedimiento invocado, ni viceversa.
Nota: El CGI emplea un comando -INCLUDE para llamar al CGI WebFOCUS. Por tanto, el usuario final puede incluir sólo tres comandos -INCLUDE anidados. Esto no ocurre cuando se usa edastart.
La sintaxis es:
-INCLUDE filenamedonde:
Es el nombre del procedimiento llamado.
Para información sobre la sintaxis utilizada con los nombres de archivos completamente cualificados, consulte Cómo usar nombres completamente cualificados con el comando -Include.
-label es el destino de un comando -GOTO o de criterios -IF.
La sintaxis es:
-label [TYPE message]
donde:
Es un nombre definido por el usuario, de hasta 64 caracteres, que identifica el destino de una bifurcación.
No use espacios en blanco insertados ni el nombre de otro comando de Dialogue Manager, excepto -QUIT o -EXIT. No emplee palabras que puedan confundirse con funciones, operaciones lógicas o aritméticas, etc.
Envía un mensaje a la aplicación cliente.
En WebFOCUS, ejecuta un comando del sistema operativo MVS desde un procedimiento.
La sintaxis es:
-MVS commanddonde:
Es un comando MVS.
-PASS emite y controla directamente las contraseñas. Esta característica resulta útil sobre todo para especificar un archivo o grupo de archivos determinado, en el que un usuario determinado pueda leer y escribir. Las contraseñas tienen conjuntos detallados de funciones asociados a ellas a través del recurso DBA.
Puede cifrar el procedimiento y las contraseñas que establece. .
Puede asociar una variable a -PASS que asigne y solicite un valor de contraseña.
La sintaxis es:
-PASS passworddonde:
Es una contraseña FOCUS literal o una variable que contiene la contraseña.
-QUIT fuerza la salida inmediata de un procedimiento. No se ejecutan los comandos apilados.
Si el procedimiento fue llamado por otro procedimiento, el control vuelve directamente a la aplicación cliente, no al procedimiento que efectuó la llamada.
-QUIT también puede ser el destino de una bifurcación.
La sintaxis es:
-QUIT
En Developer Studio, -QUIT FOCUS finaliza un procedimiento y sale de WebFOCUS. El usuario regresa al sistema operativo o al programa de llamada.
Después de salir de FOCUS, el valor es devuelto al programa que realiza la llamada, si existe. Esto es útil cuando se está llamando a FOCUS desde otra aplicación Windows, para que devuelva un código de devolución indicando el punto en que se cerró FOCUS.
-QUIT FOCUS también puede ser el destino de una bifurcación, produciendo el resultado descrito anteriormente.
La sintaxis es:
-QUIT FOCUS [n]donde:
Es el valor del código de devolución de la aplicación. Puede tratarse de una constante o de una variable de número entero.
Si no introduce un valor o proporciona uno que no sea un número entero, el código de devolución es 0 (valor por defecto).
-READ permite leer datos de un archivo externo definido en el sistema operativo.
La longitud de la lista de variables debe ser conocida para que aparezca -READ. Emplee -DEFAULT para establecer el número de caracteres esperado para cada variable.
Si la lista de variables no cabe en una línea, termine la primera línea con una coma y comience la siguiente por un guión cuando esté leyendo un archivo de formato libre.
-READ EXTFILE, &CITY, &CODE1, - &CODE2
Si está leyendo un archivo de formato fijo, comience la línea siguiente por un guión y una coma:
-READ EXTFILE &CITY.A8. &CODE1.A3., -, &CODE2.A3.
La sintaxis es:
-READ filename[,] [NOCLOSE] &name[.format.][,]...
donde:
Es el nombre del archivo externo que va a ser leído; debe estar definido en el sistema operativo. Un espacio después de filename denota un archivo de formato fijo, mientras que una coma situada a continuación de filename indica uno de formato libre.
Mantiene abierto el archivo externo hasta que se complete la operación -READ. Para cerrar un archivo que se mantiene abierto con NOCLOSE, emplee el comando -CLOSE filename.
Es una lista de variables. Aunque no es obligatorio, en los archivos de formato libre puede separar con comas los nombres de las variables.
Es el formato de la variable. Puede ser alfanumérico (A) o numérico (I). Tenga en cuenta que el formato debe estar delimitado por puntos. El formato se ignora en los archivos delimitados por comas.
-REPEAT permite el uso de un bucle en un procedimiento almacenado. El bucle finaliza cuando ocurre lo siguiente:
La sintaxis es:
-REPEAT label n TIMESo
-REPEAT label WHILE condition;
o
-REPEAT label FOR &variable [FROM fromval] [TO toval] [STEP s]
donde:
Identifica el código que se va a repetir (el bucle). Si el nombre de las etiquetas del primer y segundo bucle no es el mismo, puede incluir otro bucle.
Especifica el número de veces en que se va a repetir el bucle. El valor de n puede tratarse de una variable local o global, o de una constante. Si es una variable, sólo se evalúa una vez; no puede cambiar el número de veces en que se va a ejecutar el bucle. Para finalizar el bucle antes de tiempo, emplee -QUIT o -EXIT.
Especifica la condición de ejecución del bucle. La condición puede ser cualquier expresión lógica verdadera o falsa. El bucle se ejecuta cuando la condición es verdadera.
Es una variable que se prueba al principio de cada ejecución del bucle. Se compara con el valor de fromval y de toval (si se han proporcionado). El bucle se ejecuta sólo cuando &variable es inferior o igual a toval y STEP es positivo, o superior o igual a toval y STEP es negativo. Si no está usando toval, debe emplear otra opción, como n TIMES.
Es una constante comparada con &variable al inicio de cada ejecución del bucle. 1 es el valor predeterminado.
Es un valor comparado con &variable al inicio de cada ejecución del bucle. El valor predeterminado es 1,000,000.
Es una constante utilizada para incrementar &variable al final de cada ejecución del bucle. Puede ser positivo o negativo. 1 es el valor predeterminado.
Nota: Los parámetros FROM, TO y STEP pueden aparecer en cualquier orden.
-RUN provoca la ejecución inmediata de todos los comandos apilados.
Tras la ejecución, el procesamiento del procedimiento almacenado continúa por la línea posterior a -RUN.
-RUN suele utilizarse para lo siguiente:
La sintaxis es:
-RUN
-SET asigna un valor literal, o un valor calculado en una expresión lógica o aritmética, a una variable.
El uso de las comillas simples alrededor de un valor literal es opcional a menos que tenga insertado un espacio en blanco, una coma o un signo de igualdad, en cuyo caso es obligatorio.
La sintaxis es:
-SET &[&]name= {expression|value};
donde:
Es el nombre de la variable cuyo valor va a ser establecido.
Es una expresión válida. Las expresiones pueden ocupar varias líneas, así que debe finalizar el comando con un punto y coma (;).
Es un valor literal asignado a la variable. Si el valor literal contiene comas o espacios en blanco insertados, debe colocarlo entre comillas simples. Si el valor sólo presenta una comilla simple, coloque dos comillas simples en el lugar en que quiere que aparezca el valor.
En WebFOCUS, -TSO ejecuta un comando del sistema operativo TSO desde un procedimiento. Esto funciona únicamente cuando el comando es RUN.
La sintaxis es:
-TSO commanddonde:
Es un comando TSO RUN.
-TYPE envía un mensaje a una aplicación cliente.
Puede tener tantos comandos -TYPE como estime oportuno, aunque cada comando debe comenzar por -TYPE.
Las variables pueden insertarse en el mensaje. Aparecen los valores asignados actualmente a cada variable.
La sintaxis es:
-TYPE textdonde:
Es un mensaje enviado a la aplicación cliente, seguido de un avance de línea. Si pone text entre comillas, éstas aparecerán como parte del mensaje.
text puede tener una longitud máxima de 256 caracteres.
En WebFOCUS, -UNIX ejecuta un comando del sistema operativo UNIX desde un procedimiento.
La sintaxis es:
-UNIX commanddonde:
Es un comando UNIX.
En WebFOCUS, -VMS ejecuta un comando del sistema operativo VMS desde un procedimiento.
La sintaxis es:
-VMS commanddonde:
Es un comando VMS.
-WINNT ejecuta un comando del sistema operativo Windows desde un procedimiento.
La sintaxis es:
-WINNT commanddonde:
Es un comando Windows.
-WRITE escribe datos en un archivo externo.
Si el comando ocupa varias líneas, coloque una coma al final de la primera y un guión al principio de las líneas posteriores.
A menos que especifique la opción NOCLOSE, cualquier archivo que permanezca abierto al finalizar el procedimiento, se cierra con -RUN, -EXIT o -QUIT.
La sintaxis es:
-WRITE filename [NOCLOSE] text
donde:
Es el nombre de un archivo físico externo en que se está escribiendo. El sistema operativo debe saber cuál es el filename.
Mantiene abierto el archivo externo hasta que se complete la operación -WRITE. Para cerrar un archivo que se mantiene abierto con NOCLOSE, emplee el comando -CLOSE filename.
Es cualquier combinación de variables y texto.
| WebFOCUS |