Diferencia entre revisiones de «Funciones de método»
(→$esbPlatino_EnviarCorreoDeOficio) |
|||
(No se muestran 22 ediciones intermedias de 3 usuarios) | |||
Línea 1: | Línea 1: | ||
+ | __NOTOC__ | ||
+ | ===<code>$Crear</code>=== | ||
<blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | <blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | ||
− | + | '''$Crear'''(C: {{RE|contenedor}}, Ámbito: {{T|definición}}): {{RE|contenedor}} | |
</blockquote> | </blockquote> | ||
− | :*'''Descripción'''<p>Permite | + | :*'''Descripción'''<p>Permite crear un objeto en el ámbito especificado (colección, exportación, etc.).</p> |
− | :*''' | + | :*'''Ejemplo''' |
<blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | <blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | ||
− | <code style="background: #FFFFFF">$ | + | <code style="background: #FFFFFF">$Crear([Expediente], [Expedientes].[Contenido]);</code> |
</blockquote> | </blockquote> | ||
+ | ===<code>$Ejecutar</code>=== | ||
<blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | <blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | ||
− | <code>'''$ | + | <code>'''$Ejecutar'''(Método: {{T|texto}} {, Parámetro: {{T|texto}}}): {{T|lógico}}</code> |
</blockquote> | </blockquote> | ||
− | :*'''Descripción'''<p>Permite | + | :*'''Descripción'''<p>Permite invocar a un método introduciendo los parámetros asociados a éste.</p> |
:*'''Ejemplo''' | :*'''Ejemplo''' | ||
<blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | <blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | ||
− | <code style="background: #FFFFFF">$ | + | <code style="background: #FFFFFF">$Ejecutar({{STR|"RevisarInforme"}}, Informe);</code> |
</blockquote> | </blockquote> | ||
+ | ===<code>$ElaborarEscrito</code>=== | ||
<blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | <blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | ||
− | <code>'''$ | + | <code>'''$ElaborarEscrito'''(Escrito: {{T|documento}}, Plantilla: {{T|texto}}}):</code> |
</blockquote> | </blockquote> | ||
− | :*'''Descripción'''<p>Permite | + | :*'''Descripción'''<p>Permite elaborar un escrito a nivel de método, de manera que no sería necesario la elaboración del escrito por parte del usuario. Se pasará como primer parámetro el componente escrito, y como segundo parámetro la plantilla que elabora ese escrito.</p> |
:*'''Ejemplo''' | :*'''Ejemplo''' | ||
<blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | <blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | ||
− | <code style="background: #FFFFFF">$ | + | <code style="background: #FFFFFF">$ElaborarEscrito(Resolución de beca.[Escrito], {{STR|"Elaborar escrito de resolución de beca"}});</code> |
</blockquote> | </blockquote> | ||
+ | |||
+ | ===<code>$Firmar</code>=== | ||
<blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | <blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | ||
Línea 44: | Línea 50: | ||
<blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | <blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | ||
− | <code style="background: #FFFFFF">$Firmar([&Destino]->[Datos generales].[Firma del escrito])</code> | + | <code style="background: #FFFFFF">$Firmar([&Destino]->[Datos generales].[Firma del escrito]);</code> |
</blockquote> | </blockquote> | ||
+ | |||
+ | ===<code>$Guardar</code>=== | ||
<blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | <blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | ||
− | <code>'''$ | + | <code>'''$Guardar'''(C: {{RE|contenedor}}[, L: {{T|lógico}}]):</code> |
</blockquote> | </blockquote> | ||
− | :*'''Descripción'''<p> | + | :*'''Descripción'''<p>Función que guarda el objeto que pasamos en el parámetro "C". En caso de existir un segundo parámetro lógico donde cuyo valor sea verdadero, ejecutará el código asociado al evento "Al_guardar" de la definición de contenedor desde la cuál se ejecuta la función $guardar. Su valor por defecto será falso.</p> |
+ | |||
+ | :*'''Ejemplos''' | ||
+ | |||
+ | <blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | ||
+ | <code style="background: #FFFFFF">$Guardar([&Destino]);</code> | ||
+ | </blockquote> | ||
+ | |||
+ | <blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | ||
+ | <code style="background: #FFFFFF">$Guardar(this,verdadero);</code> | ||
+ | </blockquote> | ||
+ | |||
+ | ===<code>$Lanzar</code>=== | ||
+ | |||
+ | <blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | ||
+ | <code>'''$Lanzar'''(Tarea: {{T|texto}} [, Dominio: {{RE|contenedor}} [, H: {{RE|habitacion}}]]): {{RE|tarea}}</code> | ||
+ | </blockquote> | ||
+ | |||
+ | :*'''Descripción'''<p>Permite lanzar una tarea especificando su nombre. Opcionalmente es posible pasar como parámetro el ''target'' con el que va a trabajar esa tarea o la habitación desde donde se podrá lanzar dicha tarea.</p> | ||
:*'''Ejemplo''' | :*'''Ejemplo''' | ||
<blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | <blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | ||
− | <code style="background: #FFFFFF">$ | + | <code style="background: #FFFFFF">$Lanzar({{STR|"FirmarInforme"}}, Informe);</code> |
</blockquote> | </blockquote> | ||
+ | |||
+ | ===<code>$Mover</code>=== | ||
<blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | <blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | ||
− | <code>'''$ | + | <code>'''$Mover'''(C: {{RE|contenedor}}, Ámbito: {{T|definición}}):</code> |
</blockquote> | </blockquote> | ||
− | :*'''Descripción'''<p> | + | :*'''Descripción'''<p>Mueve un objeto "C" de una colección origen a una colección destino "T". El objeto se pasa por parámetro al igual que la colección destino. Para que se produzca el cambio, la colección destino deberá aceptar la definición del objeto. En caso de mostrarse campos diferentes en la colección, no habrá problema siempre y cuando existan en la definición del objeto. Ahora bien, si en la colección destino se muestra un campo que no existe en la definición del objeto, se producirá un error.</p> |
− | :*''' | + | :*'''Ejemplo''' |
<blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | <blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | ||
− | <code style="background: #FFFFFF">$ | + | <code style="background: #FFFFFF">$Mover(Solicitud de beca, [Solicitudes denegadas].[Contenido]);</code> |
</blockquote> | </blockquote> | ||
+ | |||
+ | ===<code>$Sellar</code>=== | ||
+ | |||
+ | <blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | ||
+ | <code>'''$Sellar'''(Campo: {{T|timbre}}): {{T|lógico}}</code> | ||
+ | </blockquote> | ||
+ | |||
+ | :*'''Descripción'''<p>Permite timbrar un campo timbre con la información del usuario que realiza la tarea.</p> | ||
+ | |||
+ | :*'''Ejemplo''' | ||
<blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | <blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | ||
− | <code style="background: #FFFFFF">$ | + | <code style="background: #FFFFFF">$Sellar([&Destino]->[Datos generales].[Nº de expediente]);</code> |
</blockquote> | </blockquote> | ||
+ | |||
+ | ===<code>$esbPlatino_EnviarCorreoDeOficio</code>=== | ||
+ | |||
+ | <blockquote style="border: 2px solid #993365; background: #FFFFFF; margin:1em 1ex 1ex 1ex; padding: 1em; text-align:left"> | ||
+ | '''$esbPlatino_EnviarCorreoDeOficio'''(Asunto: {{T|texto}}, Mensaje: {{T|texto}}, Correos: {{T|texto}}, UriProcedimiento: {{T|texto}}): UriRemesa {{T|texto}} | ||
+ | </blockquote> | ||
+ | |||
+ | :*'''Descripción'''<p>Envía un correo electrónico masivo a todos los destinatarios que se indiquen. En el parámetro <b>Asunto</b> se indica el asunto del correo. En el parámetro <b>Mensaje</b> se indica el cuerpo del mensaje que no puede ser mayor a 140 caracteres. En el parámetro <b>Correos</b> se indican los destinatarios separados por punto y coma (;). Y por último, en el parámetro <b>UriProcedimiento</b> se indica la uri del procedimiento al que está relacionado el correo electrónico. La función devuelve una <b>uri de remesa</b> del mensaje para, posteriormente, poder consultar el estado de esa petición. Todos los parámetros son obligatorios y no se aceptan parámetros vacíos.</p> | ||
+ | |||
+ | :*'''Ejemplo''' | ||
+ | |||
+ | <blockquote style="border: 1px dashed #2F6FAB; background: #FFFFFF; margin:1em 15ex 5ex 15ex; padding: 1em; text-align:left;"> | ||
+ | <code style="background: #FFFFFF">UriRemesa = $esbPlatino_EnviarCorreoDeOficio("Asunto del mensaje", "Mensaje de prueba", "fulano@correo.es;mengano@correo.es", "platino://gobcan.es/servicios/procedimientos/00000000");</code> | ||
+ | </blockquote> | ||
+ | |||
+ | |||
+ | [[Categoría:ODL]] | ||
+ | [[Categoría:Funciones]] |
Revisión actual del 15:05 5 nov 2019
$Crear
$Crear(C:
contenedor
, Ámbito:definición
):contenedor
- Descripción
Permite crear un objeto en el ámbito especificado (colección, exportación, etc.).
- Descripción
- Ejemplo
$Crear([Expediente], [Expedientes].[Contenido]);
$Ejecutar
$Ejecutar(Método: <code>texto
{, Parámetro:texto
}):lógico
</code>
- Descripción
Permite invocar a un método introduciendo los parámetros asociados a éste.
- Descripción
- Ejemplo
$Ejecutar(<code>"RevisarInforme"
, Informe);</code>
$ElaborarEscrito
$ElaborarEscrito(Escrito: <code>documento
, Plantilla:texto
}):</code>
- Descripción
Permite elaborar un escrito a nivel de método, de manera que no sería necesario la elaboración del escrito por parte del usuario. Se pasará como primer parámetro el componente escrito, y como segundo parámetro la plantilla que elabora ese escrito.
- Descripción
- Ejemplo
$ElaborarEscrito(Resolución de beca.[Escrito], <code>"Elaborar escrito de resolución de beca"
);</code>
$Firmar
$Firmar(Campo: <code>firma
):lógico
</code>
- Descripción
Permite firmar un campo firma con la información del usuario que realiza la tarea.
- Descripción
- Ejemplo
$Firmar([&Destino]->[Datos generales].[Firma del escrito]);
$Guardar
$Guardar(C: <code>contenedor
[, L:lógico
]):</code>
- Descripción
Función que guarda el objeto que pasamos en el parámetro "C". En caso de existir un segundo parámetro lógico donde cuyo valor sea verdadero, ejecutará el código asociado al evento "Al_guardar" de la definición de contenedor desde la cuál se ejecuta la función $guardar. Su valor por defecto será falso.
- Descripción
- Ejemplos
$Guardar([&Destino]);
$Guardar(this,verdadero);
$Lanzar
$Lanzar(Tarea: <code>texto
[, Dominio:contenedor
[, H:habitacion
]]):tarea
</code>
- Descripción
Permite lanzar una tarea especificando su nombre. Opcionalmente es posible pasar como parámetro el target con el que va a trabajar esa tarea o la habitación desde donde se podrá lanzar dicha tarea.
- Descripción
- Ejemplo
$Lanzar(<code>"FirmarInforme"
, Informe);</code>
$Mover
$Mover(C: <code>contenedor
, Ámbito:definición
):</code>
- Descripción
Mueve un objeto "C" de una colección origen a una colección destino "T". El objeto se pasa por parámetro al igual que la colección destino. Para que se produzca el cambio, la colección destino deberá aceptar la definición del objeto. En caso de mostrarse campos diferentes en la colección, no habrá problema siempre y cuando existan en la definición del objeto. Ahora bien, si en la colección destino se muestra un campo que no existe en la definición del objeto, se producirá un error.
- Descripción
- Ejemplo
$Mover(Solicitud de beca, [Solicitudes denegadas].[Contenido]);
$Sellar
$Sellar(Campo: <code>timbre
):lógico
</code>
- Descripción
Permite timbrar un campo timbre con la información del usuario que realiza la tarea.
- Descripción
- Ejemplo
$Sellar([&Destino]->[Datos generales].[Nº de expediente]);
$esbPlatino_EnviarCorreoDeOficio
$esbPlatino_EnviarCorreoDeOficio(Asunto:
texto
, Mensaje:texto
, Correos:texto
, UriProcedimiento:texto
): UriRemesatexto
- Descripción
Envía un correo electrónico masivo a todos los destinatarios que se indiquen. En el parámetro Asunto se indica el asunto del correo. En el parámetro Mensaje se indica el cuerpo del mensaje que no puede ser mayor a 140 caracteres. En el parámetro Correos se indican los destinatarios separados por punto y coma (;). Y por último, en el parámetro UriProcedimiento se indica la uri del procedimiento al que está relacionado el correo electrónico. La función devuelve una uri de remesa del mensaje para, posteriormente, poder consultar el estado de esa petición. Todos los parámetros son obligatorios y no se aceptan parámetros vacíos.
- Descripción
- Ejemplo
UriRemesa = $esbPlatino_EnviarCorreoDeOficio("Asunto del mensaje", "Mensaje de prueba", "fulano@correo.es;mengano@correo.es", "platino://gobcan.es/servicios/procedimientos/00000000");