Diferencia entre revisiones de «Funciones platino»

De Egeasy
Saltar a: navegación, buscar
 
(No se muestran 64 ediciones intermedias de 2 usuarios)
Línea 1: Línea 1:
−
Este artículo describe las interfaces de las funciones que se han diseñado para la integración de '''egeasy''' con '''PLATINO'''.
+
<p>Este artículo describe las interfaces de las funciones que se han diseñado para la integración de '''egeasy''' con '''PLATINO'''.</p>
 +
<p>Todas las funciones definidas sólo se pueden invocar desde ficheros de métodos (*.nmt).</p>
  
 
==Registrar entrada y salida==
 
==Registrar entrada y salida==
−
Este servicio nos permite registrar documentos de entrada y salida. Para comunicarnos con él se han diseñado tres funciones:
+
<p>Este servicio nos permite registrar documentos de entrada y salida. Para comunicarnos con él se han diseñado tres funciones:</p>
  
−
$platino_registrar_entrada(Organismo:texto, Asunto:texto, Remitente:texto, NIF: texto, sal Fecha: fecha, sal Hora: texto, sal Numero: texto, sal Clasificador: clasificador[, Documentos: clasificador])
+
<blockquote style="border: 3px solid #993365; background: #F9F9F9; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left">
 +
<code>'''$esb_registrar_entrada'''(Organismo: {{T|texto}}, Asunto: {{T|texto}}, Remitente: {{T|texto}}, NIF: {{T|texto}}, sal Fecha: {{T|fecha}}, sal Hora: {{T|texto}}, sal Numero: {{T|texto}}, sal Resguardo: {{T|clasificador}}[, Documentos {{T|clasificador}}])</code>
 +
</blockquote><br/>
  
−
Esta función permite registrar documentos de entrada PDF. No devuelve nada. Los datos devueltos se almacenan en las variables de salida. Los parámetros son:
+
<p>Esta función permite registrar documentos de entrada PDF. No devuelve nada. Los datos devueltos se almacenan en las variables de salida. Los parámetros son:</p>
 
*'''Organismo''': organismo en el que entra en documento.
 
*'''Organismo''': organismo en el que entra en documento.
 
*'''Asunto''': asunto de la entrada.
 
*'''Asunto''': asunto de la entrada.
Línea 13: Línea 16:
 
*'''Fecha''': parámetro de salida. Fecha en la que se registra la entrada.
 
*'''Fecha''': parámetro de salida. Fecha en la que se registra la entrada.
 
*'''Hora''': parámetro de salida. Hora en la que se registra la salida.
 
*'''Hora''': parámetro de salida. Hora en la que se registra la salida.
−
*'''Numero''': Nº de registro de entrada
+
*'''Numero''': parámetro de salida. Nº de registro de entrada
−
*'''Clasificador''': componente clasificador en la que se almacenará el resguardo de la entrada en PDF.
+
*'''Resguardo''': componente clasificador en la que se almacenará el resguardo de la entrada en PDF.
 
*'''Documentos''': parámetro opcional. Componente clasificador en la que se encuentran los documentos en PDF a los que se desea dar de entrada.  
 
*'''Documentos''': parámetro opcional. Componente clasificador en la que se encuentran los documentos en PDF a los que se desea dar de entrada.  
 +
<p>Ejemplo:</p>
  
