OneBox Module

one box module : 사용자들이 실시간 데이터를 간결하고 빠르고 쉽게 접근하기 위해 구성하는 search interface

1. 구성요소

• General Information
• 모듈의 정의 이름과 설명이 들어가 있다.
• Trigger
• 서치 어플라이언스로부터 요청데이터를 모듈에 야기시키는 특별한 keywords 또는 query type
• Provider
• 요청에 대한 응답을 하는 곳 internal, External 2가지 존재
• Security
• 모듈에 대한 보안을 설정하는 곳
• Results Template
•  Provider를 통해 가지고 온 데이터를 HTML형태로 바꿔주는 XSLT template

2. 정의하고 디플로이하는 방법 요약

• one box 모듈 정의
• provider 개발 둘중 하나 선택 개발
• Internal provider
• External provider
• 관리자 콘솔에서 oneBox 모듈 만들기
• XSLT template 변경
• 테스트
• Serving > OneBox Modules-> View Logs 를 통해 로그 확인 가능

3. 모듈 만들기

1.  XML 구성 파일을 사용한 OneBox Module 구성 설정
1. XML 만들기
2. <onebox> 요소를 통해 internal or external 결정
3. <name> <description> 을 통해 모듈의 이름과 설명 입력
2. Trigger 설ㅈㅇ
1. <trigger> 요소에 triggerType Attribute로 null,keyword,regex를 설정하고
   값을 입력
1. null : 모든 query에서 모듈 실행
2. keyword : 해당 키워드 입력시 발생 | <-- 중복 입력가능
3. regex  : 해당 정규식 입력시 발생
3. Provider 설정
1. internal --> collection 요소에 입력
2. external --> providerURL 요소에 입력
   
   *둘중 하나만 사용*

4. 결과 XML


<?xml version="1.0" encoding="UTF-8"?>
<OneBoxResults>
  <provider>ACME Employee Directory</provider>
  <title>
    <urlText>13 results in the ACME directory</urlText>
    <urlLink>http://directory.corp.acme.com/cgi-bin/search?smith</urlLink>
  </title>
  <IMAGE_SOURCE>http://directory.corp.acme.com/images/directory.jpg</IMAGE_SOURCE>
  <MODULE_RESULT>
    <U>http://directory.corp.acme.com/cqi-bin/lookup?empid=22638</U>
    <Field name="display">Smith, Bill R.</Field>
    <Field name="firstname">Bill</Field>
    <Field name="lastname">Smith</Field>
    <Field name="phone">617-555-9345</Field>
    <Field name="email">bsmith@acme.com</Field>
    <Field name="picture">http://directory.corp.acme.com/cqi-bin/lookup?photo=22638</Field>
  </MODULE_RESULT>
</OneBoxResults>