7. 사용자 정의 기능

7.1. 사용자 정의 기능이란?

아이펀 디플로이가 미지원 컨텐츠에 대한 운영기능을 사용자가 직접 구현 할 수 있게 해주는 커스텀 기능입니다.

Note

아이펀 디플로이의 운영툴은 우편이나 이벤트와 같이 다양한 장르의 게임에 공통적으로 적용할 수 있는 핵심 기능들만을 포함합니다. 그 대신에 길드나 소환수 등의 미지원 컨텐츠에 대한 기능은 이 사용자 정의 기능 으로 구현하실 수 있습니다.

7.2. 사용자 정의 기능 가져오기

사용자 정의 기능 추가하기 에 명시된 것처럼, 아이펀 디플로이는 게임 서버에 추가적인 사용자 정의 기능이 존재하는지를 물어보게 됩니다. 그리고 게임 서버가 반환하는 사용자 정의 기능에 대해서 API를 호출하는데 필요한 인자와, API 가 반환하는 결과값들에 대한 정보를 알아냅니다.

아이펀 디플로이는 이 정보들을 이용하여, 사용자 정의 기능 사용을 위한 web form 을 자동으로 생성해줍니다. 그리고 운영자는 이 form을 통해서 사용자 정의 기능 API를 손쉽게 호출할 수 있습니다.

사용자 정의 기능은 그 구현 범위에 제한을 두고 있지 않기 때문에, 게임 내 공지나 게임 서버 셧다운 같은 관리 기능에서부터 게임 유저 관리 기능 , 그리고 커버하지 못하는 고객 지원 기능들에 이르기까지 다양한 내용이 사용자 정의 기능으로 추가될 수 있습니다.

아래 그림은 상단 최상위 레벨에서 사용자 정의 기능 을 클릭한 화면입니다.

_images/custom-query-main.png

위 화면의 좌측 사이드 바에 표시되는 set_game_item, get_game_item_to_gold_range 등은 모두 GET /cs-api/v1/custom_query 를 통해서 얻어온, 게임 서버가 제공하는 사용자 정의 기능들입니다. 각 사이드 바 메뉴를 클릭하면 해당 사용자 정의 기능을 사용하기 위한 web form 을 보실 수 있습니다.

7.3. 사용자 정의 기능 설정하기

_images/custom-query-before.png

사용자 정의 기능 추가하기 문서와 같이 기능 구현 및 API 연동을 마쳤다면, 위와 같이 사용자 정의 기능 페이지에서 바로 사용할 수 있습니다.

하지만 게임 서버에서 보내주는 영문 API 키 등을 그대로 사용하기 때문에 이대로라면 어떤 변수에 무슨 값을 넣어야 하는지 알기 어려울 수 있습니다.

그래서 아이펀 디플로이는 사용자 정의 기능에 두 가지 설정을 제공합니다.

  1. 언어별 출력 형식 설정

언어별로 파라미터 이름, 설명 등을 지정하여 폼을 더욱 보기 쉽게 만듭니다.

사용자 정의 기능 실행 화면의 맨 오른쪽에 있는 설정 버튼으로 진입할 수 있습니다.

_images/custom-query-setting.png
  • 이름 : 영문 API 키 대신 여기서 지정한 이름이 표시됩니다.
  • 설명 : 입력 창에 마우스를 오버하면 여기서 지정한 설명이 표시됩니다.
  • 정렬여부 : 체크하면 결과 테이블 출력 시 해당 컬럼에 정렬 버튼을 추가합니다.

Note

일시정렬여부 항목은 언어 설정과 관계없이 적용됩니다.

표시 형식 에서 설정할 수 있는 옵션들은 사용자 정의 기능을 화면에 표시 할때 다음과 같은 UI 형태로 표시 합니다.

  • 단일 라인 텍스트 : 한 줄만 입력 가능한 텍스트박스 형태로 표시됩니다.
  • 일시 : 달력 및 시간을 입력할 수 있는 형태로 표시됩니다.
  • 다중 라인 텍스트 : 여러 줄을 입력할 수 있는 텍스트박스 형태로 표시됩니다.
  • 체크박스 : 체크박스 형태로 표시됩니다.
  • 셀렉트박스 : 셀렉트 박스 형태로 표시됩니다.

