Xrm.Page.data.process(클라이언트 쪽 참조)

 

게시 날짜: 2016년 11월

적용 대상: Dynamics CRM 2015

Microsoft Dynamics CRM 2015 및 Microsoft Dynamics CRM Online 2015 업데이트를 사용하여 Xrm.Page.data.process 네임스페이스는 양식에 있는 비즈니스 프로세스 흐름 데이터와 상호 작용하기 위한 이벤트, 메서드 및 개체를 제공합니다.

양식에 있는 비즈니스 프로세스 흐름 컨트롤과 상호 작용하는 메서드는 Xrm.Page.ui.process(클라이언트 쪽 참조)를 참조하십시오.

Xrm.Page.data.process 메서드

• ActiveProcess 메서드
  getActiveProcess를 사용하여 활성 프로세스에 대한 정보를 검색하고 setActiveProcess를 사용하여 다른 프로세스를 활성 프로세스로 설정합니다.

• ActiveStage 메서드
  getActiveStage를 사용하여 활성 스테이지에 대한 정보를 검색하고 setActiveStage를 사용하여 완료된 스테이지를 활성 스테이지로 설정합니다.

  Microsoft Dynamics CRM Online 2015 업데이트 1에서는 다른 엔터티의 스테이지에 setActiveStage를 사용할 수 있습니다.

• getActivePath
  이 메서드를 사용하여 비즈니스 프로세스 흐름 컨트롤에 표시된 스테이지와 상호 작용하기 위한 메서드가 있는 현재 활성 경로에서 스테이지의 컬렉션을 가져옵니다.

  활성 경로는 분기 규칙과 레코드의 현재 데이터를 기반으로 프로세스 컨트롤에서 현재 렌더링된 스테이지를 나타냅니다.

• getEnabledProcesses
  이 메서드를 사용하여 사용자가 엔터티에 대해 전환할 수 있는 활성화된 비즈니스 프로세스 흐름을 비동기적으로 검색합니다.

• getSelectedStage
  Microsoft Dynamics CRM Online 2015 업데이트 1에 추가되었으며 이 메서드를 사용하여 현재 선택된 스테이지에 액세스합니다.

• 이벤트 처리기를 관리하는 방법
  addOnStageChange, removeOnStageChange, addOnStageSelected 및 removeOnStageSelected 메서드를 사용하여 비즈니스 프로세스 흐름 컨트롤에 대한 이벤트 처리기를 추가하거나 제거합니다.

• 탐색 메서드
  moveNext를 사용하여 다음 스테이지로 이동하고 movePrevious를 사용하여 이전 스테이지로 이동합니다.

  Microsoft Dynamics CRM Online 2015 업데이트 1에서는 다른 엔터티의 이전 스테이지에 movePrevious를 사용할 수 있습니다.

• 프로세스 메서드
  프로세스 메서드를 사용하여 프로세스의 속성에 액세스합니다.

• 스테이지 메서드
  스테이지 메서드를 사용하여 비즈니스 프로세스 흐름에 있는 스테이지의 속성에 액세스합니다.

• 단계 메서드
  단계 메서드를 사용하여 비즈니스 프로세스 흐름에 있는 스테이지의 단계 속성에 액세스합니다.

ActiveProcess 메서드

getActiveProcess를 사용하여 활성 프로세스에 대한 정보를 검색하고 setActiveProcess를 사용하여 다른 프로세스를 활성 프로세스로 설정합니다.

getActiveProcess

활성 프로세스를 나타내는 Process 개체를 반환합니다.

var activeProcess = Xrm.Page.data.process.getActiveProcess();

• 반환 값
  유형: 프로세스

  설명: 반환된 프로세스의 속성에 액세스하는 메서드는 프로세스 메서드를 참조하십시오.

setActiveProcess

Process를 활성 프로세스로 설정합니다.

Xrm.Page.data.process.setActiveProcess(processId, callbackFunction);

매개 변수:

• processId
  유형:String

  설명: 활성 프로세스를 확인하는 프로세스의 Id입니다.

