커스텀 액션 메뉴 항목

API 개발자는 액션 메뉴 항목(AMI)을 통해 엔티티별로 상황에 맞는 메뉴 항목을 커스터마이즈할 수 있습니다. 예를 들어, 여러 버전을 선택하고 마우스 오른쪽 버튼을 클릭한 다음 “PDF 보고서 작성(Build a PDF Report)”을 선택할 수 있습니다.

액션 메뉴 항목 필드

1. 제목(Title)(title): 메뉴 항목의 표시 이름입니다.

2. 엔티티 유형(Entity Type)(entity_type): 메뉴 항목을 한 가지 엔티티 유형의 페이지(예: 버전(Version))에만 나타나도록 제한합니다. 이 키를 생략(nil 값)하면 메뉴 항목이 모든 활성화된 엔티티에 허용됩니다.

3. URL(url): PDF 보고서를 생성하는 스크립트의 URL입니다.

4. 순서(Order)(list_order): 메뉴 항목의 순서입니다(다른 커스텀 메뉴 항목에 상대적임).

5. 경량 페이로드(Light Payload)(light_payload): 커스텀 프로토콜을 사용하는 경우 스크립트가 전체 페이로드 대신 페이로드 정보를 보관하는 이벤트 로그 항목 레코드의 ID를 수신합니다.

6. 구성 메뉴 옵션: 다음과 같은 몇 가지 옵션 중에서 선택할 수 있습니다.

엔티티 레코드의 마우스 오른쪽 버튼 클릭 메뉴에 포함: 레코드를 마우스 오른쪽 버튼으로 클릭하여 AMI를 포함하는 기본값입니다.
엔티티 페이지의 “엔티티 추가(Add Entity)” 드롭다운 메뉴에 포함: 엔티티 추가(Add Entity)” 드롭다운 메뉴에 이 AMI를 포함하는 옵션입니다(예: “에셋 추가(Add Asset)”, “샷 추가(Add Shot)” 등).
엔티티 페이지에서 “엔티티 추가(Add Entity)” 버튼 재정의: 이 옵션을 사용하면 “엔티티 추가(Add Entity)” 버튼을 AMI로 덮어쓸 수 있습니다.
사용자 메뉴의 내부 리소스(Internal Resources) 섹션에 포함: 내부 리소스를 사용하여 사용자 메뉴를 커스터마이즈할 수 있는 옵션이 제공됩니다. 내부 리소스를 사용하여 사용자 메뉴를 커스터마이즈하는 방법에 대한 자세한 내용은 여기를 참조하십시오.

7. 폴더(Folder)(folder): 상황에 맞는 메뉴 내 폴더에 AMI를 구성할 수 있습니다(현재로서는 단일 수준의 폴더만 지원됨).

8. 모달 오버레이에서 열기(Open in Modal Overlay): AMI가 새 탭 대신 iframe 창에서 열리도록 합니다. 참고로, ShotGrid가 HTTPS를 실행 중인 경우 모든 iframe도 HTTPS여야 합니다.

9. 데이터 업데이트 폴링(Poll for Data Updates)(poll_for_data_updates): 이벤트 로그 항목을 쿼리하는 폴링 루프를 시작합니다. 액션 메뉴 항목의 다른 쪽에 있는 코드가 API를 통해 ShotGrid에 다시 액션 메뉴 항목을 트리거한 페이지에 표시되는 엔티티에 대한 변경 작업을 수행하는 경우에 해당합니다.

10. 권한 그룹으로 제한(Restrict to Permission Groups)(permissions_groups): 지정된 권한 그룹만 AMI에 액세스하도록 제한할 수 있습니다. 비워 두면 모든 사용자가 AMI를 사용할 수 있습니다.

11. 프로젝트로 제한(Restrict to Projects)(projects): AMI가 지정된 프로젝트에만 표시되도록 합니다. 비워 두면 AMI를 모든 프로젝트에서 사용할 수 있습니다.

12. 비밀 토큰(Secret Token): 비밀 토큰을 설정하여 AMI를 보호합니다.

13. 선택 필요(Selection Required)(selection_required): 현재 선택된 행이 없는 경우 메뉴 항목이 활성화되는지 여부를 결정합니다.

액션 메뉴 항목 유형

생성할 수 있는 메뉴 항목 유형은 두 가지입니다.

HTTP URL 예시

