Desarrollar proyectos en AEM

Comience creando una carpeta debajo de /apps/<your-app-folder> llamada projects. Cree otra carpeta debajo de la denominada templates.

/apps/aem-guides/projects-tasks/
                    + projects (nt:folder)
                             + templates (nt:folder)

Para facilitar las cosas, empezaremos nuestra plantilla personalizada a partir de la plantilla de proyecto simple existente.

1. Copie y pegue el nodo /libs/cq/core/content/projects/templates/default debajo de la carpeta templates creada en el paso 1.

/apps/aem-guides/projects-tasks/
             + templates (nt:folder)
                  + default (cq:Template)

Ahora debería tener una ruta como /apps/aem-guides/projects-tasks/projects/templates/authoring-project.

1. Edite las propiedades jcr:title y jcr:description del nodo author-project para asignar valores personalizados de título y descripción.

   1. Deje la propiedad wizard apuntando a las propiedades predeterminadas del proyecto.

/apps/aem-guides/projects-tasks/projects/
         + templates (nt:folder)
              + authoring-project (cq:Template)
                   - jcr:title = "Authoring Project"
                   - jcr:description = "A project to manage approval and publish process for AEM Sites or Assets"
                   - wizard = "/libs/cq/core/content/projects/wizard/steps/defaultproject.html"

Para esta plantilla de proyecto queremos hacer uso de Tareas.

1. Agregue un nuevo nodo nt:unstructured debajo del proyecto/gadgets de creación llamados tasks.
2. Agregue propiedades de cadena al nodo de tareas para cardWeight = "100", jcr:title="Tasks" y sling:resourceType="cq/gui/components/projects/admin/pod/taskpod".

Ahora el mosaico Tareas aparecerá de forma predeterminada cuando se cree un nuevo proyecto.

../projects/templates/authoring-project
    + gadgets (nt:unstructured)
         + team (nt:unstructured)
         + asset (nt:unstructured)
         + work (nt:unstructured)
         + experiences (nt:unstructured)
         + projectinfo (nt:unstructured)
         ..
         + tasks (nt:unstructured)
              - cardWeight = "100"
              - jcr:title = "Tasks"
              - sling:resourceType = "cq/gui/components/projects/admin/pod/taskpod"

Agregaremos una función de aprobador personalizada a nuestra plantilla de proyecto.

1. Debajo del nodo de plantilla de proyecto (authoring-project) agregue un nuevo nt:unstructured roles etiquetado por nodos.

2. Agregue otro nodo nt:unstructured etiquetado como aprobadores secundarios del nodo de funciones.

3. Agregar propiedades de cadena jcr:title = "Aprobadores", roleclass ="owner", roleid="approvers".

   1. El nombre del nodo de aprobadores, así como jcr:title y roleid, pueden ser cualquier valor de cadena (siempre que roleid sea único).
   2. roleclass rige los permisos aplicados a ese rol en función de tres roles OOTB: propietario, editor y observador.
   3. En general, si la función personalizada es más bien una función directiva, la clase de rol puede ser propietario; si es una función de creación más específica como Fotógrafo o Designer, entonces editor de clase de rol debería ser suficiente. La gran diferencia entre owner y editor es que los propietarios del proyecto pueden actualizar las propiedades del proyecto y agregar nuevos usuarios al proyecto.

../projects/templates/authoring-project
    + gadgets (nt:unstructured)
    + roles (nt:unstructured)
        + approvers (nt:unstructured)
             - jcr:title = "Approvers"
             - roleclass = "owner"
             - roleid = "approver"

Al copiar la plantilla Proyecto simple, obtendrá cuatro flujos de trabajo OOTB configurados. Cada nodo debajo de flujos de trabajo/modelos apunta a un flujo de trabajo específico y a un asistente de cuadro de diálogo de inicio para ese flujo de trabajo. Más adelante en este tutorial crearemos un flujo de trabajo personalizado para este proyecto. Por ahora, elimine los nodos debajo de flujo de trabajo/modelos:

../projects/templates/authoring-project
    + gadgets (nt:unstructured)
    + roles (nt:unstructured)
    + workflows (nt:unstructured)
         + models (nt:unstructured)
            - (remove ootb models)

