IQ Bot의 커스텀 도메인에 대해서는 이 기사 에서 설명하고 있습니다만, 이 페이지에서는 커스텀 도메인을 Post 하기 위한 Json 파일의 구조를 정리합니다.

맞춤 도메인의 Json 파일 견본

맞춤 도메인 견본

{
    "name": "カスタムドメインの見本",
    "languages": [
        "Japanese"
    ],
    "fields": [
        {
            "name": "F01_請求金額",
            "type": "FORM_FIELD",
            "format": "Number",
            "default": true,
            "aliases": [
                {
                    "names": [
                        "ご請求金額","合計金額","合計","御請求金額"
                    ],
                    "language": "Japanese"
                }
            ]
        },
        {
            "name": "F02_消費税額",
            "type": "FORM_FIELD",
            "format": "Number",
            "default": true,
            "aliases": [
                {
                    "names": [
                        "消費税","税額"
                    ],
                    "language": "Japanese"
                }
            ]
        },
        {
            "name": "T01_品名",
            "type": "TABLE_COLUMN_FIELD",
            "format": "Text",
            "default": true,
            "aliases": [
                {
                    "names": [
                        "品名","摘要"
                    ],
                    "language": "Japanese"
                }
            ]
        },
        {
            "name": "T02_数量",
            "type": "TABLE_COLUMN_FIELD",
            "format": "Number",
            "default": false,
            "aliases": [
                {
                    "names": [
                        "数","入数"
                    ],
                    "language": "Japanese"
                }
            ]
        }
    ]
}

사용자 지정 도메인의 Json 파일 구조

위의 Json 파일의 구조를 위에서 조금씩 구분하여 설명합니다.

헤더 부분의 이름과 언어

헤더 부분

{
    "name": "カスタムドメインの見本",
    "languages": [
        "Japanese"
    ],

항목 이름
설명


이름
문서 유형 선택에 표시할 이름입니다. 동일한 IQ Bot 서버(클러스터) 내에서 중복 이름을 정의할 수 없습니다.

languages
문서의 주요 언어 선택


여기서 설정한 name 와 languages 는, UI상에 다음과 같이 반영됩니다.

fields 부분

fields 부분은 아래의 빨간색 테두리가 한 덩어리가 되어 하나의 항목을 정의합니다.

fields 부분의 name~default의 내용

항목 이름
설명


이름
여기서 정의한 명칭은, 이하의 명칭이 됩니다. ①CSV에 표시되는 열명 ②매핑 화면에 표시되는 필드명 영어, 숫자, 일본어, 공백을 조합할 수 있지만 기호는 입력할 수 없습니다. 첫 문자나 마지막 문자는 공백이 될 수 없습니다. 첫 문자는 숫자일 수 없습니다. 사용자 정의 도메인을 POST한 후 항목의 순서는 여기에 정의된 이름의 문자 코드 순서입니다. Tips로서 순서성을 담보하고 싶은 경우는 항목의 선두에 F0, F02...(필드의 경우), T01, T02... 입니다.

유형
해당 항목이 ① 폼 필드인지 ② 테이블 필드인지를 정의합니다. ①의 경우: FORM_FIELD ②의 경우: TABLE_COLUMN_FIELD

Format
맵핑 화면에서 정의할 수 있는 데이터 유형 선택사항을 지정합니다. 다음 목록의 선택과 동일한 문자열을 첫 문자를 대문자로 지정합니다. 여기서 지정하는 Format는 어디까지나 데이터 타입의 초기치이므로, 그룹 마다 나중에 UI로 변경하는 것이 가능합니다.

default
사용자 지정 도메인을 선택할 때 해당 항목을 기본적으로 선택하는지 여부를 true 또는 false로 지정합니다.

fields 부분의 aliases 열

이 부분은 가장 중요하기 때문에 잘라 설명합니다.

aliases 부분

            "aliases": [
                {
                    "names": [
                        "ご請求金額","合計金額","合計","御請求金額"
                    ],
                    "language": "Japanese"
                }

상기의 예이면, "ご請求金額" , "合計金額" , "合計" , "御請求金額" 의 어느 쪽의 캐릭터 라인에 전방 일치하는 캐릭터 라인을, 장표상으로부터 해당 항목의 라벨로서 취득한다고 하는 의미입니다.

이 요령으로 names 를 폭넓게 정의해 가는 것으로, 장표상으로부터 라벨로서 취득할 수 있는 캐릭터 라인의 선택사항을 늘려, 분류를 의도대로 실시하기 쉽게 합니다.
names 의 네이밍 룰은 fields 의 name 와 같습니다.

주의사항

fields 의 name 와 aliases 의 names 는 하나의 도메인에서 중복 값을 유지할 수 없습니다.

기재된 대로입니다. 중복이 있는 상태에서 POST하면 오류가 발생하므로 중복을 제거하십시오.

POST 후 항목의 순서는 문자 코드 순서입니다.

UI에서 항목 이름을 입력한 경우 항목은 입력한 순서대로 정렬되지만 사용자 지정 도메인을 POST하면 항목은 필드/테이블에서 JSON 파일에 정의된 name 문자 코드 순서로 정렬됩니다.

순서성을 보증하고 싶은 경우는, 항목명의 선두에 F01,F02...(필드의 경우), T01,T02...(테이블의 경우)등의 통번을 부번하는 것으로 대응할 수 있습니다.