]> git.llucax.com Git - mecon/yatta.git/commitdiff
Agrego documentación sobre el alta de nuevos procesos para futura ejecución.
authorLeandro Lucarella <llucax@gmail.com>
Mon, 29 Mar 2004 15:35:56 +0000 (15:35 +0000)
committerLeandro Lucarella <llucax@gmail.com>
Mon, 29 Mar 2004 15:35:56 +0000 (15:35 +0000)
doc/procesos/procesos.lyx [new file with mode: 0644]
doc/procesos/procesos.pdf [new file with mode: 0644]

diff --git a/doc/procesos/procesos.lyx b/doc/procesos/procesos.lyx
new file mode 100644 (file)
index 0000000..c9312f9
--- /dev/null
@@ -0,0 +1,133 @@
+#LyX 1.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 221
+\textclass article
+\language spanish
+\inputencoding auto
+\fontscheme palatino
+\graphics default
+\paperfontsize default
+\spacing single 
+\papersize a4paper
+\paperpackage widemarginsa4
+\use_geometry 0
+\use_amsmath 0
+\use_natbib 0
+\use_numerical_citations 0
+\paperorientation portrait
+\secnumdepth 3
+\tocdepth 3
+\paragraph_separation indent
+\defskip medskip
+\quotes_language english
+\quotes_times 2
+\papercolumns 1
+\papersides 1
+\paperpagestyle default
+
+\layout Title
+
+Yatta
+\layout Date
+
+MEcon
+\layout Author
+
+Martín Marrese <mmarre@mecon.gov.ar>
+\layout Standard
+\pagebreak_top \pagebreak_bottom 
+
+\begin_inset LatexCommand \tableofcontents{}
+
+\end_inset 
+
+
+\layout Section
+
+Agregar un Proceso
+\layout Standard
+
+El método estático YATTA_Controlador::agregarProceso es el encargado de
+ dar de alta los nuevos procesos, y de ponerlos en la cola de ejecución.
+ Este método recibe como parámetro una conexión a la base de datos y un
+ array asociativo con los atributos del proceso.
+ Devuelve un PEAR_Error en caso de haberlo.
+\layout Subsection
+
+Formato del array de datos
+\layout Standard
+
+El array asociativo de datos está compuesto por claves obligatorias y claves
+ opcionales.
+ Es de suma importancia que se respete el formato de la clave (mayúsculas/minúsc
+ulas).
+\layout Itemize
+
+Obligatorias
+\layout Enumerate
+
+script : path completo del script.
+ Con esto se hará el require once al momento de la ejecución.
+\layout Enumerate
+
+id_sistema : es el identificador numérico asignado al sistema en SAMURAI.
+\layout Enumerate
+
+descripción : es un texto descriptivo del proceso que será mostrado en la
+ interfaz web al usuario.
+\layout Enumerate
+
+owner : login@organismo del usuario que está iniciando el proceso.
+ Si el proceso genera un archivo resultado, éste ocupará espacio en la cuenta
+ de este usuario.
+\layout Itemize
+
+Opcionales
+\layout Enumerate
+
+destinos : login@organismo de los destinos.
+ Son aquellos que tendrán acceso al resultado del proceso.
+\layout Enumerate
+
+prioridad : indica la prioridad del proceso.
+ Se utilizará para ponderar la ejecución de los sistemas.
+\layout Enumerate
+
+notificar : indica si hay que avisarle al owner (y destinos) sobre la finalizaci
+ón de la ejecución del proceso.
+\layout Enumerate
+
+resultado : este es el nombre del archivo resultado que hay que mostrarle
+ al usuario en la interfaz web.
+ No es necesariamente el mismo nombre que tendrá el archivo real de resultado.
+\layout Section
+
+Formato del Archivo Proceso
+\layout Standard
+
+Cuando se quiere lanzar el proceso el script que corre en el servidor llama
+ a una función que devuelve una instancia del objeto.
+ Este objeto tiene que cumplir ciertas condiciones para que pueda ejecutarse
+ y obtener los datos cuando finaliza.
+\layout Standard
+
+La función debe llamarse create_process, la cual no recibe parámetro alguno.
+ Ésta devuelve una instancia del objeto proceso.
+\layout Standard
+
+El objeto debe tener un método run, que no recibe parámetros, el cual es
+ invocado a la hora de ejecutar el proceso.
+ Una vez que éste finaliza debe dejar en 3 atributos datos que son utilizados
+ para dar por finalizados la ejecución.
+\layout Itemize
+
+error : contiene cualquier mensaje de error que se hubiera producido.
+\layout Itemize
+
+archivo : contiene el path completo del archivo que se generó como resultado.
+\layout Itemize
+
+notificar : indica si hay que notificar al responsable.
+\the_end
diff --git a/doc/procesos/procesos.pdf b/doc/procesos/procesos.pdf
new file mode 100644 (file)
index 0000000..48728f3
Binary files /dev/null and b/doc/procesos/procesos.pdf differ