메인 콘텐츠로 건너뛰기

​
등록 매개변수 사용

트랜잭션 및 파일 등록 매개변수는 키-값 string(문자열) 쌍으로 구성된 매개변수로, 추가 사용자 정보(예: 클라이언트 이름, 문서 유형, 파일 소스 정보)를 제공하도록 설계되었습니다. 이 매개변수들은 트랜잭션 또는 트랜잭션 문서들과 함께 처리에 전달됩니다. 이러한 매개변수는 모든 워커(Worker)에서 사용할 수 있으며, 다양한 프로덕션 시나리오에서 활용할 수 있습니다:
  • ABBYY Vantage를 사용하는 프로그램이 보고서 작성 및 사용자 정의 처리 절차 생성 목적(예: 클라이언트별로 거래 상대 데이터 카탈로그 필터링)을 위해 각 트랜잭션에 최종 클라이언트 속성을 태깅합니다.
  • Scanning Station 클라이언트(또는 다른 트랜잭션 생성 원천)는 문서 배치의 등록 매개변수(예: 외부 상관 ID)를 전달할 수 있습니다.
등록 매개변수는 Vantage API를 사용하여 설정할 수 있습니다:
  1. 빈 트랜잭션을 생성할 때 또는 launch 메서드를 사용하여 트랜잭션을 초기화할 때. 이를 위해 아래 예와 같이 transactions 리소스에 POST 요청을 전송합니다:
또는 요청 본문에서 등록 매개변수를 지정하고, 다음 명령을 실행합니다:
  1. 파일을 트랜잭션 또는 문서에 업로드할 때. 이를 위해 아래 예와 같이 transactions/<transaction-id>/files 리소스에 POST 요청을 전송합니다:
요청 본문에서 등록 매개변수를 지정하고, 다음 명령을 실행합니다:
중요! 키-값 형식의 매개변수는 최대 10개까지 사용할 수 있으며, 키 매개변수는 최대 128자, 값 매개변수는 최대 256자까지 입력할 수 있습니다. 한 번 설정된 후에는 이러한 매개변수의 값을 변경할 수 없습니다.
등록 매개변수 값은 다음 위치에서 읽을 수 있습니다:
  • Custom activity 스크립트,
  • Output activity의 External Export 스크립트,
  • 비즈니스 규칙.
등록 매개변수 값은 다음과 같이 Vantage API를 사용하여 가져올 수 있습니다:
  1. transactions/<transaction-id>/registrationParameters 리소스에 대해 registrationParameters 메서드를 호출합니다:
응답은 다음과 같은 형식입니다: 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. 업로드하는 파일과 함께 JSON 형식으로 값을 가져오기 위해 transactions/<transaction-id>/files/<file-id>/download 리소스에 대한 download 메서드 호출을 사용하는 방법:

​
스킬 파라미터 사용

등록 파라미터 외에도 트랜잭션을 생성하거나 실행할 때 스킬 파라미터(skill parameter)를 전달할 수 있습니다. 스킬 파라미터는 스킬이 트랜잭션을 처리하는 방식을 구성하는 키-값 string(문자열) 쌍입니다. 스킬 파라미터는 트랜잭션을 생성할 때나 launch 메서드를 사용할 때 설정할 수 있습니다:
Important! 트랜잭션당 스킬 파라미터는 최대 10개까지 사용할 수 있습니다.
Vantage API에서 skillParameters 메서드를 호출하여 스킬 파라미터 값을 가져올 수 있습니다: 응답은 다음과 같습니다: 
[
  {
    "key": "parameterName",
    "value": "parameterValue",
    "type": "string"
  }
]