[OZ Software]¶
OZ 소프트웨어 기능을 수행하기 위한 필수 API 를 정의
OZ Software API 1¶
FORCS OZ 제품에 대한 연동 기능을 제공한다.
status Type¶
Type |
Description |
---|---|
PROCESSING |
진행 중 |
SUCCESS |
정상 처리됨 |
FAIL |
처리 중 문제가 발생함 |
뷰어 생성¶
-
M.
plugin
("ozviewer").createViewer( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.param (String) – 생성 정보
setting.option (Object) – 옵션 정보
setting.option.margin (Object) – 화면 margin
setting.option.delimiter (String) – param 의 구분자값
setting.option.close (String) – 종료버튼 선언 (Only IOS)
setting.listener (Object) – 리스너 정보(Listener function)
setting.callback (Function) – 검증 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 생성 결과
뷰어 생성 및 보고서 바인딩.
Note
listener command 관련 OZ VIEWER API 명세서는 아래 링크를 통해 확인 할 수 있습니다.
Example:
var params = "connection.openfile=http://oz.sample.com/www/oz/param1.ozd"; M.plugin("ozviewer").createViewer({ 'param': params, callback:function(status, result){ alert(JSON.stringify(result)); } });;var margin_t = 100; if ( M.navigator.device("ios") == true ) { margin_t = 150; } var deli = "\n"; var params = "connection.openfile=res://mop3.ozd"; params += deli + "connection.pcount=1"; params += deli + "connection.args1=FormTitle=Create Test"; var option = {}; var margin = {}; margin.left = 0; margin.top = margin_t; margin.right = 0; margin.bottom = 0; option.margin = margin; option.delimiter = deli; M.plugin("ozviewer").createViewer({ param: params, option: option, callback:function(status, result){ M.pop.instance(JSON.stringify(result)); }, listener : { OZPostCommand : function(result){ console.log("OZPostCommand"); }, OZCommand : function(result){ console.log("OZCommand"); }, OZUserEvent : function(result){ console.log("OZUserEvent"); }, OZUserActionCommand : function(result){ console.log("OZUserActionCommand"); alert("OZUserActionCommand"); }, } });
ReBind¶
-
M.
plugin
('ozviewer').rebind( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.index (int) – index
setting.type (String) – type
setting.param (String) – rebind param 정의
setting.option (Object) – option 정보
setting.option.delimiter (String) – delimiter
setting.option.keep (String) – keep 여부 (“TRUE”, “FALSE”)
setting.callback (Function) – rebind 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리결과
index 에 대한 문서를 rebind.
Example:
var params = "connection.openfile=res://param2.ozd"; params += "\n" + "comment.all=true"; params += "\n" + "eform.imagepicker_camera_show_choose_button=true"; params += "\n" + "eform.inputeventcommand=true"; params += "\n" + "eform.signpad_type=zoom"; params += "\n" + "eform.show_prev_next_input=true"; params += "\n" + "eform.radiobutton_type=dialog"; params += "\n" + "eform.checkbox_type=dialog_at_prev_next"; params += "\n" + "viewer.useractioncommand=true"; M.plugin("ozviewer").rebind({ 'index': index, 'type': type, 'param': params, callback:function(status, result){ alert(JSON.stringify(result)); } });
var params = "connection.openfile=res://param2.ozd"; params += "^" + "comment.all=true"; params += "^" + "eform.imagepicker_camera_show_choose_button=true"; params += "^" + "eform.inputeventcommand=true"; params += "^" + "eform.signpad_type=zoom"; params += "^" + "eform.show_prev_next_input=true"; params += "^" + "eform.radiobutton_type=dialog"; params += "^" + "eform.checkbox_type=dialog_at_prev_next"; params += "^" + "viewer.useractioncommand=true"; var option = {}; option.delimiter = "^"; option.keep = "TRUE"; M.plugin("ozviewer").rebind({ 'index': index, 'type': type, 'param': params, 'option':option, callback:function(status, result){ alert(JSON.stringify(result)); } });
NewReport¶
-
M.
plugin
('ozviewer').newReport( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.param (String) – report용 param 정보
setting.delimiter (String) – delimiter
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리 결과
report 처리.
Example:
var params = "connection.openfile=res://param2.ozd"; params += "$$" + "comment.all=true"; params += "$$" + "eform.imagepicker_camera_show_choose_button=true"; params += "$$" + "eform.inputeventcommand=true"; params += "$$" + "eform.signpad_type=zoom"; params += "$$" + "eform.show_prev_next_input=true"; params += "$$" + "eform.radiobutton_type=dialog"; params += "$$" + "eform.checkbox_type=dialog_at_prev_next"; params += "$$" + "viewer.useractioncommand=true"; M.plugin("ozviewer").newReport({ 'param': params, 'delimiter' : "$$", callback:function(status, result){ alert(JSON.stringify(result)); } });
GetInformation¶
-
M.
plugin
('ozviewer').getInfo( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.item (String) – item info
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리 결과
문서 정보 획득.
Example:
M.plugin("ozviewer").getInfo({ 'item': "INPUT_JSON", callback:function(status, result){ alert(JSON.stringify(result)); } });
Script¶
-
M.
plugin
('ozviewer').script( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.cmd (String) – script command 정보
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리결과
Script 명령어 처리.
Example:
M.plugin("ozviewer").script({ 'cmd': "command", callback:function(status, result){ alert(JSON.stringify(result)); } });
ScriptEx¶
-
M.
plugin
('ozviewer').scriptEx( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.cmd (String) – script command 정보
setting.param (String) – param 정보
setting.delimiter (String) – delimiter 정보
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리결과
확장 Script 명령어 처리.
Example:
var params = "connection.openfile=res://param2.ozd"; params += "$$" + "comment.all=true"; params += "$$" + "eform.imagepicker_camera_show_choose_button=true"; params += "$$" + "eform.inputeventcommand=true"; params += "$$" + "eform.signpad_type=zoom"; params += "$$" + "eform.show_prev_next_input=true"; params += "$$" + "eform.radiobutton_type=dialog"; params += "$$" + "eform.checkbox_type=dialog_at_prev_next"; params += "$$" + "viewer.useractioncommand=true"; M.plugin("ozviewer").scriptEx({ 'cmd' : "command", 'param': params, 'delimiter' : "$$", callback:function(status, result){ alert(JSON.stringify(result)); } });
setHelpURL¶
-
M.
plugin
('ozviewer').setHelpURL( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.url (String) – help url 정보
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리결과
help url 정보 셋팅.
Example:
M.plugin("ozviewer").scriptEx({ 'url' : "http://doc.sample.com/help.html", callback:function(status, result){ alert(JSON.stringify(result)); } });
GetMemoryStreamByExport¶
-
M.
plugin
('ozviewer').getMemory( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.param (String) – param 정보
setting.delimiter (String) – delimiter 정보
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리결과
메모리 정보를 Export 처리.
Example:
var params = "connection.openfile=res://param2.ozd"; params += "$$" + "comment.all=true"; params += "$$" + "eform.imagepicker_camera_show_choose_button=true"; params += "$$" + "eform.inputeventcommand=true"; params += "$$" + "eform.signpad_type=zoom"; params += "$$" + "eform.show_prev_next_input=true"; params += "$$" + "eform.radiobutton_type=dialog"; params += "$$" + "eform.checkbox_type=dialog_at_prev_next"; params += "$$" + "viewer.useractioncommand=true"; M.plugin("ozviewer").getMemory({ 'param': params, 'delimiter' : "$$", callback:function(status, result){ alert(JSON.stringify(result)); } });
Document_PingOZServer¶
-
M.
plugin
('ozviewer').ping( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.url (String) – ping 체크를 위한 url 정보
setting.option (Object) – option 정보 객체
setting.option.port (int) – port
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리결과
OZ Server 와 ping 점검.
Example:
M.plugin("ozviewer").ping({ 'url': "192.168.0.12", callback:function(status, result){ alert(JSON.stringify(result)); } });
var option = {}; option.port = 8082; M.plugin("ozviewer").ping({ 'url': "192.168.0.12", 'option': option, callback:function(status, result){ alert(JSON.stringify(result)); } });
Document_GetGlobal¶
-
M.
plugin
('ozviewer').getGlobal( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.key (String) – 가져올 global 변수의 key 값
setting.option (Object) – option 정보 객체
setting.option.docIndex (int) – 페이지 값
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리결과
Global 변수의 정보를 획득.
Example:
M.plugin("ozviewer").getGlobal({ 'key': "id_03", callback:function(status, result){ alert(JSON.stringify(result)); } });
var option = {}; option.docIndex = 2; M.plugin("ozviewer").getGlobal({ 'key': "id_03", 'option': option, callback:function(status, result){ alert(JSON.stringify(result)); } });
Document_SetGlobal¶
-
M.
plugin
('ozviewer').setGlobal( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.key (String) – 설정 할 global 변수의 key 값
setting.value (String) – 설정 할 global 변수의 value 값
setting.option (Object) – option 정보 객체
setting.option.docIndex (int) – 페이지 값
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리결과
Global 변수의 정보를 설정.
Example:
M.plugin("ozviewer").setGlobal({ 'key': "id_03", 'value': "이미지 입력", callback:function(status, result){ alert(JSON.stringify(result)); } });
var option = {}; option.docIndex = 2; M.plugin("ozviewer").setGlobal({ 'key': "id_03", 'value': "이미지 입력", 'option': option, callback:function(status, result){ alert(JSON.stringify(result)); } });
Document_SetChartStyle¶
-
M.
plugin
('ozviewer').setChartStyle( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.style (String) – chart 의 style
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리결과
chart style 설정.
Example:
M.plugin("ozviewer").setChartStyle({ 'style': "bar", callback:function(status, result){ alert(JSON.stringify(result)); } });
Document_GetTitle¶
-
M.
plugin
('ozviewer').getTitle( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리결과
문서의 타이틀 획득.
Example:
M.plugin("ozviewer").getTitle({ callback:function(status, result){ alert(JSON.stringify(result)); } });
Document_GetPaperWidth¶
-
M.
plugin
('ozviewer').getPaperWidth( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리 결과
문서의 가로 사이즈 정보.
Example:
M.plugin("ozviewer").getPaperWidth({ callback:function(status, result){ alert(JSON.stringify(result)); } });
Document_GetPaperHeight¶
-
M.
plugin
('ozviewer').getPaperHeight( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리 결과
문서의 세로 사이즈 정보.
Example:
M.plugin("ozviewer").getPaperHeight({ callback:function(status, result){ alert(JSON.stringify(result)); } });
Show¶
-
M.
plugin
('ozviewer').show( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리 결과
문서 보이기.
Example:
M.plugin("ozviewer").show({ callback:function(status, result){ alert(JSON.stringify(result)); } });
Hide¶
-
M.
plugin
('ozviewer').hide( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리 결과
문서 감추기.
Example:
M.plugin("ozviewer").show({ callback:function(status, result){ alert(JSON.stringify(result)); } });
close¶
-
M.
plugin
('ozviewer').close( setting)¶ Changed in version 2.0.0.
- Arguments
setting (Object) – 설정 정보
setting.callback (Function) – 결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리 결과
문서 종료(제거)하기.
Example:
M.plugin("ozviewer").close({ callback:function(status, result){ alert(JSON.stringify(result)); } });
디바이스 권한 획득¶
-
M.
plugin
('ozviewer').permission( setting)¶ Changed in version 2.0.0: / Android ONLY
- param Object setting
설정 정보
- param Object setting.permission
획득할 권한을 StringArry로 선언
- param Function setting.callback
결과 콜백 함수
-
M.
callback
(status, result)¶ - Arguments
status (String) – 상태 ( status Type )
result (Object) – 처리 결과
문서에 필요한 권한을 획득한다.
Example:
M.plugin("ozviewer").permission({ permissions : ["android.permission.WRITE_EXTERNAL_STORAGE","android.permission.CAMERA", "android.permission.RECORD_AUDIO"], callback : function(status, result){ alert(JSON.stringify(result)); } });
Warning
Android 전용이며, AndroidManifest.xml 에 획득하고자 하는 권한이 선언되어 있어야 함 permission 에 사용되는 값들은 아래 url 을 참고(카메라 권한 획득)하여, Constant Value 값을 적용 (예시 : 카메라) https://developer.android.com/reference/android/Manifest.permission.html#CAMERA