XPLATFORM HTML5를 사용하려면, XPLATFORM HTML5 서버를 설치해야 합니다. 이 설치는 일반적인 웹 애플리케이션 설치 방법과 동일합니다. 설치 방법은 war 파일을 이용하여 새로운 Context에 설치하는 방법과 jar 파일을 이용하여 기존 Context에 설치하는 방법으로 크게 2가지로 나뉘어 질 수 있습니다.

시스템 요구사항

XPLATFORM HTML5 서버를 수행하기 위해서는 다음과 같은 시스템이 필요합니다.

War 파일을 이용한 신규 Context 설치

XPLATFORM HTML5의 war 파일을 이용하여 설치하는 방법을 설명합니다. 다음의 설명은Apache Tomcat을 기준으로 한 설명입니다. 다른 Web Application Server는 해당 WAS의 매뉴얼을 참조하시기 바랍니다.

1단계 : XPLATFORM HTML5의 war 파일 복사

XPLATFORM HTML5의 war 파일을 적당한 디렉토리에 복사합니다. War 파일은 XPLATFORM HTML5 배포판에 포함된 xplatform9-ajax.war 입니다.

2단계 : Tomcat의 Context 설정 파일 작성

<Tomcat Home>/conf/Catalina/localhost/xplatform9-ajax.xml 파일을 다음과 같은 내용으로 작성합니다.

예를 들어 1단계의 War 파일을 “C:\XAE\xplatform9-ajax.war”로 복사하였다면,

<?xml version="1.0" encoding="UTF-8"?>
	<Context path="/xplatform9-ajax" docBase="C:/XAE/xplatform9-ajax.war">
</Context>

3단계: Tomcat 재시작

Tomcat을 재시작 합니다.

위와 같은 방법보다 간편한 방법을 원한다면 war 파일을 <Tomcat Home>/webapps 디렉토리에 복사하면 동일한 결과를 볼 수 있습니다.

Jar 파일을 이용한 기존 Context 설치

XPLATFORM HTML5의 jar 파일들을 이용하여 설치하는 방법을 설명합니다. 기존의 Context를 유지한 채로 XPLATFORM HTML5 서버를 설치하기 위해서는 jar 파일들을 복사하여 설치할 수 있습니다.

예를들어, 편의상 이미 설치된 웹 어플리케이션의 이름을 “myajax” 로 하고 설치 경로를 “<Tomcat Home>/webapps/myajax” 으로 하겠습니다.

1단계 : XPLATFORM HTML5의 jar 파일들 복사

XPLATFORM HTML5의 jar 파일들을 기존 Context의 라이브러리 디렉토리에 복사합니다. 예제의 프로젝트에서는 <Tomcat Home>/webapps/myajax/WEB-INF/lib 디렉토리에 XPLATFORM HTML5 jar 파일들을 복사합니다. Jar 파일 목록은 하단의 “3.6 설치용 파일들”을 참조하시기 바랍니다.

2단계 : 외부 의존 라이브러리 복사

XPLATFORM HTML5의 외부 의존 라이브러리들을 기존 Context의 라이브러리 디렉토리에 복사합니다. 예제의 프로젝트에서는 <Tomcat Home>/webapps/myajax/WEB-INF/lib 디렉토리에 XPLATFORM HTML5의 외부 의존 라이브러리들을 복사합니다. 외부 라이브러리 목록은 하단의 설치용 파일들을 참조하시기 바랍니다.

3단계 : web.xml 변경

Web.xml의 내용에 다음과 같은 Servlet 설정을 추가합니다.

예제의 프로젝트에서는 <Tomcat Home>/webapps/myajax/WEB-INF/web.xml 경로에 위치해 있습니다.

<servlet>
<init-param>
<!-- StreamLog 출력 여부 -->
<param-name>streamLog</param-name> 
<param-value>false</param-value> 
</init-param>
<init-param>
<!-- 서비스 수행시간 출력 여부 -->
<param-name>elapsedTime</param-name> 
<param-value>false</param-value> 
</init-param>
</servlet> 

<!-- 요청받은 데이터를 타 서비스(url)로 전달하고, 타 서비스(url)로부터 수신받은 데이터를 응답하는 중간 전달자 역할의 HttpServlet입니다 -->
<servlet>
<servlet-name>ForwardRequest</servlet-name>
<servlet-class>com.tobesoft.xplatform.console.services.ForwardRequestServlet</servlet-class>
</servlet>

<!-- 시스템 파일(이미지,환경파일 등)을 찾아 리턴합니다 -->
<servlet>
<servlet-name>LoadResource</servlet-name>
<servlet-class>com.tobesoft.xplatform.console.services.LoadResourceServlet</servlet-class>
</servlet>

<!-- 이미지를 가공하여 새로운 이미지로 리턴합니다(Stretch 대응) xplatform9-ajax-imagefilter 설치가 필요합니다. -->
<servlet>
<servlet-name>ImageFilter</servlet-name>
<servlet-class>com.tobesoft.xplatform.console.services.imagefilter.ImageFilterServlet</servlet-class>
<init-param>
<param-name>cacheDir</param-name>
<param-value>cache/images</param-value>
</init-param>
<init-param>
<param-name>useCache</param-name>
<param-value>true</param-value>
</init-param> 
</servlet>

