프로그래밍 방식으로 워크플로우와 상호 작용 interacting-with-workflows-programmatically

날짜 워크플로우 사용자 정의 및 확장 워크플로 개체에 액세스할 수 있습니다.

워크플로우 Java API 사용 using-the-workflow-java-api

워크플로우 Java API는 다음으로 구성됩니다. com.adobe.granite.workflow 패키지 및 여러 하위 패키지 API의 가장 중요한 멤버는 com.adobe.granite.workflow.WorkflowSession 클래스. 다음 WorkflowSession 클래스는 디자인 타임 및 런타임 워크플로 개체에 모두 액세스할 수 있습니다.

이 클래스는 워크플로우 주기에 개입하는 몇 가지 방법도 제공합니다.

다음 표에서는 워크플로우와 프로그래밍 방식으로 상호 작용할 때 사용할 여러 주요 Java 개체의 참조 설명서에 대한 링크를 제공합니다. 다음 예제에서는 코드에서 클래스 개체를 가져오고 사용하는 방법을 보여 줍니다.

ECMA 스크립트에서 워크플로우 개체 가져오기 obtaining-workflow-objects-in-ecma-scripts

에 설명된대로 스크립트 찾기, AEM(Apache Sling을 통해)은 서버측 ECMA 스크립트를 실행하는 ECMA 스크립트 엔진을 제공합니다. 다음 org.apache.sling.scripting.core.ScriptHelper 클래스는 즉시 스크립트에 sling 변수를 채우는 방법에 따라 페이지를 순서대로 표시합니다.

다음 ScriptHelper 클래스에서 SlingHttpServletRequest 를 사용하여 WorkflowSession 객체. 예를 들면 다음과 같습니다.

var wfsession = sling.getRequest().getResource().getResourceResolver().adaptTo(Packages.com.adobe.granite.workflow.WorkflowSession);

워크플로우 REST API 사용 using-the-workflow-rest-api

워크플로우 콘솔에서는 REST API를 많이 사용하므로 이 페이지에서는 워크플로우용 REST API에 대해 설명합니다.

REST API에서는 다음 작업이 지원됩니다.

이 페이지에서는 AEM이 포트의 localhost에서 실행된다고 가정합니다. 4502 설치 컨텍스트가 " /"(루트). 설치에 해당되지 않는 경우 HTTP 요청이 적용되는 URI를 그에 따라 조정해야 합니다.

