워크플로 기능 확장 extending-workflow-functionality

이 항목에서는 워크플로우에 대한 사용자 지정 단계 구성 요소를 개발한 다음 워크플로우와 프로그래밍 방식으로 상호 작용하는 방법을 설명합니다.

사용자 지정 워크플로우 단계를 만드는 데에는 다음 활동이 포함됩니다.

  • 워크플로우 단계 구성 요소를 개발합니다.
  • 단계 기능을 OSGi 서비스 또는 ECMA 스크립트로 구현합니다.

프로그램 및 스크립트에서 워크플로우와 상호 작용할 수도 있습니다.

워크플로우 단계 구성 요소 - 기본 사항 workflow-step-components-the-basics

워크플로 단계 구성 요소는 워크플로 모델을 만들 때 단계의 모양과 비헤이비어를 정의합니다.

  • 워크플로우 사이드 킥의 카테고리 및 단계 이름입니다.
  • 워크플로 모델의 단계 모양입니다.
  • 구성 요소 속성 구성을 위한 편집 대화 상자
  • 런타임 시 실행되는 서비스 또는 스크립트입니다.

모든 구성 요소와 마찬가지로 워크플로 단계 구성 요소는 sling:resourceSuperType 속성에 지정된 구성 요소에서 상속됩니다. 다음 다이어그램은 모든 워크플로 단계 구성 요소의 기초를 이루는 cq:component 노드의 계층 구조를 보여 줍니다. 사용자 지정 단계 구성 요소를 개발하기 위한 가장 일반적인(및 기본) 시작 지점이므로 다이어그램에는 프로세스 단계, 참가자 단계동적 참가자 단계 구성 요소도 포함됩니다.

aem_wf_componentinherit

CAUTION
은(는) /libs 경로에서 아무 것도 변경하지 말아야 ​합니다.
이는 다음에 인스턴스를 업그레이드할 때 /libs의 콘텐츠가 덮어쓰기되기 때문입니다(핫픽스 또는 기능 팩을 적용할 때 덮어쓸 수도 있음).
구성 및 기타 변경에 권장되는 방법은 다음과 같습니다.
  1. 필요한 항목 다시 만들기(예: /apps 아래 /libs에 있음)
  2. /apps 내에서 변경

/libs/cq/workflow/components/model/step 구성 요소는 프로세스 단계, 참가자 단계동적 참가자 단계 ​의 가장 가까운 공통 상위 항목이며, 모두 다음 항목을 상속합니다.

  • step.jsp

    step.jsp 스크립트는 모델에 추가될 때 단계 구성 요소의 제목을 렌더링합니다.

    wf-22-1

  • cq:dialog

    다음 탭이 있는 대화 상자:

    • 일반: 제목 및 설명을 편집할 수 있습니다.
    • 고급: 전자 메일 알림 속성을 편집할 수 있습니다.

    wf-44 wf-45

    note note
    NOTE
    단계 구성 요소의 편집 대화 상자 탭이 이 기본 모양과 일치하지 않으면 단계 구성 요소에서 이러한 상속된 탭을 오버라이드하는 스크립트, 노드 속성 또는 대화 상자 탭을 정의했습니다.

ECMA 스크립트 ecma-scripts

다음 객체는 ECMA 스크립트 내에서 단계 유형에 따라 사용할 수 있습니다.

  • 작업 항목 작업 항목

  • WorkflowSession workflowSession

  • WorkflowData workflowData

  • args: 프로세스 인수를 사용하는 배열입니다.

  • sling: 다른 osgi 서비스에 액세스합니다.

  • jcrSession

메타데이터 맵 metadatamaps

워크플로 메타데이터를 사용하여 워크플로 수명 동안 필요한 정보를 유지할 수 있습니다. 워크플로우 단계의 일반적인 요구 사항은 나중에 워크플로우에서 사용할 수 있도록 데이터를 지속하거나 지속된 데이터를 검색하는 것입니다.

MetaDataMap 개체에는 Workflow, WorkflowDataWorkItem 개체의 세 가지 유형이 있습니다. 이들은 모두 메타데이터를 저장하기 위한 동일한 목적을 가지고 있습니다.

작업 항목에는 해당 작업 항목(예: 단계)이 실행되는 동안에만 사용할 수 있는 자체 MetaDataMap이 있습니다.

Workflow과(와) WorkflowData개의 메타데이터 맵 모두 전체 워크플로우에서 공유됩니다. 이러한 경우 WorkflowData 메타데이터 맵만 사용하는 것이 좋습니다.

사용자 지정 워크플로우 단계 구성 요소 만들기 creating-custom-workflow-step-components

워크플로 단계 구성 요소는 다른 구성 요소와 동일한 방식으로 만들 수 있습니다.

(기존) 기본 단계 구성 요소 중 하나에서 상속하려면 cq:Component 노드에 다음 속성을 추가하십시오.

  • 이름: sling:resourceSuperType

  • 유형: String

  • 값: 기본 구성 요소로 확인되는 다음 경로 중 하나:

    • cq/workflow/components/model/process
    • cq/workflow/components/model/participant
    • cq/workflow/components/model/dynamic_participant

단계 인스턴스에 대한 기본 제목 및 설명 지정 specifying-the-default-title-and-description-for-step-instances

공통 탭에서 제목설명 필드에 기본값을 지정하려면 다음 절차를 따르십시오.

NOTE
다음 요구 사항이 모두 충족되면 필드 값이 단계 인스턴스에 나타납니다.
  • 이 단계의 편집 대화 상자는 다음과 같은 위치에 제목과 설명을 저장합니다. >

  • ./jcr:title

  • ./jcr:description개 위치

    이 요구 사항은 편집 대화 상자에서 /libs/cq/flow/components/step/step 구성 요소가 구현하는 [일반] 탭을 사용할 때 충족됩니다.

  • 단계 구성 요소 또는 구성 요소의 상위 요소가 /libs/cq/flow/components/step/step 구성 요소가 구현하는 step.jsp 스크립트를 재정의하지 않습니다.

  1. cq:Component 노드 아래에 다음 노드를 추가하십시오.

    • 이름: cq:editConfig
    • 유형: cq:EditConfig
    note note
    NOTE
    cq:editConfig 노드에 대한 자세한 내용은 구성 요소의 편집 동작 구성을 참조하십시오.
  2. cq:EditConfig 노드 아래에 다음 노드를 추가하십시오.

    • 이름: cq:formParameters
    • 유형: nt:unstructured
  3. cq:formParameters 노드에 다음 이름의 String 속성을 추가하십시오.

    • jcr:title: 값이 공통 탭의 제목 필드를 채웁니다.
    • jcr:description: 값이 공통 탭의 설명 필드를 채웁니다.

