사용자 정의 감사 카테고리

Composer의 ThingWorx 모델 정의 > 시스템 > 하위 시스템 > 감사 하위 시스템 > 사용자 정의 감사 카테고리

사용자 정의 감사 카테고리

감사 하위 시스템은 사용 가능한 감사 카테고리의 고정 집합을 제공합니다. ThingWorx Platform에서 이벤트에 의해 트리거되는 감사 메시지는 이러한 카테고리에 지정됩니다. 이러한 지정은 변경할 수 없습니다. 그러나 이 집합에 없는 카테고리가 필요한 경우 사용자 정의 카테고리를 만들고 사용자 정의 이벤트 및 감사 메시지를 카테고리에 지정할 수 있습니다.

로컬리제이션 테이블을 통해 사용자 정의 감사 카테고리를 추가하는 방법

감사 하위 시스템의 두 구현은 모두 사용자 정의 감사 카테고리를 추가하는 다음과 같은 방법을 제공합니다.

• ThingWorx Composer를 통해 수정한 ThingWorx 로컬리제이션 테이블을 사용합니다.

• ThingWorx Platform에 대해 새 백엔드 Java 확장을 만듭니다. ThingWorx Java SDK로 사용자 정의 감사 카테고리를 생성하여 이러한 용도의 확장을 생성하려면 확장을 사용하여 사용자 정의 감사 카테고리 만들기 항목을 참조하십시오. 이 방법은 여전히 로컬리제이션 테이블을 사용하지만, 여기에 설명된 대로 Composer 사용자 인터페이스를 통해 토큰을 프로그래밍 방식 또는 대화식으로 생성할 수 있습니다.

이 단원에서는 로컬리제이션 테이블 사용자 인터페이스를 통해 ThingWorx Platform 측에 사용자 정의 카테고리를 추가하는 방법을 설명합니다. ThingWorx 로컬리제이션 테이블을 사용해본 적이 없는 경우 잠시 시간을 내어 이 도움말 센터의 로컬리제이션 테이블 항목을 읽어보십시오.

준비가 완료되면 다음 단계에 따라 로컬리제이션 테이블에 사용자 정의 감사 카테고리를 추가합니다.

1. ThingWorx Composer에 로그인하고

(찾아보기)을 클릭합니다.

2. 다음 그림과 같이 찾아보기 탐색 패널의 시스템에서 로컬리제이션 테이블을 선택합니다.

로컬리제이션 테이블 목록이 나타납니다.

3. 기본 로컬리제이션 테이블에 대한 확인란을 선택하고, 확인란이 활성화되면 편집 버튼을 클릭하여 다음과 같이 테이블을 편집 모드로 표시합니다.

기본 로컬리제이션 테이블에 대한 로컬리제이션 토큰 페이지가 편집 모드로 나타납니다.

4. 다음 그림과 같이 + 추가를 클릭하여 사용자 정의 감사 카테고리에 대한 로컬리제이션 토큰을 추가합니다.

새 로컬리제이션 토큰 페이지가 화면의 오른쪽에 나타납니다.

5. 이름 필드에 먼저 감사 카테고리 로컬리제이션 토큰에 대한 접두사 audit.AuditCategory.를 입력한 다음 고유한 이름을 입력해야 합니다. 사용자 정의 카테고리에 사용하는 이름은 고유해야 합니다. 예를 들어 audit.AuditCategory.CustomAlertCategory입니다.

토큰이 유효하면 QueryAuditHistory 및 QueryAuditHistoryWithQueryCriteria 서비스는 접두사를 포함하거나 포함하지 않고 사용자 정의 감사 메시지를 반환합니다. 그러나 접두사를 사용하지 않으면 하위 시스템에서 감사 카테고리 토큰과 "기타" 토큰을 구분할 수 없습니다. 또한 감사 하위 시스템이 감사 로그 사용자 인터페이스의 카테고리 목록에 사용자 정의 감사 카테고리를 표시하도록 하려면 모든 사용자 정의 감사 카테고리에 audit.AuditCategory. 접두사를 사용해야 합니다.