−
Ejemplo:
+
{{PR|metodo}} Registrar
 +
    {{PR|var}}
 +
      fecha_entrada: {{T|fecha}};
 +
      hora_entrada: {{T|texto}};
 +
      numero_entrada: {{T|texto}};
 +
      solicitud: {{RE|contenedor}};
 +
{{PR|inicio}}
 +
    solicitud = $crear([Expediente de la DG].[Contenido], {{STR|"Solicitud de inscripción"}});<br/>
 +
    $registrar_entrada({{STR|"Dirección General de Administración Territorial y Gobernación"}}, {{STR|"Prueba"}},
 +
                      {{STR|"Daniel Hernández Aguiar"}}, {{STR|"45759313P"}}, fecha_entrada, hora_entrada,
 +
                      numero_entrada, solicitud->[Documentos adjuntos]);<br/>
 +
    solicitud.[Datos generales].[Nº de registro general] = {{AT|numero_entrada}};
 +
    solicitud.[Datos generales].[Fecha de registro general] = {{AT|fecha_entrada}};
 +
    solicitud.[Datos generales].[Hora de registro general] = {{AT|hora_entrada}};
 +
    $guardar({{AT|solicitud}});
 +
{{PR|fin}}
  
−
metodo Registrar
+
<blockquote style="border: 3px solid #993365; background: #F9F9F9; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left">
−
    var
+
<code>'''$esb_registrar_salida'''(Organismo: {{T|texto}}, Asunto: {{T|texto}}, Remitente: {{T|texto}}, NIF: {{T|texto}}, sal Fecha: {{T|fecha}}, sal Hora: {{T|texto}}, sal Numero: {{T|texto}}, Resguardo: {{T|clasificador}}[, Documento: {{T|documento}}])</code>
−
      fecha_entrada: fecha;
+
</blockquote>
−
      hora_entrada: texto;
+
<br/>
−
      numero_entrada: texto;
+
−
      solicitud: contenedor;
+
−
incio
+
−
    solicitud = $crear([Expediente de la DG].[Contenido], "Solicitud de inscripción");
+
−
    $registrar_entrada("Dirección General de Administración Territorial y Gobernación", "Prueba", "Daniel Hernández Aguiar", "45759313P", fecha_entrada, hora_entrada, numero_entrada, solicitud->[Documentos adjuntos]);
+
−
    solicitud.[Datos generales].[Nº de registro general] = numero_entrada;
+
−
    solicitud.[Datos generales].[Fecha de registro general] = fecha_entrada;
+
−
    solicitud.[Datos generales].[Hora de registro general] = hora_entrada;
+
−
    $guardar(solicitud);
+
−
fin
+
−
$plantino_registrar_salida(Organismo:texto, Asunto:texto, Remitente:texto, NIF: texto, sal Fecha: fecha, sal Hora: texto, sal Numero: texto, Reguardo: clasificador[, Documento: documento])
+
  
−
Esta función permite registrar documentos de salida.  
+
<p>Esta función permite registrar de salida documentos elaborados mediante <b>egeasy</b>. Los datos devueltos se almacenan en las variables de salida. Los parámetros son:</p>
 +
*'''Organismo''': organismo que envía el documento.
 +
*'''Asunto''': asunto de la salida.
 +
*'''Remitente''': N/A (el significado de este campo no queda claro en la documentación de PLATINO).
 +
*'''NIF''': N/A (el significado de este campo no queda claro en la documentación de PLATINO).
 +
*'''Fecha''': parámetro de salida. Fecha en la que se registra la salida.
 +
*'''Hora''': parámetro de salida. Hora en la que se registra la salida.
 +
*'''Numero''': parámetro de salida. Nº de registro de salida.
 +
*'''Reguardo''': componente clasificador en la que se almacenará el resguardo de la salida en PDF.
 +
*'''Documento''': parámetro opcional infinito. Se pasará una componente documento por cada documento al que se le quiera dar salida. El tamaño máximo de estos documentos estará limitado por las especificaciones de PLATINO.
  
−
$plantino_registrar_salida(Organismo:texto, Asunto:texto, Remitente:texto, NIF: texto, sal Fecha: fecha, sal Hora: texto, sal Numero: texto, Reguardo: clasificador[, Documentos: clasificador])
+
<blockquote style="border: 3px solid #993365; background: #F9F9F9; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left">
 +