• callbackFunction
  유형:Function

  설명: 작업이 완료될 때 호출할 함수입니다. 이 콜백 함수에 작업 성공 여부를 나타내기 위해 다음 문자열 값 중 하나가 전달됩니다.

  값	설명
  성공	작업이 성공했습니다.
  유효하지 않음	processId가 유효하지 않거나 프로세스가 활성화되어 있지 않습니다.

ActiveStage 메서드

getActiveStage를 사용하여 활성 스테이지에 대한 정보를 검색하고 setActiveStage를 사용하여 다른 스테이지를 활성 스테이지로 설정합니다.

getActiveStage

활성 스테이지를 나타내는 Stage 개체를 반환합니다.

var activeStage = Xrm.Page.data.process.getActiveStage();

• 반환 값
  유형: 스테이지

  설명: 반환된 스테이지의 속성에 액세스하는 메서드는 스테이지 메서드를 참조하십시오.

setActiveStage

완료된 스테이지를 활성 스테이지로 설정합니다.

참고

Microsoft Dynamics CRM Online 2015 업데이트 1에서는 다른 엔터티의 스테이지에 이 메서드를 사용할 수 있습니다.

엔터티에 대해 완료된 스테이지만 이 메서드를 사용하여 설정할 수 있습니다.

Xrm.Page.data.process.setActiveStage(stageId, callbackFunction);

매개 변수:

• stageId
  유형:String

  설명: 엔터티에 대해 활성 스테이지로 만들 완료된 스테이지의 ID입니다.

• callbackFunction
  유형:Function

  설명: 작업이 완료될 때 호출할 선택적인 함수입니다.

  작업이 성공적으로 완료되면 콜백 함수에 “success” 문자열 값이 전달됩니다.

  stageId가 유효하지 않은 스테이지를 나타내는 경우 스테이지는 활성화되지 않고 콜백 함수에는 이유를 나타내는 문자열이 전달됩니다. 다음 표에 나열된 값이 반환됩니다.

  값	원인
  crossEntity	스테이지는 현재 엔터티에 대한 것이어야 합니다.
  invalid	다음은 이 값이 반환될 수 있는 세 가지 이유입니다. stageId 매개 변수가 존재하지 않는 스테이지 ID 값입니다. 활성 스테이지가 선택된 스테이지가 아닙니다. 레코드가 아직 저장되지 않았습니다.
  unreachable	스테이지가 다른 경로에 존재합니다.
  dirtyForm	페이지의 데이터에 저장되지 않은 경우 이 값이 반환됩니다.

  중요

  이 방법은 선택한 스테이지와 활성 스테이지가 동일한 경우에만 사용할 수 있습니다. 코드가 OnStageChange 이벤트에서 시작되면 현재 스테이지가 선택됩니다. 코드가 OnStageSelected 이벤트에서 시작되면 Xrm.Page.data.process.getActiveStage를 사용하여 선택한 스테이지도 활성 스테이지인지 확인해야 합니다. 다른 양식 이벤트의 경우 현재 선택된 스테이지를 확인할 수 없습니다. 최상의 결과를 얻기 위해 이 방법은 OnStageChange 및 OnStageSelected 이벤트에서 시작되는 함수에서 호출되는 코드에서만 사용해야 합니다.

getActivePath

이 메서드를 사용하여 비즈니스 프로세스 흐름 컨트롤에 표시된 스테이지와 상호 작용하기 위한 메서드가 있는 현재 활성 경로에서 스테이지의 컬렉션을 가져옵니다.

활성 경로는 분기 규칙과 레코드의 현재 데이터를 기반으로 프로세스 컨트롤에서 현재 렌더링된 스테이지를 나타냅니다.

var stageCollection = Xrm.Page.data.process.getActivePath();

예제:

이 메서드를 사용하는 예제는 샘플: Xrm.Page.data.process.getActivePath를 참조하십시오.

• 반환 값
  유형: 컬렉션

  Remarks: 모든 완료된 스테이지의 컬렉션, 현재 활성 스테이지 및 분기 규칙에서 충족된 조건을 기반으로 하는 미래 스테이지의 예측된 집합입니다. 이는 프로세스에서 발생한 분기를 기반으로 현재 스테이지에서 유효한 전환을 나타내는 스테이지만 포함하므로 **Xrm.Page.data.process.**getActiveProcess에서 반환되는 스테이지의 하위 집합일 수 있습니다.

