INSTRUCTIVO DOCUMENTACIÓN DE PLUGINS¶

Guía documentación guardas/acciones en wiki de planificación

Ruta: http://planificacion.adapting.com:81/redmine/projects/plugins-metadatos-acciones-guardas-y-suscripcion-a-eventos/wiki

Nombre de la guarda o acción:
Comprobar número mínimo de relaciones del contenido

Ficha (autor, repositorio, código fuente, versión, compatibilidad), así como resumen e instalación:¶

Información¶

	Autor	Luis Alvarez
	Sitio Web	http://www.facebook.com/adapting-lab
	Repositorio	source:Guardas-America/trunk/src
	Código fuente	http://svn-community.adapting.com:8080/svn/Community/Plugins/Guardas-America/trunk/
	Versión Actual	v1.0
	Compatible con	Abox 3.0

Resumen¶

Esta guarda comprueba la cantidad mínima de relaciones de la entidad

Notas de instalación¶

Descargue el código fuente del plugin y compílelo usando Visual Studio 2010. Luego dependiendo si lo va a integrar en una instalación de Abox o en un proyecto de extensión de Abox sigua las siguientes instrucciones.
En una instalación de Abox

Copiar la dll que genera el proyecto, en principio se debe llamar Adapting.CountRelationGuard.dll, en la carpeta /bin del sitio web donde esta Abox.

Incluya el proyecto en su proyecto para extender Abox, añada una referencia en Adapting.Web al proyecto que acaba de incluir.

Guia de uso: En este punto es necesario incluir el xml de la acción/guarda, así como el código para el .config del hoteditor, en nombres y descripción no copiar el mismo texto, la descripción figura como guía de uso de la guarda/acción y para el caso de los parámetros, la forma de usarlos, esto incluye como introducir keywords, valores por defecto, entre otros. Ejemplos a continuación:¶

Guía de uso¶

Una vez incluida la clase en el proyecto y recompilado el proyecto, tiene que modificar el XML del workflow para añadir esta acción en las acciones que ejecuta el worlflow al cambiar de estado. Para hacer esto incluya este código en las acciones de la transición en la que quiere que se ejecute.

   <guard type="CountRelation">
        <param name="numberOfRelation">2</param>
       <!-- opcional -->
        <param name="messageToShow">mesaje de prueba</param>
   </guard> 

HOTEDITOR

    <guard code="CountRelation" available="true">
            <name>Número relaciones del contenido</name>
            <description>Valida la cantidad de relaciones que tiene el contenido</description>
            <type>Propiedades del contenido</type>
            <contentTypes>
                <contentType>document</contentType>
                <contentType>casefolder</contentType>
            </contentTypes>
            <params>
                <param code="numberOfRelation" minOccurs="1" maxOccurs="1">
                    <type>int</type>
                    <name>Número mínimo</name>
                    <description>Cantidad de relaciones mínimas del contenido</description>
                </param>
                <param code="messageToShow" minOccurs="0" maxOccurs="1">
                    <type>richtext</type>
                    <name>Mensaje para mostrar</name>
                    <description>Mensaje informativo a mostrar</description>
                </param>
            </params>
    </guard>

Por último, se recomienda en el histórico, incluir el xml y código para .config del hoteditor, en caso de nuevos parámetros, y el código del tiquet que dio a luz el cambio (en el ejemplo, si hay un nuevo parametro, se deberá incluir el codigo xml y para el .config del hoteditor).¶

Historico¶

02/11/2017 Se agrego un parametro opcional para filtrar la busqueda de los contenidos relacionados por tipo, usando una expresion regular y comparandolos con el CODIGO del tipo. Para mas información, tiquet 1234

<param name="filterType">100.*</param>

19/03/2020 Se agrego un parámetro opcional para filtrar el conteo de los contenidos relacionados por tipo de relaciones, los cuales estarán dispuestos en una lista. Para mas información, tiquet 1234

<param name="relationType">unidir/bidir/isResponseOfRelation/isOriginOfRelation</param>

<param code="relationType" minOccurs="0" maxOccurs="1">
    <type>list</type>
    <name>Tipo de relación</name>
    <description>Tipo de relación</description>
    <values>
        <value code="unidir">Unidireccional</value>
        <value code="bidir">Bidireccional</value>
        <value code="isResponseOfRelation">Es respuesta de</value> 
        <value code="isOriginOfRelation">Es originado de</value>                      
    </values>        
</param>