<code>'''$esb_registrar_salida'''(Organismo: {{T|texto}}, Asunto: {{T|texto}}, Remitente {{T|texto}}, NIF: {{T|texto}}, sal Fecha: {{T|fecha}}, sal Hora: {{T|texto}}, sal Numero: {{T|texto}}, Reguardo: {{T|clasificador}}, Documentos: {{T|clasificador}})</code>
 +
</blockquote>
 +
<br/>
  
 +
<p>Esta función permite registrar de salida documentos presentes en un clasificador en algún contenedor de <b>egeasy</b>. Los datos devueltos se almacenan en las variables de salida. Los parámetros son:</p>
 +
*'''Organismo''': organismo que envía el documento.
 +
*'''Asunto''': asunto de la salida.
 +
*'''Remitente''': N/A (el significado de este campo no queda claro en la documentación de PLATINO).
 +
*'''NIF''': N/A (el significado de este campo no queda claro en la documentación de PLATINO).
 +
*'''Fecha''': parámetro de salida. Fecha en la que se registra la salida.
 +
*'''Hora''': parámetro de salida. Hora en la que se registra la salida.
 +
*'''Numero''': parámetro de salida. Nº de registro de salida.
 +
*'''Reguardo''': componente clasificador en la que se almacenará el resguardo de la salida en PDF.
 +
*'''Documentos''': componente clasificador en la que se encuentran los documentos en PDF a los que se desea dar de salida.
  
−
===$platino_registrar_salida===
 
−
==Sellado de tiempo==
 
 
==Notificaciones telemáticas==
 
==Notificaciones telemáticas==
 +
 +
<p>Para las notificaciones telemáticas se han implementado dos funciones: una que registra de salida los documentos y envía las notificaciones y otra que permite consultar el estado de la notificación.</p>
 +
 +
<blockquote style="border: 3px solid #993365; background: #F9F9F9; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left">
 +
<code>'''$esb_notificar'''(Terceros: {{T|matriz}}, Notificación: {{T|documento}})</code>
 +
</blockquote>
 +
<br/>
 +
 +
Esta función permite notificar un escrito a un conjunto de Terceros. Los parámetros son:
 +
*'''Terceros''': matriz de contenedores. Representa la lista de terceros que van a ser notificados.
 +
*'''Notificación''': documento que va a ser notificado.
 +
 +
<p>La función devuelve como salida una matriz con tantas filas como Terceros hayan sido notificados y con las siguientes columnas:</p>
 +
*'''Tercero''': tipo contenedor. Representa el Tercero que ha sido notificado.
 +
*'''Número de registro de salida''': tipo texto. nº del registro de salida.
 +
*'''Fecha de registro de salida''': tipo fecha. Fecha del registro de salida.
 +
*'''Hora de registro de salida''': tipo texto. Hora del registro de salida.
 +
*'''Nº de notificación''': tipo texto. Identificador de la notificación.
 +
*'''Estado''': tipo texto. Estado de la notificación. Los posibles valores del estado son los proporcionados por PLATINO: Creada, Enviada, Puesta a disposición, Leída, Expirada, Rechazada, Finalizada y Tercero no suscrito. 
 +
 +
<blockquote style="border: 3px solid #993365; background: #F9F9F9; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left">
 +
<code>'''$esb_consultar_estado_notificacion'''(NumeroNotificacion: {{T|texto}})</code>
 +
</blockquote>
 +
<br/>
 +
 +
<p>Esta función permite conocer el estado de una notificación. Recibe como entrada el identificador de la notificación y devuelve el estado actual en modo texto.</p>
 +
 
==Envío de SMS==
 
==Envío de SMS==
 +
 +
<blockquote style="border: 3px solid #993365; background: #F9F9F9; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left">
 +
<code>'''$esb_enviar_sms'''(Telefonos: {{T|matriz}}, Mensaje: {{T|texto}})</code>
 +
</blockquote>
 +
<br/>
 +
 +
<p>Esta función permite notificar un mensaje a un conjunto de teléfonos móviles. Los parámetros son:</p>
 +
*'''Telefonos''': de tipo matriz. Lista de teléfonos a los que se desea enviar el mensaje.
 +