6. 토큰 값 필드에서 카테고리에 적합하다고 생각하는 모든 값을 사용할 수 있습니다. 예를 들어, 접두사 뒤에 입력한 이름의 일부를 사용합니다. 영숫자, 공백 및 밑줄을 사용할 수도 있습니다.

토큰 값은 다른 언어의 로컬리제이션 테이블에서 이 토큰에 대한 참조 값이 됩니다.

7. 이 로컬리제이션 토큰을 저장한 다음 감사 메시지에 대한 로컬리제이션 토큰을 작성하려면

을 클릭하고 다음 단계를 계속 진행합니다. 여기서 중지하려면

을 클릭하여 페이지를 저장하고 닫습니다.

다른 로컬리제이션 테이블에 이 로컬리제이션 토큰을 정의하지 않고 질의를 수행할 경우 질의 서비스는 사용자가 작성한 항목만 반환합니다. 다른 로컬리제이션 테이블에 토큰을 추가하면 결과에 다른 언어가 포함됩니다. 사용자 정의 감사 메시지에 대한 토큰을 정의하지 않은 경우 질의에서 해당 토큰을 찾을 수 없습니다.

다음에 사용자 정의 감사 메시지에 대한 로컬리제이션 토큰을 기본 로컬리제이션 테이블에 추가합니다.

8. 로컬리제이션 토큰 페이지를 닫은 경우 +추가를 클릭하여 새 로컬리제이션 토큰 페이지를 다시 표시합니다. 그렇지 않으면 다음 단계를 계속 진행합니다.

9. 토큰 이름 필드에 사용자 정의 감사 메시지 토큰의 고유한 접두사 및 고유한 이름을 입력합니다. 접두사로 audit.AuditCategory는 사용하지 마십시오. 사용자 정의 감사 메시지의 이름은 고유해야 합니다. 예를 들어 myCustomAlertMessages.AlertEvent입니다.

접두사 audit.AuditCategory는 카테고리 전용으로 예약되어 있습니다. 메시지에 이 접두사를 사용하면 메시지가 카테고리로 해석되어 감사 로그 사용자 인터페이스에 메시지가 아니라 카테고리로 표시될 수 있습니다.

사용자 정의 감사 메시지의 경우 ThingWorx 사용자 인터페이스에서 사용할 수 없는 추가 정보가 필요합니다. 이 정보는 사용자 정의 감사 메시지의 인수입니다. 예를 들어, 인수는 thingName 및 alertEventMsg이고, 샘플 값은 mixer123 및 overflow입니다. 메시지에 대한 토큰 값에 이러한 인수를 지정할 수 있습니다. 이러한 값은 사용자 정의 감사 메시지가 생성되고 감사 질의에 의해 반환될 때 대체됩니다. "엔티티 파일 가져오기가 성공적으로 완료됨"과 같은 간단한 메시지에는 지정할 인수가 없습니다.

사용자 정의 이벤트 작성에 대한 자세한 내용은 이벤트, 경고 및 구독 작업 및 ThingWorx API 설명서를 참조하십시오.

10. 토큰 값 필드에 감사 메시지에 대한 인수를 추가합니다. 각 인수의 앞과 뒤에 각각 두 개의 밑줄이 있어야 합니다. 예를 들어, User를 제거하기 위한 사용자 정의 감사 메시지에 다음과 같은 인수가 있다고 가정합니다.

◦ username

◦ entityType

◦ entityName

토큰 값 필드에 다음을 입력합니다.

User __username__ removed __entityType__ named '__entityName__'

사용자 정의 감사 메시지 인수에 해당 값이 있으면 런타임에 이 세 개의 인수가 대체됩니다.

일부 메시지는 인수를 사용할 필요가 없습니다. 예를 들어, "엔티티 파일 가져오기가 성공적으로 완료됨"과 같은 간단한 메시지는 대체를 사용하지 않습니다.

11.

을 클릭하여 페이지를 저장하고 닫습니다.