한 예로, “PDF 보고서 작성(Build a PDF Report)”이라는 커스텀 메뉴 항목을 생성할 수 있습니다. 이렇게 하면 사람들이 버전 페이지로 이동하여 하나 이상의 버전을 선택하고 마우스 오른쪽 버튼을 클릭한 다음 ShotGrid 메뉴에서 “PDF 보고서 작성(Build a PDF Report)”을 선택할 수 있습니다. 그러면 스크립트(사용자가 생성해야 함)가 실행되면서 깔끔한 형식의 보고서가 브라우저로 다시 전송됩니다. 작동 방식은 다음과 같습니다.

UI를 통해 메뉴 항목 생성

설정(Settings) 메뉴에서 액션 메뉴 항목(Action Menu Items)을 선택하여 AMI 관리자(AMI Admin) 페이지를 엽니다.

새 AMI를 생성하려면 를 클릭합니다.

제목(Title) 및 기타 필수 필드를 입력하고, “액션 메뉴 항목 만들기(Create Action Menu Item)”를 클릭합니다.

사용자가 AMI를 클릭하면 어떻게 될까요?

ShotGrid 소프트웨어가 새 창에서, 또는 해당 옵션을 선택한 경우 모달 대화상자에서 POST 요청을 발송하고, 현재 페이지에서 수신 URL로 데이터를 함께 전송합니다(POST 요청의 일부로 전송). 다음은 이 워크플로우의 예입니다.

사용자가 버전 페이지로 이동
사용자가 하나 이상의 버전 선택
사용자가 상황에 맞는 메뉴 호출(마우스 오른쪽 버튼 클릭 또는 도구막대에서 기어 메뉴 클릭)
사용자가 ‘PDF 보고서 작성(Build a PDF Report)’ 클릭
ShotGrid 소프트웨어가 새 창에서 AMI의 URL로 POST 요청 발송(ShotGrid 서버는 HTTPS에서 구동되고, 사용자 URL은 HTTP에서 구동되는 경우에는 브라우저 경고가 표시될 수 있음)
지정된 URL에 위치한 사용자 스크립트가 POST 데이터를 처리하고, PDF 문서 생성
사용자가 보거나 다운로드할 수 있는 깔끔한 형식의 PDF 보고서가 사용자에게 다시 전송됨

커스텀 프로토콜 처리기 예시