Note

표시 형식으로 셀렉트박스를 설정하려면 API 서버에서 선택 가능한 값을 보내 주어야만 합니다. 해당 옵션을 선택할 수 없을 경우 게임 개발자에게 문의하시기 바랍니다.

Important

액션 으로 등록 후 액션 설정에서 파라미터값 사전 지정 시 자동입력값이 표시형식으로 나타낼 수 있는 경우에만 자동으로 파라미터값이 입력됩니다.

  1. 폼 레이아웃 설정

사용자 정의 기능 실행 화면의 레이아웃을 수정할 수 있습니다.

설정 버튼 밑에 있는 연필 버튼 으로 진입할 수 있습니다.

_images/custom-query-layout.png

위에서 언급한 두 가지 설정을 마치고 나면 아래와 같이 한결 알기 쉬운 폼이 됩니다.

_images/custom-query-after.png

다중 라인 텍스트의 경우 입력 폼을 아래로도 확장할 수 있습니다.

_images/custom-query-layout-second.png

7.4. 사용자 정의 기능 실행하기

_images/custom-query-main.png

사용자 정의 기능은 아래와 같이 실행할 수 있습니다.

  1. 페이지 좌측의 메뉴에서 사용할 기능을 선택 한다
  2. 나타난 폼에 필요한 값을 입력 한다 ( * 표시는 필수 입력 항목 을 의미)
  3. 폼 전송 버튼 을 누른다

Tip

폼 전송 버튼 의 텍스트는 해당 기능을 실행할 때 게임 서버로 전송되는 HTTP 요청의 method 를 의미합니다 (GET, POST 등)

7.5. 사용자 정의 기능 연결하기

연관된 사용자 정의 기능을 연결해서 편리하게 사용하실 수 있습니다. 예를 들어 길드 목록을 가져오는 사용자 정의 기능을 실행했다고 가정합시다. 실행 결과인 길드 리스트에서 각 길드에 대한 길드원 목록, 길드 상세 정보, 길드원 추가 같은 관련된 사용자 정의 기능을 실행할 수 있도록 등록할 수 있습니다.

7.5.1. 사용자 정의 기능 연결 추가

사용자 정의 기능을 연결하기 위해서는, 연결하고자 하는 사용자 정의 기능을 실행해야 합니다. 예를 들어 길드 목록을 가져오는 기능에 길드원 목록을 가져오는 기능을 연결한다고 합시다. 해당 연결을 위해서는 우선 길드 목록을 가져오는 기능을 실행해야 합니다. 아래는 사용자 정의 기능을 실행한 화면입니다.

_images/custom-query-link-add-01.png

결과 테이블 헤더의 설정 톱니 바퀴 버튼 -> 사용자 정의 기능 설정 클릭합니다.

_images/custom-query-link-add-02.png

사용할 수 있는 사용자 정의 기능 목록체크 박스 와 함께 나타납니다. 연결하고자 하는 사용자 정의 기능 을 선택하고 저장 버튼 을 클릭합니다.

_images/custom-query-link-add-03.png

사용자 정의 기능 결과 테이블 각 행의 액션 버튼 을 클릭해 보면, 위에서 추가한 사용자 정의 기능이 연결되어 있는 것을 확인하실 수 있습니다.

_images/custom-query-link-add-04.png

7.5.3. 연결된 사용자 정의 기능 실행

사용자 정의 기능 연결 설정을 적절히 하였다면, 사용자 정의 기능 실행 결과 테이블에서 연결된 사용자 기능을 실행할 수 있습니다. 다시 한 번 길드 목록 기능과 길드원 목록 기능이 연결되어 있다고 합시다. 길드 목록을 조회한 결과에서 해당 길드의 길드원 목록 조회를 해당 테이블에서 바로 실행할 수 있습니다.

사용자 정의 기능 실행 결과 테이블의 각 열에서 액션 버튼 -> 연결된 사용자 정의 기능 을 클릭합니다.

_images/custom-query-link-run-01.png