<!-- 엑셀익스포트 요청을 처리합니다 xplatform9-ajax-exportexcel 설치가 필요합니다. -->
<servlet>
<servlet-name>ExportExcel</servlet-name>
<servlet-class>com.tobesoft.xplatform.console.services.exportexcel.ExportExcelServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>ForwardRequest</servlet-name>
<url-pattern>/services/ForwardRequest</url-pattern>
</servlet-mapping> 
<servlet-mapping>
<servlet-name>ImageFilter</servlet-name>
<url-pattern>/services/ImageFilter</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>LoadResource</servlet-name>
<url-pattern>/resources/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>ExportExcel</servlet-name>
<url-pattern>/services/ExportExcel</url-pattern>
</servlet-mapping>

4단계: Tomcat 재시작

Tomcat을 재시작 합니다.

라이선스

XPLATFORM HTML5는 두 가지의 라이선스를 필요로 합니다. 하나는 UX-Studio의 사용에 대한 라이선스이고, 다른 하나는 X-API 사용에 대한 라이선스입니다. 두 가지 라이선스를 모두 적용하여야만 XPLATFORM HTML5 를 정상적으로 이용 가능합니다.

UX-Studio 사용에 대한 라이선스

라이선스를 등록하면 HTML5버전 개발을 위한 UX-Studio의 사용 권한을 취득할 수 있습니다. 발급받은 라이선스 키를 화면과 같이 입력하시길 바랍니다.

라이선스 입력화면은 “Help > About UX-Studio… > Enter New License” 버튼을 클릭하면 나타납니다.

License 파일들

다음은 License 파일의 종류입니다.

X-API 사용에 대한 라이선스

라이선스를 등록하면 서버와의 연동을 위한 모듈인 X-API의 사용 권한을 취득할 수 있습니다. (프로젝트 컴파일 및 배포 시에 필요합니다)

X-API의 라이선스 파일명은 “XPLATFORM_Server_License.xml”입니다.

X-API 사용에 대한 라이선스 적용은 두 가지 방법이 있습니다.

1. 라이선스 파일을 jar파일과 동일한 위치에 포함시킵니다.

2. 라이선스 파일을 클래스 경로에 포함시킵니다.

만일 두 위치에 동시에 라이선스 파일이 존재하는 경우 1) 에 위치한 라이선스가 우선 적용됩니다. jar파일과 동일한 위치에 포함시킬 경우 일반적으로 Web Application의 /WEB-INF/lib 경로가 됩니다. 클래스 경로에 포함시킬 경우 일반적으로 Web Application의 /WEB-INF/classes 경로가 됩니다.

업그레이드

XPLATFORM HTML5의 일부 jar 파일 버전이 업그레이드 된 경우 설치하는 방법을 설명합니다. 경우에 따라서는 기존의 산출물을 모두 삭제하고, 재컴파일 과정을 통하여 산출물을 다시 작성해야 하는 경우도 발생합니다.

1단계 : 업그레이드된 XPLATFORM HTML5의 jar 파일 복사

버전이 업그레이드된 XPLATFORM HTML5의 jar 파일을 기존 jar 파일 위치와 동일한 디렉토리에 복사합니다. 예를 들어 <Tomcat Home>/webapps/myajax/WEB-INF/lib에 버전이 업그레이드된 xplatform-ajax-x.x.jar를 복사합니다.

2단계 : 이전 XPLATFORM HTML5의 jar 파일 삭제

버전이 업그레이드된 jar 파일의 이전 버전을 삭제합니다. 버전만 다른 동일한 jar가 동일한 위치에 있는 경우 오류의 원인이 될 수 있습니다.

3단계 : 필요에 따라 기존 산출물 삭제

Jar 파일의 업그레이드에 따라 산출물의 내용이 달라지는 경우 이전에 생성된 산출물을 삭제해야 하는 경우도 발생합니다. 일반적으로 산출물의 위치는 Context 디렉토리에 밑에 UX-Studio로 작성한 XPLATFORM의 프로젝트명을 가진 디렉토리입니다. 예를 들어 “sample” 프로젝트인 경우 <Tomcat Home>/webapps/myajax/sample 디렉토리가 “sample” 프로젝트의 산출물 위치입니다.

4단계 : Tomcat 재시작

Tomcat을 재시작한 후에 프로젝트 페이지의 동작을 테스트합니다. 3단계에 의해 기존 산출물을 삭제한 경우 5단계를 거친 후 테스트를 수행합니다.

5단계 : 기존 산출물을 삭제한 경우 재컴파일

3단계에 의해 기존 산출물을 삭제한 경우 UX-Studio를 이용하여 해당 프로젝트의 재컴파일을 수행합니다.

설치용 파일들

XPLATFORM HTML5 서버 설치를 위한 파일들은 다음과 같습니다.

XPLATFORM HTML5

다음은 XPLATFORM HTML5의 설치 파일들입니다.

다음은 XPLATFORM HTML5의 외부 의존 라이브러리들입니다.

XPLATFORM HTML5 Imagefilter

다음은 XPLATFORM HTML5 Imagefilter의 설치 파일들입니다.

다음은 XPLATFORM HTML5 Imagefilter의 외부 의존 라이브러리들입니다.

XPLATFORM HTML5 Exportexcel

다음은 XPLATFORM HTML5 Exportexcel의 설치 파일들입니다.

다음은 XPLATFORM HTML5 Exportexcel의 외부 의존 라이브러리들입니다.

외부 옵션 라이브러리

다음은 XPLATFORM HTML5의 외부 옵션 라이브러리입니다.