getEnabledProcesses

이 메서드를 사용하여 사용자가 엔터티에 대해 전환할 수 있는 활성화된 비즈니스 프로세스 흐름을 비동기적으로 검색합니다.

Xrm.Page.data.process.getEnabledProcesses(callbackFunction(enabledProcesses));

• 매개 변수
  유형:Function

  설명: 콜백 함수는 속성의 이름이 비즈니스 프로세스 흐름의 Id이고 속성의 값이 비즈니스 프로세스 흐름의 이름인 사전 속성을 가진 개체를 포함하는 매개 변수를 허용해야 합니다.

  활성화된 프로세스는 사용자의 권한에 따라 필터링됩니다. 활성화된 프로세스의 목록은 프로세스를 수동으로 변경하려는 경우 UI에서 사용자가 볼 수 있는 것과 같은 목록입니다.

  예제:

  이 메서드를 사용하는 예제는 샘플: Xrm.Page.data.process.getEnabledProcesses를 참조하십시오.

getSelectedStage

이 메서드를 사용하여 현재 선택된 스테이지를 가져옵니다.

Xrm.Page.data.process.getSelectedStage()

• 반환 값
  유형: 스테이지

  현재 선택된 스테이지입니다.

• 설명
  이 메서드가 Microsoft Dynamics CRM Online 2015 업데이트 1에 추가되었습니다.

  반환된 스테이지의 속성에 액세스하는 메서드는 스테이지 메서드를 참조하십시오.

이벤트 처리기를 관리하는 방법

이러한 메서드를 사용하여 비즈니스 프로세스 흐름 컨트롤에 대한 이벤트 처리기를 추가하거나 제거합니다.

addOnStageChange

이 메서드를 사용하여 비즈니스 프로세스 흐름 스테이지가 변경될 때 호출되도록 OnStageChange 이벤트에 대한 이벤트 처리기로 함수를 추가합니다.

Xrm.Page.data.process.addOnStageChange(handler);

• 매개 변수
  유형: 함수 참조

  Remarks: 함수는 이벤트 처리기 파이프라인의 맨 아래에 추가됩니다. 실행 컨텍스트는 이벤트 처리기에 전달된 첫 번째 매개 변수로 자동 설정됩니다. 자세한 내용은 실행 컨텍스트(클라이언트 쪽 참조)을 참조하십시오.

  나중에 이벤트 처리기를 제거하려는 경우 익명의 함수 대신 명명된 함수에 대한 참조를 사용해야 합니다.

removeOnStageChange

이 메서드를 사용하여 OnStageChange 이벤트에 대한 이벤트 처리기로 함수를 제거합니다.

Xrm.Page.data.process.removeOnStageChange(handler);

• 매개 변수
  유형: 함수 참조

  Remarks: 익명의 함수가 addOnStageChange 메서드를 사용하여 설정된 경우 이 메서드를 사용하여 제거할 수 없습니다.

addOnStageSelected

이 메서드를 사용하여 비즈니스 프로세스 흐름 스테이지가 선택될 때 호출되도록 OnStageSelected 이벤트에 대한 이벤트 처리기로 함수를 추가합니다.

Xrm.Page.data.process.addOnStageSelected(handler);

• 매개 변수
  유형: 함수 참조

  Remarks: 함수는 이벤트 처리기 파이프라인의 맨 아래에 추가됩니다. 실행 컨텍스트는 이벤트 처리기에 전달된 첫 번째 매개 변수로 자동 설정됩니다. 자세한 내용은 실행 컨텍스트(클라이언트 쪽 참조)을 참조하십시오.

  나중에 이벤트 처리기를 제거하려는 경우 익명의 함수 대신 명명된 함수에 대한 참조를 사용해야 합니다.

removeOnStageSelected

이 메서드를 사용하여 OnStageSelected 이벤트에 대한 이벤트 처리기로 함수를 제거합니다.

Xrm.Page.data.process.removeOnStageSelected(function reference);