사용자 정의 기능을 실행할 수 있는 팝업이 뜹니다. 만약 특정 파라미터가 직접 입력으로 설정되어 있으면, 해당 파라미터는 손으로 입력할 수 있는 란이 표시됩니다. 파리미터 설정에서 바인딩 된 파라미터의 경우는 별 다른 표시가 되지 않습니다. 실행 버튼 을 클릭하면 실행 결과를 확인할 수 있습니다.

_images/custom-query-link-run-02.png

7.6. 사용자 정의 기능 메뉴

사용자 정의 기능 페이지에서 왼쪽에 보이는 사용자 정의 기능 메뉴에 사용자 정의 기능의 전체 목록이 표시됩니다.

_images/custom-query-menu.png

7.6.1. 사용자 정의 기능 자주 찾는 메뉴

자신이 자주 사용하는 사용자 정의 기능을 자주 찾는 메뉴의 목록에 추가할 수 있습니다.

_images/custom-query-favarite.png

자주 찾는 메뉴에 추가

메뉴의 사용자 정의 기능 오른쪽 에 위치한 비어있는 별 아이콘을 누르면 해당 기능은 자주 찾는 메뉴의 목록에 추가됩니다.

자주 찾는 메뉴에서 삭제

자주 찾는 메뉴에서 특정 기능을 삭제하려면 추가된 기능 또는 해당 기능의 오른쪽 에 위치한 속이 차 있는 별 아이콘을 누르면 됩니다.

Note

자주 찾는 메뉴의 목록은 로그인한 사용자별로 다르게 표시됩니다.

7.6.2. 사용자 정의 기능 검색

사용자 정의 기능 이름으로 사용자 정의 기능을 검색할 수 있습니다. 입력 상자에 검색 키워드를 입력하시면, 키워드의 문자를 포함한 이름의 사용자 정의 기능들만 표시됩니다.

_images/custom-query-search.png

7.6.3. 사용자 정의 기능 카테고리

사용자 정의 기능을 카테고리별로 나눌 수 있는 기능입니다. 원하는 카테고리를 만들고 그 카테고리 안에 사용자 정의 기능을 포함 시키거나 제외할 수 있습니다. 새로 생성된 카테고리는 메뉴에 폴더 아이콘과 함께 표시되며 카테고리에 포함된 사용자 정의 기능 목록이 그 아래에 표시됩니다.

_images/custom-query-category-edit.png

카테고리 생성 및 관리

언어

아래의 카테고리 명칭 이 어떤 사용자 언어 설정에서 사용될 것인지를 지정합니다.

카테고리 명칭

선택한 언어로 보일 카테고리의 명칭입니다. 왼쪽 메뉴에서 folder_icon 와 함께 확인할 수 있습니다.

카테고리 내 메뉴 설정

사용자 정의 기능을 카테고리에 넣을 수 있습니다. 전체 메뉴 리스트에서 선택 후 이동 버튼을 누르면 선택 메뉴 리스트로 이동됩니다. 카테고리에서 제외하려면 선택 메뉴 리스트의 각 목록에 있는 x 를 누르면 선택 메뉴 리스트에서 제외됩니다.

카테고리의 수정과 삭제

왼쪽 메뉴의 카테고리 명칭 오른쪽 에 있는 톱니바퀴 모양의 아이콘을 클릭하여 수정 화면으로 이동 후에 수정 또는 삭제할 수 있습니다.

Note

하나의 사용자 정의 기능은 하나의 카테고리에만 속할 수 있습니다.

Note

카테고리 내 메뉴 설정에서 사용자 정의 기능 선택할 때 여러 개를 동시에 선택하는 기능은 제공하고 있지 않습니다. 한 번에 하나씩 선택하여 선택 메뉴 리스트로 이동시킬 수 있습니다.

Note

생성 또는 수정된 사용자 정의 기능 카테고리와 목록은 디플로이먼트에 멤버인 로그인한 사용자에게 똑같이 보이게 됩니다.

Important

사용자 정의 기능, 카테고리, 즐겨 찾기 각각의 목록은 오름차순으로 정렬되어 표시됩니다.