Para facilitar a los autores de contenido la identificación de la plantilla de proyecto, puede agregar una miniatura personalizada. El tamaño recomendado sería de 319 x 319 píxeles.

1. En CRXDE Lite, cree un archivo como secundario de los nodos de gadgets, funciones y flujos de trabajo llamados thumbnail.png.
2. Guarde, navegue hasta el nodo jcr:content y haga doble clic en la propiedad jcr:data (evite hacer clic en "Ver").
   1. Esto le pedirá un cuadro de diálogo para editar el archivo jcr:data y podrá cargar una miniatura personalizada.

../projects/templates/authoring-project
    + gadgets (nt:unstructured)
    + roles (nt:unstructured)
    + workflows (nt:unstructured)
    + thumbnail.png (nt:file)

En el menú Inicio de AEM, vaya a Herramientas -> Flujo de trabajo -> Modelos. Haga clic en "Crear" en la esquina superior derecha para crear un modelo de flujo de trabajo.

Asigne un título al nuevo modelo: "Flujo de trabajo de aprobación de contenido" y un nombre de URL: "content-approval-workflow".

Para obtener más información relacionada con la creación de flujos de trabajo, lea este enlace.

Como práctica recomendada, los flujos de trabajo personalizados deben agruparse en su propia carpeta debajo de /etc/workflow/models. En CRXDE Lite, cree una 'nt:folder' debajo de /etc/workflow/models denominado "aem-guides". Añadir una subcarpeta garantiza que los flujos de trabajo personalizados no se sobrescriban accidentalmente durante las actualizaciones o instalaciones del Service Pack.

*Tenga en cuenta que es importante nunca colocar la carpeta o los flujos de trabajo personalizados debajo de subcarpetas ootb como /etc/workflow/models/dam o /etc/workflow/models/projects, ya que toda la subcarpeta también se puede sobrescribir mediante actualizaciones o paquetes de servicio.

Ubicación del modelo de flujo de trabajo en 6.3

NOTE

Si utiliza AEM 6.4+, la ubicación del flujo de trabajo ha cambiado. Vea aquí para obtener más detalles.

Si utiliza AEM 6.4+, el modelo de flujo de trabajo se crea en /conf/global/settings/workflow/models. Repita los pasos anteriores con el directorio /conf, agregue una subcarpeta denominada aem-guides y mueva content-approval-workflow debajo de ella.

Ubicación del modelo de flujo de trabajo en 6.4+

En AEM 6.3 se introduce la capacidad de añadir fases de flujo de trabajo a un flujo de trabajo determinado. Las fases aparecerán al usuario en la bandeja de entrada de la pestaña Información del flujo de trabajo. Muestra al usuario la fase actual del flujo de trabajo, así como las fases anteriores y posteriores.

Para configurar las fases, abra el cuadro de diálogo Propiedades de página desde Sidekick. La cuarta pestaña se denomina "Fases". Añada los siguientes valores para configurar las tres fases de este flujo de trabajo:

1. Editar contenido
2. Aprobación
3. Publicación

Configure las fases del flujo de trabajo desde el cuadro de diálogo Propiedades de página.

La barra de progreso del flujo de trabajo, tal como se ve desde la bandeja de entrada AEM.

Opcionalmente, puede cargar una imagen a las propiedades de página que se usan como miniatura de flujo de trabajo cuando los usuarios la seleccionan. Las dimensiones de la imagen deben ser de 319 x 319 píxeles. Agregar una descripción a las propiedades de página también se mostrará cuando un usuario seleccione el flujo de trabajo.

El proceso de flujo de trabajo Crear tarea del proyecto está diseñado para crear una tarea como paso en el flujo de trabajo. El flujo de trabajo solo avanzará una vez completada la tarea. Un aspecto importante del paso Crear tarea de proyecto es que puede leer valores de metadatos de flujo de trabajo y utilizarlos para crear la tarea de forma dinámica.

En primer lugar, elimine el paso de participante que se crea de forma predeterminada. En Sidekick, en el menú de componentes, expanda el subencabezado "Proyectos" y arrastre y suelte "Crear tarea de proyecto" en el modelo.

Haga doble clic en el paso "Crear tarea del proyecto" para abrir el cuadro de diálogo de flujo de trabajo. Configure las siguientes propiedades:

Esta pestaña es común para todos los pasos del proceso de flujo de trabajo y estableceremos el Título y la Descripción (no serán visibles para el usuario final). La propiedad importante que estableceremos es la Fase del flujo de trabajo en "Editar contenido" del menú desplegable.

Common Tab
-----------------
    Title = "Start Task Creation"
    Description = "This the first task in the Workflow"
    Workflow Stage = "Edit Content"

El proceso de flujo de trabajo Crear tarea del proyecto está diseñado para crear una tarea como paso en el flujo de trabajo. La pestaña Tarea permite establecer todos los valores de la tarea. En nuestro caso, queremos que el usuario asignado sea dinámico, por lo que lo dejaremos en blanco. El resto de los valores de propiedad:

Task Tab
-----------------
    Name* = "Edit Content"
    Task Priority = "Medium"
    Description = "Edit the content and finalize for approval. Once finished submit for approval."
    Due In - Days = "2"

La pestaña de enrutamiento es un cuadro de diálogo opcional que puede especificar las acciones disponibles para el usuario que completa la tarea. Estas acciones son solo valores de cadena que se guardan en los metadatos del flujo de trabajo. Estos valores se pueden leer mediante scripts o pasos de proceso más adelante en el flujo de trabajo para "enrutar" dinámicamente el flujo de trabajo. En función de los objetivos de flujo de trabajo que estableceremos, agregue tres acciones a esta pestaña:

Routing Tab
-----------------
    Actions =
        "Normal Approval"
        "Rush Approval"
        "Bypass Approval"

Esta pestaña nos permite configurar un script de tarea previo a la creación en el que podemos decidir mediante programación varios valores de la tarea antes de crearla. Tenemos la opción de apuntar el script a un archivo externo o incrustar un script corto directamente en el cuadro de diálogo. En nuestro caso, señalaremos el script de tarea previo a la creación a un archivo externo. En el paso 5 crearemos esa secuencia de comandos.

Advanced Settings Tab
-----------------
   Pre-Create Task Script = "/apps/aem-guides/projects/scripts/start-task-config.ecma"

En el paso anterior hicimos referencia a un script anterior a la creación de la tarea. Crearemos ese script ahora en el cual estableceremos el usuario asignado de la tarea en función del valor de un valor de metadatos de flujo de trabajo "asignado". El valor "usuario asignado" se establece cuando se inicia el flujo de trabajo. También leeremos los metadatos del flujo de trabajo para elegir dinámicamente la prioridad de la tarea al leer el valor "taskPriority" de los metadatos del flujo de trabajo, así como el **​ **"taskDueDate" que se establecerá dinámicamente cuando venza la primera tarea.

Por motivos de organización, hemos creado una carpeta debajo de la carpeta de la aplicación para guardar todos los scripts relacionados con el proyecto: /apps/aem-guides/projects-tasks/projects/scripts. Cree un archivo debajo de esta carpeta denominado "start-task-config.ecma". *Tenga en cuenta que la ruta al archivo start-task-config.ecma coincide con la ruta establecida en la pestaña Configuración avanzada del paso 4.

Agregue lo siguiente como contenido del archivo:

// start-task-config.ecma
// Populate the task using values stored as workflow metadata originally posted by the start workflow wizard

// set the assignee based on start workflow wizard
var assignee = workflowData.getMetaDataMap().get("assignee", Packages.java.lang.String);
task.setCurrentAssignee(assignee);

//Set the due date for the initial task based on start workflow wizard
var dueDate = workflowData.getMetaDataMap().get("taskDueDate", Packages.java.util.Date);
if (dueDate != null) {
    task.setProperty("taskDueDate", dueDate);
}

//Set the priority based on start workflow wizard
var taskPriority = workflowData.getMetaDataMap().get("taskPriority", "Medium");
task.setProperty("taskPriority", taskPriority);

Vuelva al flujo de trabajo de aprobación de contenido. Arrastre y suelte el componente OR Split (que se encuentra en Sidekick debajo de la categoría "Flujo de trabajo") debajo del paso Iniciar tarea. En el cuadro de diálogo Común, seleccione el botón de opción para 3 ramas. OR Split leerá el valor de metadatos de flujo de trabajo "lastTaskAction" para determinar la ruta del flujo de trabajo. La propiedad "lastTaskAction" se establece en uno de los valores de la ficha Enrutamiento configurada en el paso 4. Para cada una de las fichas de ramas, rellene el área de texto Script con los siguientes valores:

function check() {
var lastAction = workflowData.getMetaDataMap().get("lastTaskAction","");

if(lastAction == "Normal Approval") {
    return true;
}

return false;
}

function check() {
var lastAction = workflowData.getMetaDataMap().get("lastTaskAction","");

if(lastAction == "Rush Approval") {
    return true;
}

return false;
}

function check() {
var lastAction = workflowData.getMetaDataMap().get("lastTaskAction","");

if(lastAction == "Bypass Approval") {
    return true;
}

return false;
}

*Tenga en cuenta que estamos haciendo una coincidencia directa de cadena para determinar la ruta, por lo que es importante que los valores configurados en los scripts de rama coincidan con los valores de Ruta establecidos en el paso 4.

Arrastre y suelte otro paso "Crear tarea de proyecto" en el modelo en el extremo izquierdo (rama 1) debajo de la división O. Complete el cuadro de diálogo con las siguientes propiedades:

Common Tab
-----------------
    Title = "Approval Task Creation"
    Description = "Create a an approval task for Project Approvers. Priority is Medium."
    Workflow Stage = "Approval"

Task Tab
------------
    Name* = "Approve Content for Publish"
    Task Priority = "Medium"
    Description = "Approve this content for publication."
    Days = "5"

Routing Tab - Actions
----------------------------
    "Approve and Publish"
    "Send Back for Revision"

Dado que es la ruta de aprobación normal, la prioridad de la tarea se establece en Medium. Además, damos al grupo de aprobadores 5 días para completar la tarea. El usuario asignado se deja en blanco en la pestaña Tarea, ya que se asigna dinámicamente en la pestaña Configuración avanzada. Al completar esta tarea, proporcionamos al grupo de aprobadores dos rutas posibles: "Aprobar y publicar" si aprueban el contenido y se puede publicar y "Enviar de nuevo para revisión" si hay problemas que el editor original debe corregir. El aprobador puede dejar comentarios que el editor original verá si se le devuelve el flujo de trabajo.

Arrastre y suelte otro paso "Crear tarea de proyecto" en el modelo hasta la rama central (rama 2) debajo de la división O. Complete el cuadro de diálogo con las siguientes propiedades:

Common Tab
-----------------
    Title = "Rush Approval Task Creation"
    Description = "Create a an approval task for Project Approvers. Priority is High."
    Workflow Stage = "Approval"

Task Tab
------------
    Name* = "Rush Approve Content for Publish"
    Task Priority = "High"
    Description = "Rush approve this content for publication."
    Days = "1"

Routing Tab - Actions
----------------------------
    "Approve and Publish"
    "Send Back for Revision"

Dado que esta es la ruta de aprobación de Rush, la prioridad de la tarea se establece en High. Además, le damos al grupo de aprobadores solo un día para completar la tarea. El usuario asignado se deja en blanco en la pestaña Tarea, ya que se asigna dinámicamente en la pestaña Configuración avanzada.

Podemos reutilizar el mismo fragmento de script que en el paso 7 para rellenar el área de texto Script en la pestaña ​ Configuración avanzada ​. Copie y pegue el siguiente código:

var projectApproverGrp = workflowData.getMetaDataMap().get("project.group.approvers","administrators");

task.setCurrentAssignee(projectApproverGrp);

Arrastre y suelte un componente ​ Sin operación en la rama derecha (rama 3). El componente Sin operación no realiza ninguna acción y avanzará inmediatamente, lo que representa el deseo del editor original de omitir el paso de aprobación. Técnicamente, podríamos dejar esta rama sin ningún paso de flujo de trabajo, pero como práctica recomendada, añadiremos un paso Sin operación. Esto deja claro a otros desarrolladores cuál es el propósito de la Rama 3.

Haga doble clic en el paso del flujo de trabajo y configure el Título y la Descripción:

Common Tab
-----------------
    Title = "Bypass Approval"
    Description = "Placeholder step to indicate that the original editor decided to bypass the approver group."

El modelo de flujo de trabajo debe tener este aspecto una vez configuradas las tres ramas de la división O.