*'''Mensaje''': de tipo texto. Mensaje de texto que se va a enviar.
 +
 +
<p>Esta función no devuelve nada.</p>
 +
 +
==Sellado de tiempo==
 +
 +
<blockquote style="border: 3px solid #993365; background: #F9F9F9; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left">
 +
<code>'''$esb_sellar'''(sal Fecha: {{T|fecha}}, sal Hora: {{T|texto}})</code>
 +
</blockquote>
 +
<br/>
 +
 +
<p>Esta función permite obtener un sello de tiempo representado por una fecha y una hora. Los parámetros son:</p>
 +
*<b>Fecha</b>: parámetro de salida. Fecha del sellado.
 +
*<b>Hora</b>: parámetro de salida. Hora del sellado.
 +
 +
<p>Esta función no devuelve nada.</p>
 +
 +
[[Categoría:ODL]]
 +
[[Categoría:Funciones]]
 +
[[Categoría:PLATINO]]

Revisión actual del 13:33 16 jun 2009

Este artículo describe las interfaces de las funciones que se han diseñado para la integración de egeasy con PLATINO.

Todas las funciones definidas sólo se pueden invocar desde ficheros de métodos (*.nmt).

Registrar entrada y salida

Este servicio nos permite registrar documentos de entrada y salida. Para comunicarnos con él se han diseñado tres funciones:

$esb_registrar_entrada(Organismo: <code>texto, Asunto: texto, Remitente: texto, NIF: texto, sal Fecha: fecha, sal Hora: texto, sal Numero: texto, sal Resguardo: clasificador[, Documentos clasificador])</code>


Esta función permite registrar documentos de entrada PDF. No devuelve nada. Los datos devueltos se almacenan en las variables de salida. Los parámetros son:

  • Organismo: organismo en el que entra en documento.
  • Asunto: asunto de la entrada.
  • Remitente: persona o entidad que presenta los documentos.
  • NIF: NIF/CIF de la persona o entidad que presenta los documentos.
  • Fecha: parámetro de salida. Fecha en la que se registra la entrada.
  • Hora: parámetro de salida. Hora en la que se registra la salida.
  • Numero: parámetro de salida. Nº de registro de entrada
  • Resguardo: componente clasificador en la que se almacenará el resguardo de la entrada en PDF.
  • Documentos: parámetro opcional. Componente clasificador en la que se encuentran los documentos en PDF a los que se desea dar de entrada.

Ejemplo:

metodo Registrar
   var
      fecha_entrada: fecha;
      hora_entrada: texto;
      numero_entrada: texto;
      solicitud: contenedor;
inicio
   solicitud = $crear([Expediente de la DG].[Contenido], "Solicitud de inscripción");

   $registrar_entrada("Dirección General de Administración Territorial y Gobernación", "Prueba",
                      "Daniel Hernández Aguiar", "45759313P", fecha_entrada, hora_entrada,
                      numero_entrada, solicitud->[Documentos adjuntos]);

   solicitud.[Datos generales].[Nº de registro general] = numero_entrada;
   solicitud.[Datos generales].[Fecha de registro general] = fecha_entrada;
   solicitud.[Datos generales].[Hora de registro general] = hora_entrada;
   $guardar(solicitud);
fin

$esb_registrar_salida(Organismo: <code>texto, Asunto: texto, Remitente: texto, NIF: texto, sal Fecha: fecha, sal Hora: texto, sal Numero: texto, Resguardo: clasificador[, Documento: documento])</code>


