doc/procesos/procesos.lyx

   1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 221
   3 \textclass article
   4 \language spanish
   5 \inputencoding auto
   6 \fontscheme palatino
   7 \graphics default
   8 \paperfontsize default
   9 \spacing single
  10 \papersize a4paper
  11 \paperpackage widemarginsa4
  12 \use_geometry 0
  13 \use_amsmath 0
  14 \use_natbib 0
  15 \use_numerical_citations 0
  16 \paperorientation portrait
  17 \secnumdepth 3
  18 \tocdepth 3
  19 \paragraph_separation indent
  20 \defskip medskip
  21 \quotes_language english
  22 \quotes_times 2
  23 \papercolumns 1
  24 \papersides 1
  25 \paperpagestyle default
  26
  27 \layout Title
  28
  29 Yatta
  30 \layout Date
  31
  32 MEcon
  33 \layout Author
  34
  35 Martín Marrese <mmarre@mecon.gov.ar>
  36 \layout Standard
  37 \pagebreak_top \pagebreak_bottom
  38
  39 \begin_inset LatexCommand \tableofcontents{}
  40
  41 \end_inset
  42
  43
  44 \layout Section
  45
  46 Agregar un Proceso
  47 \layout Standard
  48
  49 El método estático YATTA_Controlador::agregarProceso es el encargado de
  50  dar de alta los nuevos procesos, y de ponerlos en la cola de ejecución.
  51  Este método recibe como parámetro una conexión a la base de datos y un
  52  array asociativo con los atributos del proceso.
  53  Devuelve un PEAR_Error en caso de haberlo.
  54 \layout Subsection
  55
  56 Formato del array de datos
  57 \layout Standard
  58
  59 El array asociativo de datos está compuesto por claves obligatorias y claves
  60  opcionales.
  61  Es de suma importancia que se respete el formato de la clave (mayúsculas/minúsc
  62 ulas).
  63 \layout Itemize
  64
  65 Obligatorias
  66 \layout Enumerate
  67
  68 script : path completo del script.
  69  Con esto se hará el require once al momento de la ejecución.
  70 \layout Enumerate
  71
  72 id_sistema : es el identificador numérico asignado al sistema en SAMURAI.
  73 \layout Enumerate
  74
  75 descripción : es un texto descriptivo del proceso que será mostrado en la
  76  interfaz web al usuario.
  77 \layout Enumerate
  78
  79 owner : login@organismo del usuario que está iniciando el proceso.
  80  Si el proceso genera un archivo resultado, éste ocupará espacio en la cuenta
  81  de este usuario.
  82
  83 \layout Itemize
  84
  85 Opcionales
  86 \layout Enumerate
  87
  88 destinos : login@organismo de los destinos.
  89  Son aquellos que tendrán acceso al resultado del proceso.
  90
  91 \layout Enumerate
  92
  93 prioridad : indica la prioridad del proceso.
  94  Se utilizará para ponderar la ejecución de los sistemas.
  95 \layout Enumerate
  96
  97 notificar : indica si hay que avisarle al owner (y destinos) sobre la finalizaci
  98 ón de la ejecución del proceso.
  99 \layout Enumerate
 100
 101 resultado : este es el nombre del archivo resultado que hay que mostrarle
 102  al usuario en la interfaz web.
 103  No es necesariamente el mismo nombre que tendrá el archivo real de resultado.
 104 \layout Section
 105
 106 Formato del Archivo Proceso
 107 \layout Standard
 108
 109 Cuando se quiere lanzar el proceso el script que corre en el servidor llama
 110  a una función que devuelve una instancia del objeto.
 111  Este objeto tiene que cumplir ciertas condiciones para que pueda ejecutarse
 112  y obtener los datos cuando finaliza.
 113 \layout Standard
 114
 115 La función debe llamarse create_process, la cual no recibe parámetro alguno.
 116  Ésta devuelve una instancia del objeto proceso.
 117 \layout Standard
 118
 119 El objeto debe tener un método run, que no recibe parámetros, el cual es
 120  invocado a la hora de ejecutar el proceso.
 121  Una vez que éste finaliza debe dejar en 3 atributos datos que son utilizados
 122  para dar por finalizados la ejecución.
 123
 124 \layout Itemize
 125
 126 error : contiene cualquier mensaje de error que se hubiera producido.
 127 \layout Itemize
 128
 129 archivo : contiene el path completo del archivo que se generó como resultado.
 130 \layout Itemize
 131
 132 notificar : indica si hay que notificar al responsable.
 133 \the_end