워크플로 메타데이터의 속성 값 저장 saving-property-values-in-workflow-metadata

NOTE
데이터 유지 및 액세스를 참조하십시오. 특히 런타임에 속성 값에 액세스하는 방법에 대한 자세한 내용은 런타임에 대화 상자 속성 값에 액세스를 참조하십시오.

cq:Widget 항목의 이름 속성은 위젯 값을 저장하는 JCR 노드를 지정합니다. 워크플로 단계 구성 요소의 대화 상자에 있는 위젯이 ./metaData 노드 아래에 값을 저장하면 값이 워크플로 MetaDataMap에 추가됩니다.

예를 들어 대화 상자의 텍스트 필드는 다음 속성이 있는 cq:Widget 노드입니다.

이름
유형
xtype
String
textarea
name
String
./metaData/subject
fieldLabel
String
Email Subject

이 텍스트 필드에 지정된 값이 워크플로 인스턴스의 [MetaDataMap](#metadatamaps) 개체에 추가되고 subject 키와 연결됩니다.

NOTE
키가 PROCESS_ARGS이면 args 변수를 통해 ECMA 스크립트 구현에서 값을 바로 사용할 수 있습니다. 이 경우 이름 속성의 값은 ./metaData/PROCESS_ARGS.입니다.

단계 구현 재정의 overriding-the-step-implementation

각 기본 단계 구성 요소를 사용하여 워크플로 모델 개발자는 디자인 타임에 다음 주요 기능을 구성할 수 있습니다.

  • 프로세스 단계: 런타임 시 실행할 서비스 또는 ECMA 스크립트입니다.
  • 참가자 단계: 생성된 작업 항목이 할당된 사용자의 ID입니다.
  • 동적 참가자 단계: 작업 항목이 할당된 사용자의 ID를 선택하는 서비스 또는 ECMA 스크립트입니다.

특정 워크플로우 시나리오에서 사용할 구성 요소에 포커스를 맞추려면 디자인에서 주요 기능을 구성하고 모델 개발자가 변경할 수 있는 기능을 제거합니다.

  1. cq:component 노드 아래에 다음 노드를 추가합니다.

    • 이름: cq:editConfig
    • 유형: cq:EditConfig

    cq:editConfig 노드에 대한 자세한 내용은 구성 요소의 편집 동작 구성을 참조하십시오.

  2. cq:EditConfig 노드 아래에 다음 노드를 추가합니다.

    • 이름: cq:formParameters
    • 유형: nt:unstructured
  3. String 속성을 cq:formParameters 노드에 추가합니다. 구성 요소 수퍼 유형에 따라 속성의 이름이 결정됩니다.

    • 프로세스 단계: PROCESS
    • 참가자 단계: PARTICIPANT
    • 동적 참가자 단계: DYNAMIC_PARTICIPANT
  4. 속성 값을 지정합니다.

    • PROCESS: 단계 동작을 구현하는 서비스의 PID 또는 ECMA 스크립트의 경로입니다.
    • PARTICIPANT: 작업 항목이 할당된 사용자의 ID입니다.
    • DYNAMIC_PARTICIPANT: 작업 항목을 할당할 사용자를 선택하는 서비스의 PID 또는 ECMA 스크립트에 대한 경로입니다.
  5. 모델 개발자가 속성 값을 변경하는 기능을 제거하려면 구성 요소 수퍼 유형의 대화 상자를 재정의합니다.

참가자 단계에 Forms 및 대화 상자 추가 adding-forms-and-dialogs-to-participant-steps

참가자 단계 구성 요소를 사용자 지정하여 양식 참가자 단계대화 참가자 단계 구성 요소에서 제공하는 기능을 제공하십시오.

  • 생성된 작업 항목을 열 때 사용자에게 양식을 제공합니다.
  • 사용자가 생성된 작업 항목을 완료할 때 사용자 지정 대화 상자를 표시합니다.

새 구성 요소에서 다음 절차를 수행합니다(사용자 지정 워크플로 단계 구성 요소 만들기 참조).

  1. cq:Component 노드 아래에 다음 노드를 추가하십시오.

    • 이름: cq:editConfig
    • 유형: cq:EditConfig

    cq:editConfig 노드에 대한 자세한 내용은 구성 요소의 편집 동작 구성을 참조하십시오.

  2. cq:EditConfig 노드 아래에 다음 노드를 추가합니다.

    • 이름: cq:formParameters
    • 유형: nt:unstructured
  3. 사용자가 작업 항목을 열 때 양식을 표시하려면 cq:formParameters 노드에 다음 속성을 추가하십시오.

    • 이름: FORM_PATH
    • 유형: String
    • 값: 양식으로 확인되는 경로
  4. 사용자가 작업 항목을 완료할 때 사용자 지정 대화 상자를 표시하려면 cq:formParameters 노드에 다음 속성을 추가하십시오

    • 이름: DIALOG_PATH
    • 유형: String
    • 값: 대화 상자로 확인되는 경로

워크플로우 단계 런타임 동작 구성 configuring-the-workflow-step-runtime-behavior

cq:Component 노드 아래에 cq:EditConfig 노드를 추가하십시오. 아래에 nt:unstructured 노드(이름이 cq:formParameters이어야 함)를 추가하고 해당 노드에 다음 속성을 추가합니다.

  • 이름: PROCESS_AUTO_ADVANCE

    • 유형: Boolean

    • 값:

      • true(으)로 설정하면 워크플로가 해당 단계를 실행하고 계속됩니다. 기본값이며 권장됩니다.
      • false이면 워크플로가 실행되고 중지됩니다. 이 작업에는 추가 처리가 필요하므로 true을(를) 사용하는 것이 좋습니다.
  • 이름: DO_NOTIFY

    • 유형: Boolean
    • 값: 사용자 참여 단계를 위해 이메일 알림을 전송해야 하는지 여부를 나타냅니다(메일 서버가 올바르게 구성되었다고 가정).

데이터 유지 및 액세스 persisting-and-accessing-data

후속 워크플로우 단계를 위해 데이터 유지 persisting-data-for-subsequent-workflow-steps

워크플로 메타데이터를 사용하여 워크플로 수명 동안 필요한 정보(단계 간)를 유지할 수 있습니다. 워크플로우 단계의 일반적인 요구 사항은 나중에 사용하기 위해 데이터를 지속하거나 이전 단계에서 지속 데이터를 검색하는 것입니다.

워크플로 메타데이터는 MetaDataMap 개체에 저장됩니다. Java API는 적절한 MetaDataMap 개체를 제공하는 WorkflowData 개체를 반환하는 Workflow.getWorkflowData 메서드를 제공합니다. 이 WorkflowData MetaDataMap 개체는 단계 구성 요소의 OSGi 서비스 또는 ECMA 스크립트에서 사용할 수 있습니다.

Java java

WorkflowProcess 구현의 실행 메서드가 WorkItem 개체에 전달됩니다. 이 개체를 사용하여 현재 워크플로 인스턴스의 WorkflowData 개체를 가져옵니다. 다음 예제에서는 워크플로 MetaDataMap 개체에 항목을 추가한 다음 각 항목을 기록합니다. ("mykey", "내 단계 값") 항목은 워크플로우의 후속 단계에서 사용할 수 있습니다.

public void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException {

    MetaDataMap wfd = item.getWorkflow().getWorkflowData().getMetaDataMap();

    wfd.put("mykey", "My Step Value");

    Set<String> keyset = wfd.keySet();
    Iterator<String> i = keyset.iterator();
    while (i.hasNext()){
     Object key = i.next();
     log.info("The workflow medata includes key {} and value {}",key.toString(),wfd.get(key).toString());
    }
}

ECMA 스크립트 ecma-script

graniteWorkItem 변수는 현재 WorkItem Java 개체의 ECMA 스크립트 표현입니다. 따라서 graniteWorkItem 변수를 사용하여 워크플로 메타데이터를 가져올 수 있습니다. 다음 ECMA 스크립트를 사용하여 프로세스 단계 ​를 구현하여 워크플로 MetaDataMap 개체에 항목을 추가한 다음 각 항목을 기록할 수 있습니다. 그런 다음 워크플로우의 후속 단계에서 이러한 항목을 사용할 수 있습니다.

NOTE
단계 스크립트에서 즉시 사용할 수 있는 metaData 변수는 단계의 메타데이터입니다. 단계 메타데이터가 워크플로우 메타데이터와 다릅니다.
var currentDateInMillis = new Date().getTime();

graniteWorkItem.getWorkflowData().getMetaDataMap().put("hardcodedKey","theKey");

graniteWorkItem.getWorkflowData().getMetaDataMap().put("currentDateInMillisKey",currentDateInMillis);

var iterator = graniteWorkItem.getWorkflowData().getMetaDataMap().keySet().iterator();
while (iterator.hasNext()){
    var key = iterator.next();
    log.info("Workflow metadata key, value = " + key.toString() + ", " + graniteWorkItem.getWorkflowData().getMetaDataMap().get(key));
}

런타임 시 대화 상자 속성 값 액세스 accessing-dialog-property-values-at-runtime

워크플로 인스턴스의 MetaDataMap 개체는 워크플로 수명 내내 데이터를 저장하고 검색하는 데 유용합니다. 워크플로 단계 구성 요소 구현의 경우 MetaDataMap은(는) 런타임 시 구성 요소 속성 값을 검색하는 데 특히 유용합니다.

NOTE
속성을 워크플로 메타데이터로 저장하도록 구성 요소 대화 상자를 구성하는 방법에 대한 자세한 내용은 워크플로 메타데이터에 속성 값 저장을 참조하십시오.

MetaDataMap 워크플로는 Java 및 ECMA 스크립트 프로세스 구현에 사용할 수 있습니다.

  • WorkflowProcess 인터페이스의 Java 구현에서 args 매개 변수는 워크플로의 MetaDataMap 개체입니다.

  • ECMA 스크립트 구현에서 argsmetadata 변수를 사용하여 값을 사용할 수 있습니다.

예: 프로세스 단계 구성 요소의 인수 검색 example-retrieving-the-arguments-of-the-process-step-component

프로세스 단계 구성 요소의 편집 대화 상자에 인수 속성이 포함되어 있습니다. Arguments 속성 값은 워크플로 메타데이터에 저장되며 PROCESS_ARGS 키와 연결됩니다.

다음 다이어그램에서 Arguments 속성의 값은 argument1, argument2입니다.

wf-24

Java java-1

다음 Java 코드는 WorkflowProcess 구현을 위한 execute 메서드입니다. 메서드는 PROCESS_ARGS 키와 연결된 args MetaDataMap에 값을 기록합니다.

public void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException {
     if (args.containsKey("PROCESS_ARGS")){
      log.info("workflow metadata for key PROCESS_ARGS and value {}",args.get("PROCESS_ARGS","string").toString());
     }
    }

이 Java 구현을 사용하는 프로세스 단계가 실행되면 로그에 다음 항목이 포함됩니다.

16.02.2018 12:07:39.566 *INFO* [JobHandler: /var/workflow/instances/server0/2018-02-16/model_855140139900189:/content/we-retail/de] com.adobe.example.workflow.impl.process.LogArguments workflow metadata for key PROCESS_ARGS and value argument1, argument2

ECMA 스크립트 ecma-script-1

다음 ECMA 스크립트가 프로세스 단계 ​의 프로세스로 사용됩니다. 인수의 수와 인수 값을 기록합니다.

var iterator = graniteWorkItem.getWorkflowData().getMetaDataMap().keySet().iterator();
while (iterator.hasNext()){
    var key = iterator.next();
    log.info("Workflow metadata key, value = " + key.toString() + ", " + graniteWorkItem.getWorkflowData().getMetaDataMap().get(key));
}
log.info("hardcodedKey "+ graniteWorkItem.getWorkflowData().getMetaDataMap().get("hardcodedKey"));
log.info("currentDateInMillisKey "+ graniteWorkItem.getWorkflowData().getMetaDataMap().get("currentDateInMillisKey"));
NOTE
이 섹션에서는 프로세스 단계에 대한 인수를 사용하여 작업하는 방법을 설명합니다. 이 정보는 동적 참가자 선택기에도 적용됩니다.
NOTE
워크플로우 메타데이터에 구성 요소 속성을 저장하는 다른 예는 예제: 로거 워크플로우 단계 생성을 참조하십시오. 이 예제에서는 메타데이터 값을 PROCESS_ARGS 이외의 키와 연결하는 대화 상자를 제공합니다.

스크립트 및 프로세스 인수 scripts-and-process-arguments

프로세스 단계 구성 요소에 대한 스크립트 내에서 args 개체를 통해 인수를 사용할 수 있습니다.

사용자 지정 단계 구성 요소를 만들 때 스크립트에서 metaData 개체를 사용할 수 있습니다. 이 개체는 단일 문자열 인수로 제한됩니다.

프로세스 단계 구현 개발 developing-process-step-implementations

워크플로우 프로세스 중에 프로세스 단계가 시작되면 OSGi 서비스에 요청을 보내거나 ECMA 스크립트를 실행합니다. 워크플로우에 필요한 작업을 수행하는 서비스 또는 ECMA 스크립트를 개발합니다.

NOTE
프로세스 단계 구성 요소를 서비스 또는 스크립트와 연결하는 방법에 대한 자세한 내용은 프로세스 단계 또는 단계 구현 재정의를 참조하십시오.

Java 클래스를 사용하여 프로세스 단계 구현 implementing-a-process-step-with-a-java-class

프로세스 단계를 OSGI 서비스 구성 요소(Java 번들)로 정의하려면 다음을 수행합니다.

  1. 번들을 만들고 OSGI 컨테이너에 배포합니다. CRXDE Lite 또는 Eclipse을 사용하여 번들을 만드는 방법에 대한 설명서를 참조하세요.

    note note
    NOTE
    OSGI 구성 요소는 execute() 메서드로 WorkflowProcess 인터페이스를 구현해야 합니다. 아래의 예제 코드를 참조하십시오.
    note note
    NOTE
    패키지 이름을 maven-bundle-plugin 구성의 <*Private-Package*> 섹션에 추가해야 합니다.
  2. SCR 속성 process.label을(를) 추가하고 필요에 따라 값을 설정하십시오. 일반 프로세스 단계 구성 요소를 사용할 때 프로세스 단계가 나열되는 이름입니다. 아래 예를 참조하십시오.

  3. 모델 편집기에서 일반 프로세스 단계 구성 요소를 사용하여 워크플로우에 프로세스 단계를 추가합니다.

  4. 프로세스 단계 ​의 편집 대화 상자에서 프로세스 탭으로 이동하여 프로세스 구현을 선택하십시오.

  5. 코드에서 인수를 사용하는 경우 프로세스 인수 ​를 설정하십시오. 예: false.

  6. 단계와 워크플로우 모델(모델 편집기의 왼쪽 상단 모서리) 모두에 대해 변경 사항을 저장합니다.

실행 가능한 Java 메서드를 구현하는 각 클래스는 OSGI 서비스로 등록되므로 런타임 중에 언제든지 메서드를 추가할 수 있습니다.

다음 OSGI 구성 요소는 페이로드가 페이지인 경우 approved 속성을 페이지 콘텐츠 노드에 추가합니다.

package com.adobe.example.workflow.impl.process;

import com.adobe.granite.workflow.WorkflowException;
import com.adobe.granite.workflow.WorkflowSession;
import com.adobe.granite.workflow.exec.WorkItem;
import com.adobe.granite.workflow.exec.WorkflowData;
import com.adobe.granite.workflow.exec.WorkflowProcess;
import com.adobe.granite.workflow.metadata.MetaDataMap;

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

import org.osgi.framework.Constants;

import javax.jcr.Node;
import javax.jcr.RepositoryException;
import javax.jcr.Session;

/**
 * Sample workflow process that sets an <code>approve</code> property to the payload based on the process argument value.
 */
@Component
@Service
public class MyProcess implements WorkflowProcess {

 @Property(value = "An example workflow process implementation.")
 static final String DESCRIPTION = Constants.SERVICE_DESCRIPTION;
 @Property(value = "Adobe")
 static final String VENDOR = Constants.SERVICE_VENDOR;
 @Property(value = "My Sample Workflow Process")
 static final String LABEL="process.label";

 private static final String TYPE_JCR_PATH = "JCR_PATH";

 public void execute(WorkItem item, WorkflowSession session, MetaDataMap args) throws WorkflowException {
  WorkflowData workflowData = item.getWorkflowData();
  if (workflowData.getPayloadType().equals(TYPE_JCR_PATH)) {
   String path = workflowData.getPayload().toString() + "/jcr:content";
   try {
    Session jcrSession = session.adaptTo(Session.class);
    Node node = (Node) jcrSession.getItem(path);
    if (node != null) {
     node.setProperty("approved", readArgument(args));
     jcrSession.save();
    }
   } catch (RepositoryException e) {
    throw new WorkflowException(e.getMessage(), e);
   }
  }
 }

 private boolean readArgument(MetaDataMap args) {
  String argument = args.get("PROCESS_ARGS", "false");
  return argument.equalsIgnoreCase("true");
 }
}
NOTE
프로세스가 세 번 연속적으로 실패하면 항목이 워크플로우 관리자의 받은 편지함에 배치됩니다.

ECMAScript 사용 using-ecmascript

스크립트 개발자는 ECMA 스크립트를 사용하여 프로세스 단계를 구현할 수 있습니다. 스크립트는 JCR 저장소에 있으며 여기에서 실행됩니다.

다음 표에는 스크립트를 처리하는 데 즉시 사용할 수 있는 변수가 나열되어 있어 워크플로우 Java API의 객체에 대한 액세스를 제공합니다.

Java 클래스
스크립트 변수 이름
설명
com.adobe.granite.workflow.exec.WorkItem
graniteWorkItem
현재 단계 인스턴스.
com.adobe.granite.workflow.WorkflowSession
graniteWorkflowSession
현재 단계 인스턴스의 워크플로 세션입니다.
String[](프로세스 인수 포함)
args
단계 인수.
com.adobe.granite.workflow.metadata.MetaDataMap
metaData
현재 단계 인스턴스의 메타데이터.
org.apache.sling.scripting.core.impl.InternalScriptHelper
sling
Sling 런타임 환경에 액세스할 수 있습니다.

다음 예제 스크립트는 워크플로우 페이로드를 나타내는 JCR 노드에 액세스하는 방법을 보여 줍니다. graniteWorkflowSession 변수는 페이로드 경로에서 노드를 가져오는 데 사용되는 JCR 세션 변수에 맞게 조정되었습니다.

var workflowData = graniteWorkItem.getWorkflowData();
if (workflowData.getPayloadType() == "JCR_PATH") {
    var path = workflowData.getPayload().toString();
    var jcrsession = graniteWorkflowSession.adaptTo(Packages.javax.jcr.Session);
    var node = jcrsession.getNode(path);
    if (node.hasProperty("approved")){
     node.setProperty("approved", args[0] == "true" ? true : false);
     node.save();
 }
}

다음 스크립트는 페이로드가 이미지(.png 파일)인지 확인하고 페이로드에서 흑백 이미지를 만들어 형제 노드로 저장합니다.

var workflowData = graniteWorkItem.getWorkflowData();
if (workflowData.getPayloadType() == "JCR_PATH") {
    var path = workflowData.getPayload().toString();
    var jcrsession = graniteWorkflowSession.adaptTo(Packages.javax.jcr.Session);
    var node = jcrsession.getRootNode().getNode(path.substring(1));
     if (node.isNodeType("nt:file") && node.getProperty("jcr:content/jcr:mimeType").getString().indexOf("image/") == 0) {
        var is = node.getProperty("jcr:content/jcr:data").getStream();
        var layer = new Packages.com.day.image.Layer(is);
        layer.grayscale();
                var parent = node.getParent();
                var gn = parent.addNode("grey" + node.getName(), "nt:file");
        var content = gn.addNode("jcr:content", "nt:resource");
                content.setProperty("jcr:mimeType","image/png");
                var cal = Packages.java.util.Calendar.getInstance();
                content.setProperty("jcr:lastModified",cal);
                var f = Packages.java.io.File.createTempFile("test",".png");
        var tout = new Packages.java.io.FileOutputStream(f);
        layer.write("image/png", 1.0, tout);
        var fis = new Packages.java.io.FileInputStream(f);
                content.setProperty("jcr:data", fis);
                parent.save();
        tout.close();
        fis.close();
        is.close();
        f.deleteOnExit();
    }
}

스크립트를 사용하려면:

  1. 스크립트를 만들고(예: CRXDE Lite 사용) //apps/workflow/scripts/ 아래 리포지토리에 저장하십시오.

  2. 프로세스 단계 편집 대화 상자에서 스크립트를 식별하는 제목을 지정하려면 스크립트의 jcr:content 노드에 다음 속성을 추가하십시오.

    table 0-row-3 1-row-3 2-row-3
    이름 유형
    jcr:mixinTypes Name[] mix:title
    jcr:title String 편집 대화 상자에 표시할 이름입니다.
  3. 프로세스 단계 인스턴스를 편집하고 사용할 스크립트를 지정하십시오.

참가자 선택기 개발 developing-participant-choosers

동적 참가자 단계 구성 요소에 대한 참가자 선택기를 개발할 수 있습니다.

워크플로 중에 동적 참가자 단계 구성 요소가 시작되면 단계에서 생성된 작업 항목을 할당할 수 있는 참가자를 결정해야 합니다. 다음 중 한 단계를 수행합니다.

  • OSGi 서비스에 요청을 보냅니다.
  • ECMA 스크립트를 실행하여 참가자를 선택합니다.

워크플로우의 요구 사항에 따라 참가자를 선택하는 서비스 또는 ECMA 스크립트를 개발할 수 있습니다.

NOTE
동적 참가자 단계 구성 요소를 서비스 또는 스크립트와 연결하는 방법에 대한 자세한 내용은 동적 참가자 단계 또는 단계 구현 재정의를 참조하십시오.

Java 클래스를 사용하여 참가자 선택기 개발 developing-a-participant-chooser-using-a-java-class

참가자 단계를 OSGI 서비스 구성 요소(Java 클래스)로 정의하려면

  1. OSGI 구성 요소는 getParticipant() 메서드로 ParticipantStepChooser 인터페이스를 구현해야 합니다. 아래의 예제 코드를 참조하십시오.

    번들을 만들고 OSGI 컨테이너에 배포합니다.

  2. SCR 속성 chooser.label을(를) 추가하고 필요에 따라 값을 설정하십시오. 참가자 선택기의 이름은 동적 참가자 단계 구성 요소를 사용하여 표시됩니다. 예제를 참조하십시오.

    code language-java
    package com.adobe.example.workflow.impl.process;
    
    import com.adobe.granite.workflow.WorkflowException;
    import com.adobe.granite.workflow.WorkflowSession;
    import com.adobe.granite.workflow.exec.ParticipantStepChooser;
    import com.adobe.granite.workflow.exec.WorkItem;
    import com.adobe.granite.workflow.exec.WorkflowData;
    import com.adobe.granite.workflow.metadata.MetaDataMap;
    
    import org.apache.felix.scr.annotations.Component;
    import org.apache.felix.scr.annotations.Property;
    import org.apache.felix.scr.annotations.Service;
    
    import org.osgi.framework.Constants;
    
    /**
     * Sample dynamic participant step that determines the participant based on a path given as argument.
     */
    @Component
    @Service
    
    public class MyDynamicParticipant implements ParticipantStepChooser {
    
     @Property(value = "An example implementation of a dynamic participant chooser.")
     static final String DESCRIPTION = Constants.SERVICE_DESCRIPTION;
        @Property(value = "Adobe")
        static final String VENDOR = Constants.SERVICE_VENDOR;
        @Property(value = "Dynamic Participant Chooser Process")
        static final String LABEL=ParticipantStepChooser.SERVICE_PROPERTY_LABEL;
    
        private static final String TYPE_JCR_PATH = "JCR_PATH";
    
        public String getParticipant(WorkItem workItem, WorkflowSession workflowSession, MetaDataMap args) throws WorkflowException {
            WorkflowData workflowData = workItem.getWorkflowData();
            if (workflowData.getPayloadType().equals(TYPE_JCR_PATH)) {
                String path = workflowData.getPayload().toString();
                String pathFromArgument = args.get("PROCESS_ARGS", String.class);
                if (pathFromArgument != null && path.startsWith(pathFromArgument)) {
                    return "admin";
                }
            }
            return "administrators";
        }
    }
    
  3. 모델 편집기에서 일반 동적 참가자 단계 구성 요소를 사용하여 워크플로에 동적 참가자 단계를 추가하십시오.

  4. 편집 대화 상자에서 참가자 선택기 탭을 선택하고 선택기 구현을 선택합니다.

  5. 코드에서 인수를 사용하는 경우 프로세스 인수 ​를 설정합니다. 예: /content/we-retail/de.

  6. 단계와 워크플로우 모델 모두에 대해 변경 사항을 저장합니다.

ECMA 스크립트를 사용하여 참가자 선택기 개발 developing-a-participant-chooser-using-an-ecma-script

참가자 단계 ​에서 생성하는 작업 항목이 할당된 사용자를 선택하는 ECMA 스크립트를 만들 수 있습니다. 스크립트에는 인수가 필요하지 않은 getParticipant 함수가 포함되어야 하며 사용자 또는 그룹의 ID가 포함된 String을(를) 반환합니다.

스크립트는 JCR 저장소에 있으며 여기에서 실행됩니다.

다음 표에는 스크립트의 워크플로우 Java 객체에 즉시 액세스할 수 있는 변수가 나열되어 있습니다.

Java 클래스
스크립트 변수 이름
com.adobe.granite.workflow.exec.WorkItem
graniteWorkItem
com.adobe.granite.workflow.WorkflowSession
graniteWorkflowSession
String[](프로세스 인수 포함)
args
com.adobe.granite.workflow.metadata.MetaDataMap
metaData
org.apache.sling.scripting.core.impl.InternalScriptHelper
sling
function getParticipant() {
    var workflowData = graniteWorkItem.getWorkflowData();
    if (workflowData.getPayloadType() == "JCR_PATH") {
        var path = workflowData.getPayload().toString();
        if (path.indexOf("/content/we-retail/de") == 0) {
            return "admin";
        } else {
            return "administrators";
        }
    }
}
  1. 스크립트를 만들고(예: CRXDE Lite 사용) //apps/workflow/scripts 아래 리포지토리에 저장하십시오.

  2. 프로세스 단계 편집 대화 상자에서 스크립트를 식별하는 제목을 지정하려면 스크립트의 jcr:content 노드에 다음 속성을 추가하십시오.

    table 0-row-3 1-row-3 2-row-3
    이름 유형
    jcr:mixinTypes Name[] mix:title
    jcr:title String 편집 대화 상자에 표시할 이름입니다.
  3. 동적 참가자 단계 인스턴스를 편집하고 사용할 스크립트를 지정하십시오.

워크플로우 패키지 처리 handling-workflow-packages

워크플로 패키지를 처리를 위해 워크플로에 전달할 수 있습니다. 워크플로우 패키지에는 페이지 및 에셋과 같은 리소스에 대한 참조가 포함되어 있습니다.

NOTE
다음 워크플로우 프로세스 단계에서는 벌크 페이지 활성화를 위한 워크플로우 패키지를 수락합니다.

패키지 리소스를 가져와 처리하는 워크플로우 단계를 개발할 수 있습니다. com.day.cq.workflow.collection 패키지의 다음 멤버는 워크플로 패키지에 액세스할 수 있습니다.

  • ResourceCollection: 워크플로 패키지 클래스입니다.
  • ResourceCollectionUtil: ResourceCollection 개체를 검색하는 데 사용합니다.
  • ResourceCollectionManager: 컬렉션을 만들고 검색합니다. 구현은 OSGi 서비스로 배포됩니다.

다음 예제 Java 클래스는 패키지 리소스를 가져오는 방법을 보여 줍니다.

package com.adobe.example;

import java.util.ArrayList;
import java.util.List;

import com.day.cq.workflow.WorkflowException;
import com.day.cq.workflow.WorkflowSession;
import com.day.cq.workflow.collection.ResourceCollection;
import com.day.cq.workflow.collection.ResourceCollectionManager;
import com.day.cq.workflow.collection.ResourceCollectionUtil;
import com.day.cq.workflow.exec.WorkItem;
import com.day.cq.workflow.exec.WorkflowData;
import com.day.cq.workflow.exec.WorkflowProcess;
import com.day.cq.workflow.metadata.MetaDataMap;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.apache.felix.scr.annotations.Reference;
import org.osgi.framework.Constants;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.jcr.Node;
import javax.jcr.PathNotFoundException;
import javax.jcr.RepositoryException;
import javax.jcr.Session;

@Component
@Service
public class LaunchBulkActivate implements WorkflowProcess {

 private static final Logger log = LoggerFactory.getLogger(LaunchBulkActivate.class);

 @Property(value="Bulk Activate for Launches")
  static final String PROCESS_NAME ="process.label";
 @Property(value="A sample workflow process step to support Launches bulk activation of pages")
 static final String SERVICE_DESCRIPTION = Constants.SERVICE_DESCRIPTION;

 @Reference
 private ResourceCollectionManager rcManager;
public void execute(WorkItem workItem, WorkflowSession workflowSession) throws Exception {
    Session session = workflowSession.getSession();
    WorkflowData data = workItem.getWorkflowData();
    String path = null;
    String type = data.getPayloadType();
    if (type.equals(TYPE_JCR_PATH) && data.getPayload() != null) {
        String payloadData = (String) data.getPayload();
        if (session.itemExists(payloadData)) {
            path = payloadData;
        }
    } else if (data.getPayload() != null && type.equals(TYPE_JCR_UUID)) {
        Node node = session.getNodeByUUID((String) data.getPayload());
        path = node.getPath();
    }

    // CUSTOMIZED CODE IF REQUIRED....

    if (path != null) {
        // check for resource collection
        ResourceCollection rcCollection = ResourceCollectionUtil.getResourceCollection((Node)session.getItem(path), rcManager);
        // get list of paths to replicate (no resource collection: size == 1
        // otherwise size >= 1
        List<String> paths = getPaths(path, rcCollection);
        for (String aPath: paths) {

            // CUSTOMIZED CODE....

        }
    } else {
        log.warn("Cannot process because path is null for this " + "workitem: " + workItem.toString());
    }
}

/**
 * helper
 */
private List<String> getPaths(String path, ResourceCollection rcCollection) {
    List<String> paths = new ArrayList<String>();
    if (rcCollection == null) {
        paths.add(path);
    } else {
        log.debug("ResourceCollection detected " + rcCollection.getPath());
        // this is a resource collection. the collection itself is not
        // replicated. only its members
        try {
            List<Node> members = rcCollection.list(new String[]{"cq:Page", "dam:Asset"});
            for (Node member: members) {
                String mPath = member.getPath();
                paths.add(mPath);
            }
        } catch(RepositoryException re) {
            log.error("Cannot build path list out of the resource collection " + rcCollection.getPath());
        }
    }
    return paths;
}
}

예제: 사용자 정의 단계 생성 example-creating-a-custom-step

사용자 지정 단계를 만들기 쉬운 방법은 다음 위치에서 기존 단계를 복사하는 것입니다.

/libs/cq/workflow/components/model

기본 단계 만들기 creating-the-basic-step

  1. /apps 아래에 경로를 다시 생성합니다. 예:

    /apps/cq/workflow/components/model

    새 폴더 유형은 nt:folder입니다.

    code language-xml
    - apps
      - cq
        - workflow (nt:folder)
          - components (nt:folder)
            - model (nt:folder)
    
    note note
    NOTE
    이 단계는 클래식 UI 모델 편집기에 적용되지 않습니다.
  2. 그런 다음 복사한 단계를 /apps 폴더에 배치합니다. 예를 들면 다음과 같습니다.

    /apps/cq/workflow/components/model/myCustomStep

    다음은 사용자 지정된 예제 단계의 결과입니다.

    wf-34

    note caution
    CAUTION
    표준 UI에서는 제목만 표시되고 세부 정보는 카드에 표시되지 않으므로 클래식 UI 편집기의 경우처럼 details.jsp이(가) 필요하지 않습니다.
  3. 노드에 다음 속성을 적용합니다.

    /apps/cq/workflow/components/model/myCustomStep

    관심 있는 속성:

    • sling:resourceSuperType

      기존 단계에서 상속해야 합니다.

      이 예제에서는 cq/workflow/components/model/step의 기본 단계에서 상속하지만 participant, process 등의 다른 Super 형식을 사용할 수 있습니다.

    • jcr:title

      구성 요소가 단계 브라우저(워크플로우 모델 편집기의 왼쪽 패널)에 나열될 때 표시되는 제목입니다.

    • cq:icon

      단계의 Coral 아이콘을 지정하는 데 사용됩니다.

    • componentGroup

      다음 중 하나여야 합니다.

      • 협업 워크플로우
      • DAM 워크플로우
      • 양식 워크플로우
      • 프로젝트
      • WCM 워크플로우
      • 워크플로

    wf-35

  4. 이제 편집할 워크플로우 모델을 열 수 있습니다. 단계 브라우저에서 필터링하여 내 사용자 지정 단계 ​를 볼 수 있습니다.

    wf-36

    내 사용자 지정 단계 ​을(를) 모델에 드래그하면 다음과 같은 카드가 표시됩니다.

    wf-37

    단계에 대해 cq:icon이(가) 정의되지 않은 경우 제목의 처음 두 글자를 사용하여 기본 아이콘이 렌더링됩니다. 예:

    wf-38

단계 구성 대화 상자 정의 defining-the-step-configure-dialog

기본 단계 만들기구성 대화 상자를 다음과 같이 정의합니다.

  1. cq:editConfig 노드의 속성을 다음과 같이 구성하십시오.

    관심 있는 속성:

    • cq:inherit

      true(으)로 설정하면 단계 구성 요소가 sling:resourceSuperType에서 지정한 단계로부터 속성을 상속합니다.

    • cq:disableTargeting

      필요에 따라 설정합니다.

    wf-39

  2. cq:formsParameter 노드의 속성을 다음과 같이 구성하십시오.

    관심 있는 속성:

    • jcr:title

      모델 맵의 단계 카드와 내 사용자 지정 - 단계 속성 구성 대화 상자의 제목 필드에 기본 제목을 설정합니다.

    • 사용자 지정 속성을 정의할 수도 있습니다.

    wf-40

  3. cq:listeners 노드에서 속성을 구성하십시오.

    cq:listener 노드 및 해당 속성을 사용하면 터치 사용 UI 모델 편집기의 이벤트에 반응하는 이벤트 처리기를 설정할 수 있습니다. 예를 들어 단계를 모델 페이지로 드래그하거나 단계 속성을 편집할 수 있습니다.

    관심 있는 속성:

    • afterMove: REFRESH_PAGE
    • afterdelete: CQ.workflow.flow.Step.afterDelete
    • afteredit: CQ.workflow.flow.Step.afterEdit
    • afterinsert: CQ.workflow.flow.Step.afterInsert

    편집기의 적절한 기능에 필수인 이 구성입니다. 대부분의 경우 이 구성은 변경되지 않아야 합니다.

    그러나 cq:editConfig 노드에서 cq:inherit을(를) true로 설정하면 단계 정의에 명시적으로 포함할 필요 없이 이 구성을 상속할 수 있습니다. 상속이 없으면 다음 속성 및 값을 사용하여 이 노드를 추가해야 합니다.

    이 예제에서는 상속이 활성화되었으므로 cq:listeners 노드를 제거할 수 있으며 단계가 계속 제대로 작동합니다.

    wf-41

  4. 이제 단계의 인스턴스를 워크플로우 모델에 추가할 수 있습니다. 단계를 구성 ​하면 다음과 같은 대화 상자가 표시됩니다.

    wf-42 wf-43

이 예제에 사용된 샘플 마크업 sample-markup-used-in-this-example

사용자 지정 단계에 대한 마크업이 구성 요소 루트 노드의 .content.xml에 표시됩니다. 이 예제에 사용된 샘플 .content.xml:

/apps/cq/workflow/components/model/myCustomStep/.content.xml

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0"
    cq:icon="bell"
    jcr:primaryType="cq:Component"
    jcr:title="My Custom Step"
    sling:resourceSuperType="cq/workflow/components/model/process"
    allowedParents="[*/parsys]"
    componentGroup="Workflow"/>

이 예제에 사용된 _cq_editConfig.xml 샘플:

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
    cq:disableTargeting="{Boolean}true"
    cq:inherit="{Boolean}true"
    jcr:primaryType="cq:EditConfig">
    <cq:formParameters
        jcr:primaryType="nt:unstructured"
        jcr:title="My Custom Step Card"
        SAMPLE_PROPERY="sample value"/>
    <cq:listeners
        jcr:primaryType="cq:EditListenersConfig"
        afterdelete="CQ.workflow.flow.Step.afterDelete"
        afteredit="CQ.workflow.flow.Step.afterEdit"
        afterinsert="CQ.workflow.flow.Step.afterInsert"
        afterMove="REFRESH_PAGE"/>
</jcr:root>

이 예제에 사용된 _cq_dialog/.content.xml 샘플:

<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:sling="https://sling.apache.org/jcr/sling/1.0" xmlns:cq="https://www.day.com/jcr/cq/1.0" xmlns:jcr="https://www.jcp.org/jcr/1.0" xmlns:nt="https://www.jcp.org/jcr/nt/1.0"
    jcr:primaryType="nt:unstructured"
    jcr:title="My Custom - Step Properties"
    sling:resourceType="cq/gui/components/authoring/dialog">
    <content
        jcr:primaryType="nt:unstructured"
        sling:resourceType="granite/ui/components/coral/foundation/tabs">
        <items jcr:primaryType="nt:unstructured">
            <common
                cq:hideOnEdit="true"
                jcr:primaryType="nt:unstructured"
                jcr:title="Common"
                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns"/>
            <process
                cq:hideOnEdit="true"
                jcr:primaryType="nt:unstructured"
                jcr:title="Process"
                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns"/>
            <mycommon
                jcr:primaryType="nt:unstructured"
                jcr:title="Common"
                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns">
                <items jcr:primaryType="nt:unstructured">
                    <columns
                        jcr:primaryType="nt:unstructured"
                        sling:resourceType="granite/ui/components/coral/foundation/container">
                        <items jcr:primaryType="nt:unstructured">
                            <title
                                jcr:primaryType="nt:unstructured"
                                sling:resourceType="granite/ui/components/coral/foundation/form/textfield"
                                fieldLabel="Title"
                                name="./jcr:title"/>
                            <description
                                jcr:primaryType="nt:unstructured"
                                sling:resourceType="granite/ui/components/coral/foundation/form/textarea"
                                fieldLabel="Description"
                                name="./jcr:description"/>
                        </items>
                    </columns>
                </items>
            </mycommon>
            <advanced
                jcr:primaryType="nt:unstructured"
                jcr:title="Advanced"
                sling:resourceType="granite/ui/components/coral/foundation/fixedcolumns">
                <items jcr:primaryType="nt:unstructured">
                    <columns
                        jcr:primaryType="nt:unstructured"
                        sling:resourceType="granite/ui/components/coral/foundation/container">
                        <items jcr:primaryType="nt:unstructured">
                            <email
                                jcr:primaryType="nt:unstructured"
                                sling:resourceType="granite/ui/components/coral/foundation/form/checkbox"
                                fieldDescription="Notify user via email."
                                fieldLabel="Email"
                                name="./metaData/PROCESS_AUTO_ADVANCE"
                                text="Notify user via email."
                                value="true"/>
                        </items>
                    </columns>
                </items>
            </advanced>
        </items>
    </content>
</jcr:root>
NOTE
대화 상자 정의에 공통 및 프로세스 노드가 표시됩니다. 이는 사용자 지정 단계의 슈퍼타입으로 사용한 프로세스 단계에서 상속됩니다.
sling:resourceSuperType : cq/workflow/components/model/process
NOTE
클래식 UI 모델 편집기 대화 상자는 여전히 터치 사용이 가능한 표준 UI 편집기에서 작동합니다.
AEM에 현대화 도구가 있지만 클래식 UI 단계 대화 상자를 표준 UI 대화 상자로 업그레이드하려면 이 도구를 사용하십시오. 변환 후에도 특정 경우에 대해 대화 상자에 수행할 수 있는 몇 가지 수동 개선 사항이 있습니다.
  • 업그레이드된 대화 상자가 비어 있는 경우 솔루션을 제공하는 방법의 예제와 유사한 기능을 가진 /libs의 대화 상자를 볼 수 있습니다. 예:

  • /libs/cq/workflow/components/model

  • /libs/cq/workflow/components/workflow

  • /libs/dam/components

  • /libs/wcm/workflow/components/autoassign

  • /libs/cq/projects

    /libs에서 아무 것도 편집하지 말고 예제로 사용하십시오. 기존 단계를 사용하려면 /apps(으)로 복사하고 편집하십시오.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2