배우는 것
- 파트너 공통 플러그인과 상품 전용 플러그인의 차이
- 프로모션 창의 설정과 띄우기 옵션과의 우선순위
- 사용자 데이터가 저장 결과로 돌아오는 경로
플러그인
플러그인은 Edicus 밖의 화면이나 코드를 편집기 안에서 여는 확장입니다. 파트너 전체에 공통으로 등록하는 플러그인과, 상품 하나에만 붙이는 플러그인이 있습니다.
plugin option을 누르면 열리는 창의 항목입니다.
global-plugin이 켜는 것
파트너 공통 플러그인은 파트너 공통 설정의 Plugins에서 등록합니다. 이 스위치를 켠 상품에서만 아래 위치에 나타납니다.
공통 플러그인 중
force-global을 켠 사진 소스와 캔버스 버튼, 안내(guide)와 상품 변경(reform) 플러그인은 이 스위치와 상관없이 나옵니다. 띄우기 옵션 force_plugin을 주면 이 스위치를 켠 것과 같습니다. 다만 기존 모바일 UI의 아이템 추가 패널은 force_plugin을 읽지 않습니다.
local-plugin의 동작
상품 전용 플러그인은 파트너 공통 플러그인과 따로 동작합니다.global-plugin을 꺼도 나옵니다.
- 데스크톱에서는 플러그인 탭 중 맨 앞에 놓이고, 편집기가 이 탭을 처음 탭으로 엽니다.
- 편집기는
plugin-url을 자바스크립트 모듈로 불러와, 주소의class쿼리 값(없으면default)과 이름이 같은 클래스를 만듭니다. 편집기가 모듈에 넘기는 인터페이스는 모양컷(스티컷) 연동용입니다. 스티컷 상품을 보세요. - 기존 모바일 UI와 신규 모바일 UI에는 탭으로 나오지 않습니다. 스티컷 상품에서 칼선을 만드는 모듈로만 씁니다. 아래 스티컷 상품의 플러그인 연결을 보세요.
plugin-url을 비워 두고 켜면 데스크톱 탭이 빈 채로 열립니다. 주소를 먼저 넣고 켜세요.
스티컷 상품의 플러그인 연결
키링, 등신대, 스마트톡 같은 스티컷 상품은 사용자가 그림을 올리고 칼선을 만드는 화면을 플러그인 모듈로 엽니다. 편집기에는 이 모듈을 대신하는 내장 화면이 없습니다. 플러그인 주소가 비어 있거나 연결된 플러그인이 없으면 편집기는 다른 주소를 쓰지 않고, 그림 올리기 화면이 열리지 않습니다. 멀티스티커(multi-sticker)에서 sticut-tab을 켠 데스크톱만 예외로 내장 탭을 씁니다.
1
스티컷 모듈 주소를 준비합니다
편집기 코드와 Manager에는 스티컷 모듈의 기본 주소가 들어 있지 않습니다.
plugin-url과 파트너 공통 플러그인의 url은 둘 다 빈 칸으로 시작합니다. 모션원에서 받은 스티컷 모듈 주소를 그대로 씁니다. 데스크톱은 주소에 sticut=true가 들어 있는 플러그인 탭을 스티컷 탭으로 알아보므로, 받은 주소의 쿼리를 지우지 마세요.2
둘 중 한 곳에 연결합니다
상품 하나에만 쓰려면 이 상품의
local-plugin을 켜고 plugin option의 plugin-url에 넣습니다. 여러 상품에 같이 쓰려면 파트너 공통 설정의 Plugins에 tab-embeded 유형, module 실행 방식으로 등록하고 이 상품의 global-plugin을 켭니다.3
UI별로 확인합니다
데스크톱은 스티컷 페이지에서 플러그인 탭이 열립니다. 기존 모바일 UI와 신규 모바일 UI는 탭 없이, 스티컷 상품을 열 때 첫 번째 탭 플러그인(
local-plugin이 있으면 그것)을 모듈로 불러옵니다.global-plugin 스위치를 보지 않고 파트너 공통 탭 플러그인도 그대로 씁니다. 공통 플러그인 목록의 첫 탭 플러그인이 스티컷 모듈이 아니면 모바일에서 엉뚱한 모듈을 불러오므로, 스티컷 상품에는 local-plugin으로 연결하는 편이 안전합니다.
플러그인 주소에 붙는 값
편집기는 플러그인 주소 뒤에div, lang, ui_locale, ps_code, project_id, mobile을 붙입니다. 띄우기 옵션 plugin_param을 주면 info로, 신규 모바일 UI면 m2=true도 붙입니다. 플러그인이 보내는 이벤트는 편집기 이벤트에 있습니다.
사이즈와 띄우기 옵션으로 바꾸기
- 사이즈의 product override에서 Global Plugin, Local Plugin을 사이즈마다 켜고 끕니다. 사이즈 고급 옵션을 보세요.
- 사이즈의
edicus options에plugin_info를 넣으면plugin option의 같은 이름 필드를 덮어씁니다.plugins를 넣으면 공통 플러그인 목록에 덧붙입니다. - 띄우기 옵션
options.plugins도 공통 플러그인 목록에 덧붙입니다. 띄우기 옵션을 보세요.
프로모션
프로모션은 편집기 위에 이벤트나 안내 페이지를 띄우는 창입니다.
promo setting을 누르면 열리는 창의 항목입니다. 처음 열면 아래 기본값으로 채웁니다.
Add En, Add Ja로 언어별
url과 mobile-url을 따로 넣을 수 있습니다(promoInfo.ln). 편집기 언어(ui_locale)가 맞는 항목이 있으면 그 주소를 씁니다. 언어별 항목을 쓰면 모바일에서도 그 항목의 url을 엽니다.
UI별 동작
파트너 설정
can-skip-promo를 켜면 모바일 시작 창에 하루 동안 보지 않기가 생깁니다. Customize 동작 설정을 보세요. env_mode에 restricted를 넣어 띄우면 데스크톱에서 프로모션을 표시하지 않습니다.
우선순위
편집기는 아래 순서로 처음 찾은 설정 하나만 씁니다.- 띄우기 옵션
options.promo. 필드 이름은promoInfo와 같습니다. option_string의promo.promo=url:<인코딩한 주소>;width:300;height:400형식이고, 상품의promoInfo를 대신합니다. 종류는default, 모바일 사용과 시작 시 열기는 켜짐,mobile-url은url과 같게 채웁니다.- 상품의
promoInfo.enable-promo가 켜져 있어야 합니다.option_string의promo_url은 이 주소만 바꾸고,promo_url=none이면 이 설정을 지웁니다. - 사이즈
edicus options의promo.
request-feature 커맨드의 promo-window로 창을 새로 띄울 수 있습니다. 편집기 커맨드를 보세요.
보관함 유지
신규 모바일 UI의 사진 탭에서 사진을 골라 사진 칸을 추가할 때, 추가한 사진 칸을 바로 선택할지 정합니다. 선택하면 사진 탭이 닫히고 사진 칸 도구로 넘어갑니다. 선택하지 않으면 사진 탭이 남아 사진을 이어서 넣을 수 있습니다. 데스크톱과 기존 모바일 UI에는 영향이 없습니다.사용자 데이터
저장 키는
template_option 아래가 아니라 상품 바로 아래의 userData입니다. 편집기는 이 값을 해석하지 않습니다. 저장이 끝나면 save-doc-report(status: 'end')의 docInfo.userData로 그대로 돌려줍니다. goto-cart가 report일 때 보내는 doc-report에도 들어 있습니다. 상품 코드마다 내 쪽 데이터베이스를 따로 조회하지 않아도 저장 결과에서 바로 상품별 값을 꺼낼 수 있습니다.
값은 UTF-8 기준 65,535바이트까지 저장합니다. 한글은 한 글자가 3바이트라 약 21,845자입니다. 이보다 크면 상품 저장이 거부됩니다.
됐는지 확인
Update로 저장한 뒤 Manager Resource에서 이 상품의 템플릿을 고르고 Demo로 여세요. 상품 전용 플러그인을 붙였다면 그 탭이 처음 열리고, 프로모션을 켰다면 창이나 버튼이 보이면 됩니다. 스티컷 플러그인처럼 사진을 올려야 하는 확인은 테스트 주문과 렌더링의 Test Order로 하세요.
사용자 데이터가
save-doc-report의 docInfo.userData로 오는지, external 프로모션 버튼이 promo-external-report를 보내는지는 내 서비스 코드에서만 볼 수 있습니다. 연동 담당자에게 확인을 부탁하세요.다음 단계
파트너 공통 설정
파트너 공통 플러그인과 안내 문구를 등록합니다.
편집기 이벤트
플러그인과 프로모션이 보내는 이벤트를 봅니다.