V5 API 설치 및 업데이트 가이드

개요

V5 API는 고객의 ERP 시스템과 V5 추적성 솔루션 간의 통합을 용이하게 하기 위해 개발되었습니다 . 이 가이드에서는 V5 API 설치 방법과 업데이트 방법을 다룹니다.

1. 사전 조건
   1. 자바
   2. 아파치 톰캐스트/호스팅
2. V5-API 설치
3. API 구성
4. API 업데이트

시스템에 아직 없는 경우 Java Runtime Environment(버전 8-15)를 설치해야 합니다. 이는 32비트 또는 64비트일 수 있습니다. V5 Traceability 앱이 설치된 시스템에 API를 설치하는 경우 Java가 이미 설치되어 있으므로 이 단계를 건너뛸 수 있습니다.

OpenJDK(Java Development Kit)는 V5 API와도 호환됩니다.

V5 API를 설치하기 위해 가장 먼저 해야 할 일은 Apache Tomcat을 설치하는 것입니다 . V5 API는 Apache Tomcat 버전 10까지 지원하며, SG Systems는 버전 9 또는 10을 설치하는 것을 권장합니다.

Glassfish와 같은 다른 호스팅 플랫폼도 Apache Tomcat 대신 사용할 수 있지만 이 예에서는 Tomcat을 활용하겠습니다.

이 예제에서는 Tomcat 9.0.75를 '일반' 설치 방식으로 설치합니다. Tomcat에서 사용할 HTTP 포트를 설정할 수 있는데, 기본값은 8080입니다. SG Reports 도 기본적으로 8080 포트를 사용하기 때문에 충돌 문제가 발생할 수 있습니다. 따라서 시스템에 SG Reports가 설치되어 있는 경우 다른 포트(이 예제에서는 8181)를 사용하는 것이 좋습니다.

서비스 이름과 Tomcat 관리자 사용자 이름 및 비밀번호도 여기에서 설정할 수 있으며 이는 귀하의 재량에 따라 설정할 수 있습니다. 데모 설치를 위해 다음과 같이 진행됩니다.

설치하는 동안 JRE 설치 폴더에서 설치 프로그램을 지정하라는 메시지가 표시됩니다. 자동으로 채워져야 하지만, 그렇지 않은 경우 올바른 폴더를 지정해야 합니다.

설치가 완료되면 'Apache Tomcat 실행' 옵션을 선택해야 합니다.

이 새로운 Windows 서비스는 API의 지속적인 실행을 보장하기 위해 향후 Windows에서 시작되도록 설정되어야 합니다. 이는 Windows 서비스 설정 또는 Tomcat 속성 창에서 설정할 수 있습니다. 이 창은 Windows에서 'Tomcat 구성'을 검색하여 찾을 수 있습니다. 그런 다음 '일반' 탭에서 시작 유형을 설정할 수 있습니다.

Tomcat의 시간대 설정도 동일한 속성 창에서 하는 것이 좋습니다. 'Java' 탭에서 'Java 옵션' 패널에 '-Duser.timezone=GMT'를 붙여넣고 적용하면 됩니다.

더 큰 데이터 요청을 더 잘 처리하기 위해 Tomcat의 최대 메모리 풀을 1024MB로 늘리는 것도 좋습니다.

Tomcat이 제대로 설치되었는지 확인하려면 웹 브라우저에서 연결을 확인하는 것이 좋습니다. 이 설치의 경우 http://127.0.0.1:8181/ (로컬 호스트와 설치 중에 선택한 포트 번호)에 연결하면 다음과 같은 결과가 나타납니다.

필요한 모든 조건을 충족했는지 확인했으면 이제 API 자체로 넘어갈 수 있습니다. V5 API의 최신 버전은 여기에서 다운로드할 수 있습니다 . 여기에서 'V5-API.war' 파일이 다운로드됩니다.

그런 다음 이 파일을 다음 위치에 배치해야 합니다.

*InstallDir*\Apache Software Foundation\*선택한 서비스 이름*\webapps

따라서 우리의 예에서는 다음과 같습니다.

C:\Program Files\Apache Software Foundation\Tomcat 9.0_Tomcat9-V5-API\webapps

여기에 배치하고 Tomcat 서비스가 실행되면 'V5-API' 폴더가 'war' 파일과 함께 자동으로 생성됩니다.

이제 V5 API 설치가 완료되었습니다. 이제 이를 V5 데이터베이스에 연결하기만 하면 됩니다.

Tomcat 설치 폴더(이 예시에서는 ' C:\Program Files\Apache Software Foundation\Tomcat 9.0_Tomcat9-V5-API' )에 ' config ' 라는 새 폴더를 생성해야 합니다 . 그런 다음 여기에서 'db_settings.properties' 파일을 다운로드하십시오.

이 파일을 메모장으로 열고 V5 추적성에서 사용 중인 SQL 데이터베이스 유형과 관련이 없는 데이터를 모두 삭제하십시오. 이 방법을 잘 모르시겠으면 SG 지원팀 에 문의하십시오.

사용자 이름 및 비밀번호 필드를 작성하려면 데이터베이스 관리자에게 문의하세요.

그런 다음 완성된 파일을 위에 명시한 폴더에 넣고 Tomcat 서비스를 다시 시작합니다. 이제 데이터베이스에 대한 연결이 설정됩니다!

V5 API 사용에 대한 안내는 여기의 API 전용 섹션을 참조하십시오.

V5-API를 업데이트하는 방법은 간단합니다. 이 링크를 사용하여 'V5-API.war' 파일을 다시 다운로드하기만 하면 됩니다 . 다운로드 후에는 기존의 .war 파일과 설치 시 생성된 폴더를 모두 삭제하십시오.

그런 다음 설치에서 위 단계를 반복하고 'V5-API.war' 파일을 이 폴더에 다시 놓은 다음 폴더를 다시 추출한 다음 Tomcat 서비스를 다시 시작하십시오.

이제 최신 버전으로 업데이트된 API를 계속 사용할 수 있습니다!