다음에 대해 지원되는 렌더링 GET 요청은 JSON 렌더링입니다. 의 URL GET 이(가) 있어야 합니다. .json 확장명(예:

http://localhost:4502/etc/workflow.json

워크플로우 인스턴스 관리 managing-workflow-instances

다음 HTTP 요청 메서드는에 적용됩니다.

http://localhost:4502/etc/workflow/instances

상태별 워크플로 인스턴스 관리 managing-a-workflow-instance-by-its-state

다음 HTTP 요청 메서드는에 적용됩니다.

http://localhost:4502/etc/workflow/instances.{state}

ID로 워크플로 인스턴스 관리 managing-a-workflow-instance-by-its-id

다음 HTTP 요청 메서드는에 적용됩니다.

http://localhost:4502/etc/workflow/instances/{id}

워크플로우 모델 관리 managing-workflow-models

다음 HTTP 요청 메서드는에 적용됩니다.

http://localhost:4502/etc/workflow/models

예: 브라우저에서 http://localhost:4502/etc/workflow/models.json 는 다음과 유사한 json 응답을 생성합니다.

[
    {"uri":"/var/workflow/models/activationmodel"}
    ,{"uri":"/var/workflow/models/dam/adddamsize"}
    ,{"uri":"/var/workflow/models/cloudconfigs/dtm-reactor/library-download"}
    ,{"uri":"/var/workflow/models/ac-newsletter-workflow-simple"}
    ,{"uri":"/var/workflow/models/dam/dam-create-language-copy"}
    ,{"uri":"/var/workflow/models/dam/dam-create-and-translate-language-copy"}
    ,{"uri":"/var/workflow/models/dam-indesign-proxy"}
    ,{"uri":"/var/workflow/models/dam-xmp-writeback"}
    ,{"uri":"/var/workflow/models/dam-parse-word-documents"}
    ,{"uri":"/var/workflow/models/dam/process_subasset"}
    ,{"uri":"/var/workflow/models/dam/dam_set_last_modified"}
    ,{"uri":"/var/workflow/models/dam/dam-autotag-assets"}
    ,{"uri":"/var/workflow/models/dam/update_asset"}
    ,{"uri":"/var/workflow/models/dam/update_asset_offloading"}
    ,{"uri":"/var/workflow/models/dam/dam-update-language-copy"}
    ,{"uri":"/var/workflow/models/dam/update_from_lightbox"}
    ,{"uri":"/var/workflow/models/cloudservices/DTM_bundle_download"}
    ,{"uri":"/var/workflow/models/dam/dam_download_asset"}
    ,{"uri":"/var/workflow/models/dam/dynamic-media-encode-video"}
    ,{"uri":"/var/workflow/models/dam/dynamic-media-video-thumbnail-replacement"}
    ,{"uri":"/var/workflow/models/dam/dynamic-media-video-user-uploaded-thumbnail"}
    ,{"uri":"/var/workflow/models/newsletter_bounce_check"}
    ,{"uri":"/var/workflow/models/projects/photo_shoot_submission"}
    ,{"uri":"/var/workflow/models/projects/product_photo_shoot"}
    ,{"uri":"/var/workflow/models/projects/approval_workflow"}
    ,{"uri":"/var/workflow/models/prototype-01"}
    ,{"uri":"/var/workflow/models/publish_example"}
    ,{"uri":"/var/workflow/models/publish_to_campaign"}
    ,{"uri":"/var/workflow/models/screens/publish_to_author_bin"}
    ,{"uri":"/var/workflow/models/s7dam/request_to_publish_to_youtube"}
    ,{"uri":"/var/workflow/models/projects/request_copy"}
    ,{"uri":"/var/workflow/models/projects/request_email"}
    ,{"uri":"/var/workflow/models/projects/request_landing_page"}
    ,{"uri":"/var/workflow/models/projects/request_launch"}
    ,{"uri":"/var/workflow/models/request_for_activation"}
    ,{"uri":"/var/workflow/models/request_for_deactivation"}
    ,{"uri":"/var/workflow/models/request_for_deletion"}
    ,{"uri":"/var/workflow/models/request_for_deletion_without_deactivation"}
    ,{"uri":"/var/workflow/models/request_to_complete_move_operation"}
    ,{"uri":"/var/workflow/models/reverse_replication"}
    ,{"uri":"/var/workflow/models/salesforce-com-export"}
    ,{"uri":"/var/workflow/models/scene7"}
    ,{"uri":"/var/workflow/models/scheduled_activation"}
    ,{"uri":"/var/workflow/models/scheduled_deactivation"}
    ,{"uri":"/var/workflow/models/screens/screens-update-asset"}
    ,{"uri":"/var/workflow/models/translation"}
    ,{"uri":"/var/workflow/models/s7dam/request_to_remove_from_youtube"}
    ,{"uri":"/var/workflow/models/wcm-translation/create_language_copy"}
    ,{"uri":"/var/workflow/models/wcm-translation/prepare_translation_project"}
    ,{"uri":"/var/workflow/models/wcm-translation/translate-i18n-dictionary"}
    ,{"uri":"/var/workflow/models/wcm-translation/sync_translation_job"}
    ,{"uri":"/var/workflow/models/wcm-translation/translate-language-copy"}
    ,{"uri":"/var/workflow/models/wcm-translation/update_language_copy"}
]

특정 워크플로우 모델 관리 managing-a-specific-workflow-model

다음 HTTP 요청 메서드는에 적용됩니다.

http://localhost:4502*{uri}*

위치 *{uri}* 는 저장소의 모델 노드에 대한 경로입니다.

예: 브라우저에서 http://localhost:4502/var/workflow/models/publish_example.json 반환: json 다음 코드와 유사한 응답:

{
  "id":"/var/workflow/models/publish_example",
  "title":"Publish Example",
  "version":"1.0",
  "description":"This example shows a simple review and publish process.",
  "metaData":
  {
    "multiResourceSupport":"true",
    "tags":"wcm,publish"
  },
  "nodes":
  [{
    "id":"node0",
    "type":"START",
    "title":"Start",
    "description":"The start node of the workflow.",
    "metaData":
    {
    }
  },
  {
    "id":"node1",
    "type":"PARTICIPANT",
    "title":"Validate Content",
    "description":"Validate the modified content.",
    "metaData":
    {
      "PARTICIPANT":"admin"
    }
  },
  {
    "id":"node2",
    "type":"PROCESS",
    "title":"Publish Content",
    "description":"Publish the modified content.",
    "metaData":
    {
      "PROCESS_AUTO_ADVANCE":"true",
      "PROCESS":"com.day.cq.wcm.workflow.process.ActivatePageProcess"
    }
  },
  {
    "id":"node3",
    "type":"END",
    "title":"End",
    "description":"The end node of the workflow.",
    "metaData":
    {
    }
  }],
  "transitions":
  [{
    "from":"node0",
    "to":"node1",
    "metaData":
    {
    }
  },
  {
    "from":"node1",
    "to":"node2",
    "metaData":
    {
    }
  },
  {
    "from":"node2",
    "to":"node3",
    "metaData":
    {
    }
  }
]}

버전별 워크플로우 모델 관리 managing-a-workflow-model-by-its-version

다음 HTTP 요청 메서드는에 적용됩니다.

http://localhost:4502/etc/workflow/models/{id}.{version}

(사용자) 받은 편지함 관리 managing-user-inboxes

다음 HTTP 요청 메서드는에 적용됩니다.

http://localhost:4502/bin/workflow/inbox

WorkItem ID로 (사용자) 받은 편지함 관리 managing-a-user-inbox-by-the-workitem-id

다음 HTTP 요청 메서드는에 적용됩니다.

http://localhost:4502/bin/workflow/inbox/{id}

예 examples

ID를 사용하여 실행 중인 모든 워크플로우 목록을 가져오는 방법 how-to-get-a-list-of-all-running-workflows-with-their-ids

실행 중인 모든 워크플로 목록을 가져오려면 GET으로 다음을 수행하십시오.

http://localhost:4502/etc/workflow/instances.RUNNING.json

ID를 사용하여 실행 중인 모든 워크플로우 목록을 가져오는 방법 - curl을 사용하여 REST how-to-get-a-list-of-all-running-workflows-with-their-ids-rest-using-curl

curl 사용 예:

curl -u admin:admin http://localhost:4502/etc/workflow/instances.RUNNING.json

다음 uri 결과에 표시된 를 인스턴스로 사용할 수 있습니다. id 다른 명령에서 다음을 수행합니다.

[
    {"uri":"/etc/workflow/instances/server0/2017-03-08/request_for_activation_1"}
]

워크플로우 제목을 변경하는 방법 how-to-change-the-workflow-title

을(를) 변경하려면 워크플로우 제목 에 표시됨 인스턴스 워크플로우 콘솔의 탭에서 POST 명령:

워크플로우 제목을 변경하는 방법 - CURL을 사용하여 REST how-to-change-the-workflow-title-rest-using-curl

curl 사용 예:

curl -u admin:admin -d "action=UPDATE&workflowTitle=myWorkflowTitle" http://localhost:4502/etc/workflow/instances/{id}

# for example
curl -u admin:admin -d "action=UPDATE&workflowTitle=myWorkflowTitle" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

모든 워크플로우 모델을 나열하는 방법 how-to-list-all-workflow-models

사용 가능한 모든 워크플로 모델 목록을 가져오려면 GET을 수행하여 다음을 수행합니다.

http://localhost:4502/etc/workflow/models.json

모든 워크플로우 모델을 나열하는 방법 - CURL을 사용하여 REST how-to-list-all-workflow-models-rest-using-curl

curl 사용 예:

curl -u admin:admin http://localhost:4502/etc/workflow/models.json

WorkflowSession 개체 가져오기 obtaining-a-workflowsession-object

다음 com.adobe.granite.workflow.WorkflowSession 클래스는 다음에서 조정할 수 있습니다. javax.jcr.Session 개체 또는 org.apache.sling.api.resource.ResourceResolver 개체.

WorkflowSession 개체 가져오기 - Java obtaining-a-workflowsession-object-java

JSP 스크립트(또는 서블릿 클래스에 대한 Java 코드)에서 HTTP 요청 개체를 사용하여 SlingHttpServletRequest 개체에 대한 액세스를 제공하는 ResourceResolver 개체. 조정 ResourceResolver 대상 오브젝트 WorkflowSession.

<%
%><%@include file="/libs/foundation/global.jsp"%><%
%><%@page session="false"
    import="com.adobe.granite.workflow.WorkflowSession,
  org.apache.sling.api.SlingHttpServletRequest"%><%

SlingHttpServletRequest slingReq = (SlingHttpServletRequest)request;
WorkflowSession wfSession = slingReq.getResourceResolver().adaptTo(WorkflowSession.class);
%>

WorkflowSession 개체 가져오기 - ECMA 스크립트 obtaining-a-workflowsession-object-ecma-script

사용 sling 변수를 사용하여 SlingHttpServletRequest 를 가져오는 데 사용하는 개체 ResourceResolver 개체. 조정 ResourceResolver 에 대한 오브젝트 WorkflowSession 개체.

var wfsession = sling.getRequest().getResource().getResourceResolver().adaptTo(Packages.com.adobe.granite.workflow.WorkflowSession);

워크플로우 모델 만들기, 읽기 또는 삭제 creating-reading-or-deleting-workflow-models

다음 예는 워크플로우 모델에 액세스하는 방법을 보여 줍니다.

사용된 예는 다음과 같습니다.

모델을 만들 때:

워크플로우 모델 만들기, 읽기 또는 삭제 - Java creating-reading-or-deleting-workflow-models-java

<%@include file="/libs/foundation/global.jsp"%><%
%><%@page session="false" import="com.adobe.granite.workflow.WorkflowSession,
                 com.adobe.granite.workflow.model.WorkflowModel,
             org.apache.sling.api.SlingHttpServletRequest"%><%

SlingHttpServletRequest slingReq = (SlingHttpServletRequest)request;
WorkflowSession wfSession = slingReq.getResourceResolver().adaptTo(WorkflowSession.class);
/* Create the parent page */
String modelRepo = new String("/var/workflow/models");
String modelTemplate = new String ("/libs/cq/workflow/templates/model");
String modelName = new String("mymodel");
Page modelParent = pageManager.create(modelRepo, modelName, modelTemplate, "My workflow model");

/* create the model */
String modelId = new String(modelParent.getPath()+"/jcr:content/model")
WorkflowModel model = wfSession.createNewModel("Made using Java",modelId);

/* delete the model */
wfSession.deleteModel(modelId);
%>

워크플로우 모델 만들기, 읽기 또는 삭제 - ECMA 스크립트 creating-reading-or-deleting-workflow-models-ecma-script

var resolver = sling.getRequest().getResource().getResourceResolver();
var wfSession = resolver.adaptTo(Packages.com.adobe.granite.workflow.WorkflowSession);
var pageManager = resolver.adaptTo(Packages.com.day.cq.wcm.api.PageManager);

//create the parent page node
var workflowPage = pageManager.create("/var/workflow/models", "mymodel", "/libs/cq/workflow/templates/model", "Created via ECMA Script");
var modelId = workflowPage.getPath()+ "/jcr:content/model";
//create the model
var model = wfSession.createNewModel("My Model", modelId);
//delete the model
var model = wfSession.deleteModel(modelId);

워크플로우 모델 삭제 - curl을 사용하여 REST deleting-a-workflow-model-rest-using-curl

# deleting the model by its id
curl -u admin:admin -X DELETE http://localhost:4502/etc/workflow/models/{id}

워크플로우 상태 확인 시 시스템 워크플로우 필터링 filtering-out-system-workflows-when-checking-workflow-status

다음을 사용할 수 있습니다. WorkflowStatus API 을 눌러 노드의 워크플로 상태에 대한 정보를 검색합니다.

다양한 메서드에는 매개 변수가 있습니다.

excludeSystemWorkflows

이 매개 변수는 다음으로 설정할 수 있습니다. true 관련 결과에서 시스템 워크플로를 제외해야 함을 나타냅니다.

본인 osgi 구성을 업데이트할 수 있습니다. Adobe Granite 워크플로 PayloadMapCache 워크플로를 지정하는 경우 Models 시스템 워크플로로 간주됩니다. 기본(런타임) 워크플로우 모델은 다음과 같습니다.

시간 제한 후 참가자 자동 이동 단계 auto-advance-participant-step-after-a-timeout

를 자동으로 진행해야 하는 경우 참가자 사전 정의된 시간 내에 완료되지 않은 단계는 다음과 같은 작업을 수행할 수 있습니다.

워크플로우 인스턴스와 상호 작용 interacting-with-workflow-instances

다음은 워크플로 인스턴스와 상호 작용하는 방법(프로그래밍 방식으로)에 대한 기본적인 예제를 제공합니다.

워크플로우 인스턴스와 상호 작용 - Java interacting-with-workflow-instances-java

// starting a workflow
WorkflowModel model = wfSession.getModel(workflowId);
WorkflowData wfData = wfSession.newWorkflowData("JCR_PATH", repoPath);
wfSession.startWorkflow(model, wfData);

// querying and managing a workflow
Workflow[] workflows workflows = wfSession.getAllWorkflows();
Workflow workflow= wfSession.getWorkflow(id);
wfSession.suspendWorkflow(workflow);
wfSession.resumeWorkflow(workflow);
wfSession.terminateWorkflow(workflow);

워크플로우 인스턴스와 상호 작용 - ECMA 스크립트 interacting-with-workflow-instances-ecma-script

// starting a workflow
var model = wfSession.getModel(workflowId);
var wfData = wfSession.newWorkflowData("JCR_PATH", repoPath);
wfSession.startWorkflow(model, wfData);

// querying and managing a workflow
var workflows = wfSession.getWorkflows("RUNNING");
var workflow= wfSession.getWorkflow(id);
wfSession.suspendWorkflow(workflow);
wfSession.resumeWorkflow(workflow);
wfSession.terminateWorkflow(workflow);

워크플로우 인스턴스와 상호 작용 - curl을 사용하여 REST interacting-with-workflow-instances-rest-using-curl

작업 항목과 상호 작용 interacting-with-work-items

다음은 작업 항목과 상호 작용하는(프로그래밍 방식으로) 방법에 대한 기본 예제를 제공합니다.

작업 항목과 상호 작용 - Java interacting-with-work-items-java

// querying work items
WorkItem[] workItems = wfSession.getActiveWorkItems();
WorkItem workItem = wfSession.getWorkItem(id);

// getting routes
List<Route> routes = wfSession.getRoutes(workItem);

// delegating
Iterator<Participant> delegatees = wfSession.getDelegatees(workItem);
wfSession.delegateWorkItem(workItem, delegatees.get(0));

// completing or advancing to the next step
wfSession.complete(workItem, routes.get(0));

작업 항목과 상호 작용 - ECMA 스크립트 interacting-with-work-items-ecma-script

// querying work items
var workItems = wfSession.getActiveWorkItems();
var workItem = wfSession.getWorkItem(id);

// getting routes
var routes = wfSession.getRoutes(workItem);

// delegating
var delegatees = wfSession.getDelegatees(workItem);
wfSession.delegateWorkItem(workItem, delegatees.get(0));

// completing or advancing to the next step
wfSession.complete(workItem, routes.get(0));

작업 항목과 상호 작용 - curl을 사용한 REST interacting-with-work-items-rest-using-curl

워크플로우 이벤트 수신 listening-for-workflow-events

OSGi 이벤트 프레임워크를 사용하여 com.adobe.granite.workflow.event.WorkflowEvent 클래스는 을 정의합니다. 이 클래스에서는 이벤트 주제에 대한 정보를 얻는 데 유용한 몇 가지 방법도 제공합니다. 예를 들어 getWorkItem 메서드는 WorkItem 이벤트에 포함된 작업 항목에 대한 개체입니다.

다음 예제 코드는 워크플로 이벤트를 수신하고 이벤트 유형에 따라 작업을 수행하는 서비스를 정의합니다.

package com.adobe.example.workflow.listeners;

import org.apache.sling.event.jobs.JobProcessor;
import org.apache.sling.event.jobs.JobUtil;

import org.osgi.service.event.Event;
import org.osgi.service.event.EventHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;

import com.adobe.granite.workflow.event.WorkflowEvent;
import com.adobe.granite.workflow.exec.WorkItem;

/**
 * The <code>WorkflowEventCatcher</code> class listens to workflow events.
 */
@Component(metatype=false, immediate=true)
@Service(value=org.osgi.service.event.EventHandler.class)
public class WorkflowEventCatcher implements EventHandler, JobProcessor {

 @Property(value=com.adobe.granite.workflow.event.WorkflowEvent.EVENT_TOPIC)
 static final String EVENT_TOPICS = "event.topics";

 private static final Logger logger = LoggerFactory.getLogger(WorkflowEventCatcher.class);

 public void handleEvent(Event event) {
  JobUtil.processJob(event, this);
 }

 public boolean process(Event event) {
  logger.info("Received event of topic: " + event.getTopic());
  String topic = event.getTopic();

  try {
   if (topic.equals(WorkflowEvent.EVENT_TOPIC)) {
    WorkflowEvent wfevent = (WorkflowEvent)event;
    String eventType = wfevent.getEventType();
    String instanceId = wfevent.getWorkflowInstanceId();

    if (instanceId != null) {
     //workflow instance events
     if (eventType.equals(WorkflowEvent.WORKFLOW_STARTED_EVENT) ||
       eventType.equals(WorkflowEvent.WORKFLOW_RESUMED_EVENT) ||
       eventType.equals(WorkflowEvent.WORKFLOW_SUSPENDED_EVENT)) {
      // your code comes here...
     } else if (
       eventType.equals(WorkflowEvent.WORKFLOW_ABORTED_EVENT) ||
       eventType.equals(WorkflowEvent.WORKFLOW_COMPLETED_EVENT)) {
      // your code comes here...
     }
     // workflow node event
     if (eventType.equals(WorkflowEvent.NODE_TRANSITION_EVENT)) {
      WorkItem currentItem = (WorkItem) event.getProperty(WorkflowEvent.WORK_ITEM);
      // your code comes here...
     }
    }
   }
  } catch(Exception e){
   logger.debug(e.getMessage());
   e.printStackTrace();
  }
  return true;
 }
}