Files
caliverse_doc/05. Tool/ContentTool 매뉴얼.md
2025-05-01 07:27:54 +09:00

103 lines
2.7 KiB
Markdown

## 실행 방법
### 커맨드라인에서 실행
```
cd Caliverse\DataAssets\Tools\ContentTool
.\ContentTool.exe
```
\
**schema.json을 c# 코드로 생성**
```
.\ContentTool.exe gencode
```
\
**xlsx 파일을 json 파일로 변환**
```
.\ContentTool.exe convert
```
\
**json 파일을 검증**
```
.\ContentTool.exe validate
```
\
**json 데이터 파일을 소스로 enum.json 파일을 생성**
```
.\ContentTool.exe genenum
```
\
**xlsx파일에 대응하는 schema.json파일이 없는 경우 schema.json 파일을 생성**
```
.\ContentTool.exe genschema
```
\
**help 커맨드로 추가 옵션을 볼 수 있음**
```
.\ContentTool.exe help [명령어]
```
### DevTray
![](Pasted_image_20240724184104.png)
**메타 Excel2Json**\
convert 명령을 실행한다
**메타Schema2Code**\
gencode 명령을 실행한다
### 젠킨스
http://10.20ㅊ.10.10:8080/login?from=%2F
caliversedev / Caliverse!!!1218
**DEV_ConvertExcel Job**
이 job에서 엑셀파일의 변경이 있을 경우 실행된다
- 서버용 json 파일과 클라용 csv파일을 생성
- schema.json 파일만 변경된 경우에는 실행되지 않음
**DEV_ConvertExcel 구성**
svn://10.20.20.9/trunk/Jenkins
groovy와 powershell 스크립트로 되어있다
## 신규 메타 데이터 작성 프로세스
### 1. 개발자가 schema.json 생성
기존 schema.json을 참고해서 신규 파일을 작성하거나, genschema 명령을 사용해 기본 포멧을 만든 후 수정한다.
아래 경로에 툴이 지원하는 기능이 Sample로 있으니 참고해서 조금 복잡한 구조로 만들 수도 있다
```
Caliverse\Server\Tools\ContentTool\Sample
```
**SCHEMA/config/\*.config.json 에 대해**
<br/>
현재 툴은 엑셀 컬럼명과 c# 프로퍼티명을 동일하고 사용하고 있다.\
이전 툴에서는 엑셀 컬럼명과 c# 프로퍼티명이 다른경우가 꽤 있어서 이 이름을 맞춰 주려고 추가한 파일.\
신규 schema.json을 추가 시에는 config.json파일을 생성하지 않아야 함.
### 2. ContentTool config에 추가
아래 파일에 이미 작성된 리스트가 있으니 포멧에 맞춰 신규 schema.json파일과 엑셀 파일을 추가해주면 됨
```
Caliverse\DataAssets\Tools\Config\ContentTool.json
```
### 3. 기획자가 엑셀 파일 생성
기획 담당자에게 요청
### 4. 코드로 변환
커맨드라인 또는 DevTray를 통해서 코드 생성
> 코드는 젠킨스에서도 나오지만 개발자가 schema.json을 커밋할 때 같이 올려주는 게 좋음
### 5. 엑셀을 json 데이터로 변환
커맨드라인 또는 DevTray를 통해서 json 생성
> 최초 생성 시에는 젠킨스를 통하지 않고 json 데이터를 만들어서 테스트할 필요 있음