Esta función permite registrar de salida documentos elaborados mediante egeasy. Los datos devueltos se almacenan en las variables de salida. Los parámetros son:

  • Organismo: organismo que envía el documento.
  • Asunto: asunto de la salida.
  • Remitente: N/A (el significado de este campo no queda claro en la documentación de PLATINO).
  • NIF: N/A (el significado de este campo no queda claro en la documentación de PLATINO).
  • Fecha: parámetro de salida. Fecha en la que se registra la salida.
  • Hora: parámetro de salida. Hora en la que se registra la salida.
  • Numero: parámetro de salida. Nº de registro de salida.
  • Reguardo: componente clasificador en la que se almacenará el resguardo de la salida en PDF.
  • Documento: parámetro opcional infinito. Se pasará una componente documento por cada documento al que se le quiera dar salida. El tamaño máximo de estos documentos estará limitado por las especificaciones de PLATINO.

$esb_registrar_salida(Organismo: <code>texto, Asunto: texto, Remitente texto, NIF: texto, sal Fecha: fecha, sal Hora: texto, sal Numero: texto, Reguardo: clasificador, Documentos: clasificador)</code>


Esta función permite registrar de salida documentos presentes en un clasificador en algún contenedor de egeasy. Los datos devueltos se almacenan en las variables de salida. Los parámetros son:

  • Organismo: organismo que envía el documento.
  • Asunto: asunto de la salida.
  • Remitente: N/A (el significado de este campo no queda claro en la documentación de PLATINO).
  • NIF: N/A (el significado de este campo no queda claro en la documentación de PLATINO).
  • Fecha: parámetro de salida. Fecha en la que se registra la salida.
  • Hora: parámetro de salida. Hora en la que se registra la salida.
  • Numero: parámetro de salida. Nº de registro de salida.
  • Reguardo: componente clasificador en la que se almacenará el resguardo de la salida en PDF.
  • Documentos: componente clasificador en la que se encuentran los documentos en PDF a los que se desea dar de salida.

Notificaciones telemáticas

Para las notificaciones telemáticas se han implementado dos funciones: una que registra de salida los documentos y envía las notificaciones y otra que permite consultar el estado de la notificación.

$esb_notificar(Terceros: <code>matriz, Notificación: documento)</code>


Esta función permite notificar un escrito a un conjunto de Terceros. Los parámetros son:

  • Terceros: matriz de contenedores. Representa la lista de terceros que van a ser notificados.
  • Notificación: documento que va a ser notificado.

La función devuelve como salida una matriz con tantas filas como Terceros hayan sido notificados y con las siguientes columnas:

  • Tercero: tipo contenedor. Representa el Tercero que ha sido notificado.
  • Número de registro de salida: tipo texto. nº del registro de salida.
  • Fecha de registro de salida: tipo fecha. Fecha del registro de salida.
  • Hora de registro de salida: tipo texto. Hora del registro de salida.
  • Nº de notificación: tipo texto. Identificador de la notificación.
  • Estado: tipo texto. Estado de la notificación. Los posibles valores del estado son los proporcionados por PLATINO: Creada, Enviada, Puesta a disposición, Leída, Expirada, Rechazada, Finalizada y Tercero no suscrito.

$esb_consultar_estado_notificacion(NumeroNotificacion: <code>texto)</code>


Esta función permite conocer el estado de una notificación. Recibe como entrada el identificador de la notificación y devuelve el estado actual en modo texto.

Envío de SMS

$esb_enviar_sms(Telefonos: <code>matriz, Mensaje: texto)</code>


Esta función permite notificar un mensaje a un conjunto de teléfonos móviles. Los parámetros son:

  • Telefonos: de tipo matriz. Lista de teléfonos a los que se desea enviar el mensaje.
  • Mensaje: de tipo texto. Mensaje de texto que se va a enviar.

Esta función no devuelve nada.

Sellado de tiempo

$esb_sellar(sal Fecha: <code>fecha, sal Hora: texto)</code>


Esta función permite obtener un sello de tiempo representado por una fecha y una hora. Los parámetros son:

  • Fecha: parámetro de salida. Fecha del sellado.
  • Hora: parámetro de salida. Hora del sellado.

Esta función no devuelve nada.

Obtenido de «https://wiki.egeasy.es/index.php?title=Funciones_platino&oldid=5266»