12. 사용자 정의 감사 카테고리 및 메시지 추가를 테스트하려면 메시지를 생성하는 이벤트를 트리거한 후 반환할 로캘을 지정하여 QueryAuditHistory 또는 QueryAuditHistoryWithQueryCriteria 서비스를 실행합니다. QueryAuditHistoryWithQueryCriteria 서비스가 있는 카테고리에 대한 로컬리제이션 토큰을 사용해야 합니다.

그런 다음 사용자 정의 감사 카테고리 및 메시지에 대한 로컬리제이션 토큰을 원하는 각 로캘에 대한 로컬리제이션 테이블에 추가해야 합니다. 예를 들어, 일본어의 경우 ja 이고 독일어의 경우 de입니다.

다음 단계를 따르십시오.

1. 찾아보기 탭을 클릭하여 로컬리제이션 테이블 목록으로 돌아간 다음 다른 로캘을 선택합니다. 예를 들어, 다음과 같이 ja(일본어)를 선택하고 편집을 클릭합니다.

2. ja 로캘의 로컬리제이션 토큰 페이지에서 사용자 정의 감사 카테고리에 대해 방금 생성한 로컬리제이션 토큰을 찾습니다.

토큰을 빠르게 찾으려면 목록 맨 위에 있는 필터를 사용합니다. 토큰 이름에 단어를 입력합니다. 예를 들어, 이름에 "MyCustom"을 사용한 경우 필터 필드에 아래와 같이 입력합니다. 해당 단어가 포함된 모든 로컬리제이션 토큰이 표시됩니다.

3. 위 그림과 같이 사용자 정의 감사 카테고리 토큰의 이름을 클릭하여 탭 오른쪽에 편집 페이지를 표시합니다.

4. 토큰 값 필드에 기본 로캘에서 이 카테고리에 사용한 토큰 값의 번역된 값을 입력합니다.

을 클릭하여 편집 페이지를 저장하고 닫습니다.

6. 로컬리제이션 토큰 목록에서 필터를 사용하여 기본 로캘의 사용자 정의 감사 메시지에 대해 작성한 토큰의 이름을 찾은 다음 이를 클릭하여 탭 오른쪽에 해당 편집 페이지를 표시합니다.

7. 토큰 값 필드에 메시지의 번역된 부분 및 해당하는 경우 감사 메시지에 대한 번역된 인수 이름을 추가합니다. 기본 로캘의 토큰 값과 마찬가지로 각 인수의 앞과 뒤에 두 개의 밑줄이 있어야 합니다.

을 클릭하여 편집 페이지를 저장하고 닫습니다.

9. 사용자 정의 감사 카테고리 및 메시지 추가를 테스트하려면 메시지를 생성하는 이벤트를 트리거한 후 반환할 로캘을 지정하여 QueryAuditHistory 또는 QueryAuditHistoryWithQueryCriteria 서비스를 실행합니다. 이름이 아니라 카테고리에 대한 로컬리제이션 토큰을 지정해야 합니다.

ThingWorx Java API를 사용하면 이 모든 작업을 하나의 확장에서 수행할 수 있습니다. 감사하려는 이벤트를 작성한 다음 사용자 정의 감사 카테고리 및 사용자 정의 감사 메시지를 로컬리제이션 테이블, 범용 영어의 기본값 및 필요한 다른 로캘의 테이블에 추가합니다. 확장을 가져오는 중에 로컬리제이션 테이블을 가져올 수도 있습니다.

프로그래밍 방식으로 이벤트를 추가하는 방법에 대한 자세한 내용은 이 도움말 센터의 "응용 프로그램 개발을 위한 모범 사례" 섹션에 있는 이벤트, 경고 및 구독 작업 항목을 참조하십시오. ThingWorx API의 Javadoc(API 설명서)도 참조해야 합니다.

로컬리제이션 테이블이 있는 확장 패키징에 대한 자세한 내용은 로컬리제이션 테이블이 있는 확장 패키징 항목을 참조하십시오.