• 매개 변수
  유형: 함수 참조

  Remarks: 익명의 함수가 addOnStageSelected 메서드를 사용하여 설정된 경우 이 메서드를 사용하여 제거할 수 없습니다.

탐색 메서드

moveNext를 사용하여 다음 스테이지로 이동하고 movePrevious를 사용하여 이전 스테이지로 이동합니다. 이러한 두 메서드로 인해 OnStageChange 이벤트가 발생합니다.

moveNext

다음 스테이지로 진행합니다.

Xrm.Page.data.process.moveNext(callbackFunction);

• 매개 변수
  유형: 함수

  설명: 작업이 완료될 때 호출할 선택적인 함수입니다. 이 콜백 함수에 작업 성공 여부를 나타내기 위해 다음 문자열 값 중 하나가 전달됩니다.

  값	설명
  성공	작업이 성공했습니다.
  crossEntity	다음 스테이지는 다른 엔터티를 위한 것입니다.
  종료	활성 스테이지는 활성 경로의 마지막 스테이지입니다.
  유효하지 않음	선택한 스테이지가 활성 스테이지와 다르므로 작업이 실패했습니다.
  dirtyForm	페이지의 데이터에 저장되지 않은 경우 이 값이 반환됩니다.

중요

이 방법은 선택한 스테이지와 활성 스테이지가 동일한 경우에만 사용할 수 있습니다. 코드가 OnStageChange 이벤트에서 시작되면 현재 스테이지가 선택됩니다. 코드가 OnStageSelected 이벤트에서 시작되면 Xrm.Page.data.process.getActiveStage를 사용하여 선택한 스테이지도 활성 스테이지인지 확인해야 합니다. 다른 양식 이벤트의 경우 현재 선택된 스테이지를 확인할 수 없습니다. 최상의 결과를 얻기 위해 이 방법은 OnStageChange 및 OnStageSelected 이벤트에서 시작되는 함수에서 호출되는 코드에서만 사용해야 합니다.

movePrevious

이전 스테이지로 이동합니다.Microsoft Dynamics CRM Online 2015 업데이트 1에서는 다른 엔터티의 이전 스테이지에 movePrevious를 사용할 수 있습니다.

Xrm.Page.data.process.movePrevious(callbackFunction);

• 매개 변수
  유형: 함수

  설명: 작업이 완료될 때 호출할 선택적인 함수입니다. 이 콜백 함수에 작업 성공 여부를 나타내기 위해 다음 문자열 값 중 하나가 전달됩니다.

  값	설명
  성공	작업이 성공했습니다.
  crossEntity	이전 스테이지는 다른 엔터티를 위한 것입니다.
  시작	활성 스테이지는 활성 경로의 첫 스테이지입니다.
  유효하지 않음	선택한 스테이지가 활성 스테이지와 다르므로 작업이 실패했습니다.
  dirtyForm	페이지의 데이터에 저장되지 않은 경우 이 값이 반환됩니다.

중요

이 방법은 선택한 스테이지와 활성 스테이지가 동일한 경우에만 사용할 수 있습니다. 코드가 OnStageChange 이벤트에서 시작되면 현재 스테이지가 선택됩니다. 코드가 OnStageSelected 이벤트에서 시작되면 Xrm.Page.data.process.getActiveStage를 사용하여 선택한 스테이지도 활성 스테이지인지 확인해야 합니다. 다른 양식 이벤트의 경우 현재 선택된 스테이지를 확인할 수 없습니다. 최상의 결과를 얻기 위해 이 방법은 OnStageChange 및 OnStageSelected 이벤트에서 시작되는 함수에서 호출되는 코드에서만 사용해야 합니다.

참고

Microsoft Dynamics CRM Online 2015 업데이트 1에서는 다른 엔터티에 대한 스테이지로 돌아가는 데 이 메서드를 사용할 수 있습니다.

프로세스 메서드

프로세스는 비즈니스 프로세스 흐름에 대한 데이터를 포함합니다. 이 메서드를 사용하여 프로세스의 속성에 액세스합니다.

getId

프로세스의 고유 식별자를 반환합니다.

var processId = procObj.getId();