Dado que el grupo de aprobadores tiene la opción de enviar el flujo de trabajo de vuelta al editor original para realizar más revisiones, confiaremos en el paso Ir a para leer la última acción realizada y enrutar el flujo de trabajo al principio o permitir que continúe.

Arrastre y suelte el componente Paso Ir a (que se encuentra en Sidekick, en Flujo de trabajo) debajo de la división O donde se vuelve a unir. Haga doble clic en y configure las siguientes propiedades en el cuadro de diálogo:

Common Tab
----------------
    Title = "Goto Step"
    Description = "Based on the Approver groups action route the workflow to the beginning or continue and publish the payload."

Process Tab
---------------
    The step to go to. = "Start Task Creation"

La última pieza que configuraremos es la secuencia de comandos como parte del paso Goto process. El valor Script se puede incrustar mediante el cuadro de diálogo o configurar para que apunte a un archivo externo. El script Goto debe contener function check() y devolver true si el flujo de trabajo debe ir al paso especificado. Devolución de resultados falsos para que el flujo de trabajo avance.

Si el grupo de aprobadores elige la acción "Enviar de vuelta para revisión" (configurada en los pasos 7 y 8), entonces queremos devolver el flujo de trabajo al paso "Iniciar creación de tareas".

En la pestaña Proceso, agregue el siguiente fragmento al área de texto Script:

function check() {
var lastAction = workflowData.getMetaDataMap().get("lastTaskAction","");

if(lastAction == "Send Back for Revision") {
    return true;
}

return false;
}

Para publicar la carga útil usaremos el paso de proceso ootb Activar página/recurso. Este paso del proceso requiere poca configuración y agrega la carga útil del flujo de trabajo a la cola de replicación para su activación. Añadiremos el paso debajo del paso Ir a y de este modo solo se puede acceder a él si el grupo de aprobadores ha aprobado el contenido para su publicación o si el editor original eligió la ruta Omitir aprobación.

Arrastre y suelte el paso del proceso Activar página/recurso (que se encuentra en Sidekick, en Flujo de trabajo de WCM) debajo del paso Ir a del modelo.

Aspecto que debería tener el modelo del flujo de trabajo después de agregar el paso Ir a y el paso Activar página/recurso.

Si el grupo de aprobadores devuelve el contenido para su revisión, queremos informar al editor original. Podemos lograrlo cambiando dinámicamente las propiedades de creación de la tarea. Se quitará el valor de la propiedad lastActionTaken de "Enviar de nuevo para revisión". Si ese valor está presente, modificaremos el título y la descripción para indicar que esta tarea es el resultado de que el contenido se devuelva para su revisión. También actualizaremos la prioridad a "Alta" para que sea el primer elemento en el que trabaje el editor. Finalmente, estableceremos la fecha de vencimiento de la tarea en un día a partir de la fecha en que se envió el flujo de trabajo para su revisión.

Reemplace el script de inicio start-task-config.ecma (creado en el paso 5) con lo siguiente:

// start-task-config.ecma
// Populate the task using values stored as workflow metadata originally posted by the start workflow wizard

// set the assignee based on start workflow wizard
var assignee = workflowData.getMetaDataMap().get("assignee", Packages.java.lang.String);
task.setCurrentAssignee(assignee);

//Set the due date for the initial task based on start workflow wizard
var dueDate = workflowData.getMetaDataMap().get("taskDueDate", Packages.java.util.Date);
if (dueDate != null) {
    task.setProperty("taskDueDate", dueDate);
}

//Set the priority based on start workflow wizard
var taskPriority = workflowData.getMetaDataMap().get("taskPriority", "Medium");
task.setProperty("taskPriority", taskPriority);

var lastAction = workflowData.getMetaDataMap().get("lastTaskAction","");

//change the title and priority if the approver group sent back the content
if(lastAction == "Send Back for Revision") {
  var taskName = "Review and Revise Content";

  //since the content was rejected we will set the priority to High for the revison task
  task.setProperty("taskPriority", "High");

  //set the Task name (displayed as the task title in the Inbox)
  task.setProperty("name", taskName);
  task.setProperty("nameHierarchy", taskName);

  //set the due date of this task 1 day from current date
  var calDueDate = Packages.java.util.Calendar.getInstance();
  calDueDate.add(Packages.java.util.Calendar.DATE, 1);
  task.setProperty("taskDueDate", calDueDate.getTime());

}