커스텀 AMI를 한 차원 높게 구현하는 작업에는 커스텀 프로토콜 처리기(예: ShotGrid://process_version)를 설정하는 작업이 수반됩니다. 이렇게 하면 로컬 컴퓨터에서 스크립트를 통해 ShotGrid 소프트웨어를 Maya, RV 또는 Cinesync 같은 응용프로그램과 연동할 수 있습니다. 비-HTTP(S) 프로토콜을 지정하면 데이터가 POST 대신 GET을 통해 사용자 URL로 전송됩니다. 이 방법을 사용하여 내부 도구를 실행하고 다양한 요청을 발송할 수도 있습니다.

커스텀 프로토콜에 관한 자세한 정보는 커스텀 브라우저 프로토콜을 사용하여 응용프로그램 실행을 참조하십시오.

참고: ShotGrid 통합을 통해 Maya 및 기타 소프트웨어 패키지와의 통합도 기본 제공합니다.

경량 페이로드

커스텀 프로토콜 사용 시 쿼리 정보는 GET 요청으로 전송됩니다. 특정 운영 체제와 브라우저 조합에 따라 허용되는 GET 요청 크기에 다양한 제약이 있습니다. 그래서 커스텀 프로토콜 AMI에서 경량 페이로드 체크박스를 선택하는 것이 좋습니다. 경량 페이로드를 선택한 상태에서는 스크립트가 단일 이벤트 로그 항목 ID를 수신하고, 이를 불러와 레코드 meta 필드의 ami_payload 키를 읽어 풀 페이로드를 가져올 수 있습니다.

예

다음은 시작하는 데 도움이 될 만한 몇 가지 관련 예시 스크립트입니다.

페이로드 컨텐츠

사용자 데이터

user_id: 현재 로그인한 사용자의 사용자 ID(예: 34)
user_login: 현재 로그인한 사용자의 로그인 정보(예: joe)

엔티티 데이터

entity_type: 현재 페이지 또는 뷰의 엔티티 유형(예: 버전)
selected_ids: 선택한 엔티티 ID를 쉼표로 분리한 목록(예: 931, 900)
ids: 현재 페이지의 쿼리에서 반환된 모든 엔티티 ID를 쉼표로 분리한 목록. 이는 페이지 매김 때문에 보이지 않는 항목을 포함한 모든 ID를 반환합니다(예: 931, 900, 904, 907). AMI에서 “선택 필수(Selection required)”를 선택한 경우 이 값은 selected_ids와 같아집니다.

페이지 데이터

title: 페이지 제목(예: “모든 버전”)
page_id: 액션 메뉴 항목이 클릭된 페이지의 ID(예: 1353)
server_hostname: AMI가 트리거된 시스템의 호스트 이름. 스테이징 서버와 프로덕션 서버 등 같은 AMI를 호출하는 여러 서버가 있는 경우 유용할 수 있습니다.
referrer_path: AMI가 호출된 URL의 정규 경로.
session_uuid: 이 AMI가 호출된 창의 고유 식별자. 이 기능은 “데이터 업데이트 폴링(Poll for Data Updates)” 체크박스 및 Python API의 set_session_uuid 메서드와 함께 사용하여 AMI가 호출된 페이지로 정보를 다시 브로드캐스트할 수 있습니다. 참고: 이 기능의 업데이트 폴링은 기하급수적으로 감소하며, 폴링이 중지될 때까지 AMI가 업데이트되지 않으면 결국 중지되어 소스 페이지에서 업데이트를 볼 수 없게 될 수도 있습니다.
cols: 페이지에 표시되는 모든 열의 시스템 필드 이름을 쉼표로 분리한 목록(예: code, sg_status_list, description)
column_display_names: 페이지에 표시되는 모든 열의 표시 이름을 쉼표로 분리한 목록(예: 버전, 상태, 설명)
view: AMI가 호출되었을 때 선택했던 뷰. 페이지 디자인 모드를 통해 특정 페이지에 대한 여러 뷰를 생성할 수 있습니다.
sort_column: 정렬 기준이 된 열의 시스템 이름(예: code). 정렬 키가 여러 개인 경우 첫 번째 키만 전송합니다(sort_columns 참조).
sort_direction:(예: asc 또는 desc) 정렬 방향이 여러 개인 경우 첫 번째 방향만 전송합니다(sort_directions 참조).
sort_columns: 페이지 또는 뷰의 정렬 기준이 된 열의 시스템을 이름을 쉼표로 분리한 목록(예: code,created_at). 정렬 키가 여러 개인 경우에만 전송됩니다.
sort_directions: 페이지 또는 뷰의 정렬 기준이 된 열의 시스템을 이름을 쉼표로 분리한 목록(예: code,created_at). 정렬 키가 여러 개인 경우에만 전송됩니다.
grouping_column: 그룹 지정 기준이 된 열의 시스템 이름(예: code). 그룹 지정 열이 여러 개인 경우 첫 번째 열만 전송됩니다(grouping_columns 참조).
grouping_method: 그룹 지정이 이루어진 방식(예: 엔티티 필드의 경우 entitytype, 날짜 필드의 경우 month 방식으로 그룹 지정). 그룹 지정 메서드가 여러 개인 경우 첫 번째 메서드만 전송됩니다(grouping_columns 참조).
grouping_direction: 그룹 지정 방향(예: asc 또는 desc). 그룹 지정 방향이 여러 개인 경우 첫 번째 방향만 전송됩니다(grouping_directions 참조).
grouping_columns: 데이터의 그룹 지정 기준이 된 열의 시스템 이름을 쉼표로 분리한 목록(예: code,created_at). 그룹 지정 열이 여러 개인 경우에만 전송됩니다.
grouping_methods: 그룹 지정 방식을 쉼표로 분리한 목록(예: entity_type,month). 그룹 지정 열이 여러 개인 경우에만 전송됩니다.
grouping_directions: 그룹 지정 방향을 쉼표로 분리한 목록(예: asc,desc). 그룹 지정 열이 여러 개인 경우에만 전송됩니다.

프로젝트 데이터(현재 페이지의 모든 엔티티가 같은 프로젝트를 공유하는 경우에만 전송)

project_name: 프로젝트의 이름(예: Gunslinger)
project_id: 프로젝트의 ID(예: 81)

내부 리소스(Internal Resources) 메뉴

사용자 메뉴에서 내부 리소스에 대해 액션 메뉴 항목을 활용하는 방법에 대한 자세한 내용은 관리자 안내서를 참조하십시오.