• 반환 값
  유형:String

  설명: 값은 GUID 값의 문자열 표현을 나타냅니다.

getName

프로세스의 이름을 반환합니다.

var processName = procObj.getName();

• 반환 값
  유형:String

getStages

프로세스에서 스테이지의 컬렉션을 반환합니다.

var stageCollection = procObj.getStages();

• 반환 값
  유형: 컬렉션

  반환된 스테이지의 속성에 액세스하는 메서드는 스테이지 메서드를 참조하십시오.

isRendered

프로세스가 렌더링되는 경우 True를 반환하고, 그렇지 않으면 false입니다.

var processRendered = procObj.isRendered();

• 반환 값
  유형:Boolean

  설명: 사용된 양식이 Microsoft Dynamics CRM의 이전 버전에서 업그레이드되었고 새로운 양식을 사용하도록 업그레이드되지 않은 경우 비즈니스 프로세스 흐름 컨트롤을 렌더링할 수 없습니다.추가 정보:TechNet: Microsoft Dynamics CRM 2013 또는 Microsoft Dynamics CRM Online 2013년 가을로 양식 업데이트

스테이지 메서드

스테이지는 비즈니스 프로세스 흐름의 스테이지에 대한 데이터를 포함합니다. 이 메서드를 사용하여 스테이지의 속성에 액세스합니다.

getCategory

비즈니스 프로세스 흐름 범주의 정수 값을 반환하는 getValue 메서드를 사용하여 개체를 반환합니다.

var stageCategoryNumber = stageObj.getCategory().getValue();

• 반환 값
  유형:Number

  설명: 가능한 값의 목록은 스테이지 범주(processstage_category)를 참조하십시오.

getEntityName

스테이지가 연관된 엔터티의 논리 이름을 반환합니다.

var stageEntityName = stageObj.getEntityName();

• 반환 값
  유형:String

getId

스테이지의 고유 식별자를 반환합니다.

var stageId = stageObj.getId();

• 반환 값
  유형:String

getName

스테이지의 이름을 반환합니다.

var stageName = stageObj.getName();

• 반환 값
  유형:String

getStatus

스테이지의 상태를 반환합니다.

var stageStatus = stageObj.getStatus();

• 반환 값
  유형:String

  설명: 이 메서드는 active 또는 inactive를 반환합니다.

getSteps

스테이지에서 단계의 컬렉션을 반환합니다.

var stepsCollection = stageObj.getSteps();

• 반환 값
  유형:Array

  단계의 속성 값에 액세스하는 메서드는 단계 메서드를 참조하십시오.

단계 메서드

단계는 비즈니스 프로세스 흐름의 단계에 대한 데이터를 포함합니다. 이 메서드를 사용하여 단계의 속성에 액세스합니다.

getAttribute

단계가 연관된 특성의 논리 이름을 반환합니다.

var stepAttributeName = stepObj.getAttribute();

• 반환 값
  유형:String

  설명: 일부 단계는 특성 값을 포함하지 않습니다.

getName

단계의 이름을 반환합니다.

var stepName = stepObj.getName();

• 반환 값
  유형:String

isRequired

단계가 비즈니스 프로세스 흐름에 필요한지 여부를 반환합니다.

var stepIsRequired = stepObj.isRequired();

• 반환 값
  유형:Boolean

  설명: 단계가 비즈니스 프로세스 흐름 편집기에서 필수로 표시된 경우 true를 반환하고, 그렇지 않으면 false를 반환합니다. 이 값과 Xrm.Page.data.entity 특성 RequiredLevel 메서드에서 사용자가 변경할 수 있는 값 사이에 연결이 없습니다.

참고 항목

비즈니스 프로세스 흐름에 대한 스크립트 작성
Xrm.Page.ui.process(클라이언트 쪽 참조)
클라이언트 쪽 프로그래밍 참조
양식 스크립팅 빠른 참조
Microsoft Dynamics CRM 2015 양식용 코드 작성
Xrm.Page 개체 모델 사용
샘플: Xrm.Page.data.process.getEnabledProcesses
샘플: Xrm.Page.data.process.getActivePath

© 2017 Microsoft. All rights reserved. 저작권 정보