Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Administrator > General > Company Management > General

### 메뉴 설명

* [**General**](company-management/general) **:** 쿼리파이의 기본 시스템 설정을 적용하는 메뉴입니다.
* [**General**](company-management/general) : 쿼리파이의 기본 시스템 설정을 적용하는 메뉴입니다.
* [**Security**](company-management/security) : 쿼리파이의 보안 설정을 적용하는 메뉴입니다.
* [**Allowed Zones**](company-management/allowed-zones)****: 쿼리파이의 허용 네트워크 존 설정을 구성하는 메뉴입니다.
* [**Allowed Zones**](company-management/allowed-zones) : 쿼리파이의 허용 네트워크 존 설정을 구성하는 메뉴입니다.
* [**Channels**](company-management/channels) : 쿼리파이의 알림을 받을 채널을 구성하는 메뉴입니다.
* [**Alerts**](company-management/alerts) : 쿼리파이 알림을 설정하는 메뉴입니다.
* [**Licenses**](company-management/licenses) : 쿼리파이의 적용 라이선스 현황을 조회할 수 있는 메뉴입니다.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ Expiration Date
`{{expirationDate}}`
</td>
<td>
만료 일자
만료일자
</td>
<td>
10.2.2
Expand Down Expand Up @@ -268,7 +268,7 @@ Requested Privilege per Connection
`{{connectionPrivilegeNames}}`
</td>
<td>
커넥션 별 요청된 Privilege를 목록으로 표시
커넥션별 요청된 Privilege를 목록으로 표시
* 예:
* Connection A : Read/Write
* Connection B : Read-Only
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Allowed Zones 페이지에서는, 사용자의 QueryPie 웹 콘솔 접근 및 DB
### 등록된 Allowed Zone 목록 조회하기

Allowed Zone의 목록을 조회하기 위해서는 Administrator &gt; General &gt; Company Management &gt; Allowed Zones 페이지로 접근합니다.
Allowed Zone 이름으로 검색이 가능합니다.
Allowed Zone 이름으로 검색할 수 있습니다.

<Callout type="info">
**Default** Allowed Zone은 QueryPie 설치 시에 기본으로 생성되며 모두 허용(0.0.0.0/0) 값을 가집니다.
Expand Down Expand Up @@ -68,8 +68,8 @@ Create Allowed Zone 생성 시 출력되는 입력항목
</figcaption>
</figure>

* **Name** : Allowed Zone 이름
* **IP Address Range(s)** : 할당할 IP 주소, 또는 IP 주소 범위를 입력합니다.
* **Name**: Allowed Zone 이름
* **IP Address Range(s)**: 할당할 IP 주소, 또는 IP 주소 범위를 입력합니다.
* IP 주소, 또는 IP 주소 범위를 하나 이상 입력할 수 있습니다.
* IP 주소 범위는 Classless Inter-Domain Routing(CIDR) 표기법을 사용합니다. 참고: [CIDR 이란?](https://aws.amazon.com/ko/what-is/cidr/)
* 둘 이상의 IP 주소, IP 주소 범위를 입력할 때, 쉼표를 구분자로 하여 입력합니다.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import { Callout } from 'nextra/components'

### Overview

Channels 페이지에서는 QueryPie에서 발송하는 알림을 수신할 채널을 등록 및 관리합니다.
현재 QueryPie에서 제공하는 채널 타입은 Slack, Agit, HTTP, Email의 네 가지이며, 채널 등록 사전에 연동을 위한 작업이 필요합니다.
Channels 페이지에서는 QueryPie에서 발송하는 알림을 수신할 채널을 등록하고 관리합니다.
현재 QueryPie에서 제공하는 채널 타입은 Slack, Agit, HTTP, Email의 네 가지이며, 채널 등록 전에 연동 작업이 필요합니다.

### 등록된 채널 조회하기

Expand Down Expand Up @@ -45,8 +45,8 @@ Administrator &gt; General &gt; Company Management &gt; Channels &gt; Create Cha
</figcaption>
</figure>

* **Title** : 채널 이름
* **Channel Type** : 알림을 받을 채널 타입을 선택합니다. 선택지에 따라 하단 추가 입력 항목이 상이합니다.
* **Title**: 채널 이름
* **Channel Type**: 알림을 받을 채널 타입을 선택합니다. 선택지에 따라 하단 추가 입력 항목이 상이합니다.
* Slack : Slack 채널로 알림 전송
* Agit : 아지트로 알림 전송
* HTTP : Zapier, Okta Workflows 등 HTTP API에 직접 요청하는 방식
Expand All @@ -60,7 +60,7 @@ Administrator &gt; General &gt; Company Management &gt; Channels &gt; Create Cha
Slack App의 자세한 설정 방법은 문서 하단의 **Slack 연동을 위한 Slack App 설정 방법** 항목을 참고해주세요.
</Callout>

* **Message Sending Method** : 메시지 전송 방식
* **Message Sending Method**: 메시지 전송 방식
* API : Slack API를 활용한 메시지 전송
* API를 선택한 경우, New Request Alert 에서 승인자 (assignee) 멘션이 가능합니다. (10.2.2 버전 이후)
* Bot User OAuth Token : 메시지를 전송할 Slack App의 Bot User OAuth Token
Expand All @@ -74,15 +74,15 @@ Slack App의 자세한 설정 방법은 문서 하단의 **Slack 연동을 위
채널 생성을 위한 입력 내용은 다음과 같습니다.

* **Request URL** (필수) : 요청을 보낼 URL
* **Agit Channel** : 아지트 채널에 대해 표시할 이름 입력
* **Agit Channel**: 아지트 채널에 대해 표시할 이름 입력

#### Channel Type을 `HTTP`로 선택한 경우

채널 생성을 위한 입력 내용은 다음과 같습니다.

* **Request URL** (필수) : 요청을 보낼 URL
* **Request Header (JSON)** : 필요시 호출을 위한 요청 헤더를 입력 (JSON 형식)
* **Body Template** : 요청 바디 템플릿
* **Request Header (JSON)**: 필요시 호출을 위한 요청 헤더를 입력 (JSON 형식)
* **Body Template**: 요청 바디 템플릿
* 기본값 : `{{message}}`
* Alert에서 정의되는 메시지의 앞뒤에 공통으로 추가하려는 내용을 기입

Expand All @@ -100,7 +100,7 @@ Admin &gt; General &gt; System &gt; Integration 메뉴로 진입 후, Email 타

* **Email Recipients** (필수) : 이메일 수신자
* QueryPie에 등록된 사용자를 선택할 수 있으며, 등록된 이메일 주소로 메일이 발송됨
* **Body Template** : 요청 바디 템플릿
* **Body Template**: 요청 바디 템플릿
* 기본값 : `{{message}}`
* Alert에서 정의되는 메시지의 앞뒤에 공통으로 추가하려는 내용을 기입

Expand Down Expand Up @@ -158,14 +158,14 @@ Slack 내 Webhook 추가 화면
#### 2-2. API 타입으로 연동하기

1. 생성했던 App 을 클릭하여 앱의 Settings 페이지에 진입한 뒤, `App Manifest` 메뉴로 이동합니다.
2. scopes 영역에 `chat:write`, `users:read`, `users:read.email` 을 추가한 뒤 저장합니다. <br/>
2. scopes 영역에 `chat:write`, `users:read`, `users:read.email`을 추가한 뒤 저장합니다. <br/>
<figure data-layout="center" data-align="center">
<img src="/administrator-manual/general/company-management/channels/screenshot-20241211-171140.png" alt="Slack API &gt; Apps &gt; Settings &gt; App Manifest" width="736" />
<figcaption>
Slack API &gt; Apps &gt; Settings &gt; App Manifest
</figcaption>
</figure>
3. 상단의 노란색 알림 바를 통해 `Reinstall your app` 을 통해 앱을 재시작합니다. (필수)
3. 상단의 노란색 알림 바에서 `Reinstall your app`을 눌러 앱을 재설치합니다. (필수)
4. `Reinstall to {Workspace_name}` 버튼을 클릭하여 알림을 보낼 Slack 채널을 선택한 뒤 `허용` 버튼을 클릭합니다.
1. Scope를 변경한 뒤 적용하려면, 이 단계를 다시 수행해야 합니다.
5. 해당 Slack 채널로 이동하여 생성한 앱을 추가합니다. (이미 앱을 추가한 상태라면 이 단계는 건너뛸 수 있습니다)
Expand All @@ -176,7 +176,7 @@ Slack 내 Webhook 추가 화면
Slack App &gt; Channel Detail
</figcaption>
</figure>
7. OAuth & Permissions 페이지에서 Bot User OAuth Token 을 복사하고, QueryPie 채널 생성 모달에 붙여넣습니다.
7. OAuth & Permissions 페이지에서 Bot User OAuth Token을 복사하고, QueryPie 채널 생성 모달에 붙여넣습니다.
<figure data-layout="center" data-align="center">
<img src="/administrator-manual/general/company-management/channels/screenshot-20240804-190835.png" alt="Slack 내 OAuth & Permissions 페이지 - 토큰 복사" width="760" />
<figcaption>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ Administrator &gt; General &gt; Company Management &gt; General

### 기본 설정

* **Company Name** : 프로필 영역 등에 표시할 회사 이름을 입력합니다.
* **Web Base URL** : QueryPie 서비스에 접근하기 위해 사용하는 기본 도메인 주소입니다. [[자세한 내용]](../../../installation/container-environment-variables/querypieweburl)
* **Timezone** : QueryPie 전체에서 표시될 날짜 및 시각 정보에 적용될 타임존을 설정합니다.
* **Date Format** : 날짜 표기 방식을 지정합니다.
* **Default Display Language** : QueryPie의 기본 언어 설정을 설정합니다. (디폴트: 영어)
* **Audit Log Retention Period**: 감사로그 보존 주기를 설정합니다. 현재는 5년으로 고정되어 있습니다.
* **Go to System Properties** : 클릭 시 시스템 설정값 내역을 확인할 수 있습니다.
* **Company Name**: 프로필 영역 등에 표시할 회사 이름을 입력합니다.
* **Web Base URL**: QueryPie 서비스에 접근하기 위해 사용하는 기본 도메인 주소입니다. [[자세한 내용]](../../../installation/container-environment-variables/querypieweburl)
* **Timezone**: QueryPie 전체에서 표시될 날짜 및 시각 정보에 적용될 타임존을 설정합니다.
* **Date Format**: 날짜 표기 방식을 지정합니다.
* **Default Display Language**: QueryPie의 기본 언어를 설정합니다. (기본값: 영어)
* **Audit Log Retention Period**: 감사 로그 보존 주기를 설정합니다. 현재는 5년으로 고정되어 있습니다.
* **Go to System Properties**: 클릭 시 시스템 설정값 내역을 확인할 수 있습니다.


### System Properties
Expand Down Expand Up @@ -56,9 +56,9 @@ Workflow Configurations에서는 결재 상신 및 승인 관련 설정을 변
관리자는 Maximum Approval Duration 항목에서 승인 대기 요청이 자동으로 만료될 때까지의 기간을 1일에서 최대 14일까지 설정할 수 있습니다.
이곳에 설정된 기간은 사용자가 워크플로우를 상신할 때 선택하는 Approval Expiration Date (승인 만료일)의 최대값으로 적용됩니다.

* Admin &gt; Databases &gt; Configurations의 Maximum Access Duration 또는 Admin &gt; Servers &gt; Configurations의 Maximum Access Duration이 Maximum Approval Duration보다 짧게 설정된 경우, 권한이 이미 만료된 후에 승인이 처리되는 상황을 방지하기 위해 Approval Expiration Date은 더 짧은 Access Expiration Date (권한 만료일) 따라갑니다.
* Admin &gt; Databases &gt; Configurations의 Maximum Access Duration 또는 Admin &gt; Servers &gt; Configurations의 Maximum Access Duration이 Maximum Approval Duration보다 짧게 설정된 경우, 권한이 이미 만료된 후에 승인이 처리되는 상황을 방지하기 위해 Approval Expiration Date는 더 짧은 Access Expiration Date(권한 만료일) 따라갑니다.

### 워크플로우 사유입력 글자 수 제한 설정
### 워크플로우 사유 입력 글자 수 제한 설정

워크플로우의 요청 사유(Reason for Request)와 승인, 거부, 취소, 확인 시 입력하는 Comment의 최소 및 최대 글자 수를 설정하는 기능입니다.
이 설정을 통해 관리자는 조직의 정책에 맞춰 입력 글자 수를 관리할 수 있습니다.
Expand Down Expand Up @@ -137,7 +137,7 @@ Use User Attribute to Hide Workflow Menu 토글을 활성화합니다.

* 토글을 활성화하면 `User Attribute`의 `Key`와 `Value`를 한 쌍으로 선택하고 입력할 수 있습니다.
* 여기에 설정된 `Key:Value` 조건과 일치하는 사용자는 사용자 대시보드에 `Workflow` 메뉴가 표시되지 않습니다.
* **예시:** `User Attribute Key`로 '부서코드'를 선택하고, `Value`로 '부서 A'를 입력하면 해당 부서코드 소속의 사용자에게는 `Workflow` 메뉴가 보이지 않습니다.
* **예시**: `User Attribute Key`로 '부서코드'를 선택하고, `Value`로 '부서 A'를 입력하면 해당 부서코드 소속의 사용자에게는 `Workflow` 메뉴가 보이지 않습니다.

### 대리결재 기능 활성화 / 비활성화 옵션 (Allow Delegated Approval)

Expand Down Expand Up @@ -175,7 +175,7 @@ Allow Delegated Approval 스위치
이 옵션을 활성화하는 경우, 명시된 개수만큼 쿼리를 연속적으로 실행한 뒤, 명시된 간격(ms)만큼 대기합니다.
이를 통해 대용량 쿼리 실행에 따르는 DB 부하를 방지할 수 있습니다.

* **Query chunk size** : 1~999,999 사이의 값으로 설정되며, 다수의 쿼리를 해당 개수만큼 나누어 순차적으로 실행하는 기능
* **Query chunk size**: 1~999,999 사이의 값으로 설정되며, 다수의 쿼리를 해당 개수만큼 나누어 순차적으로 실행하는 기능
* 예) 100개의 쿼리가 있을 때, Query chunk size가 10으로 설정되어 있다면 한번에 10개의 Query를 실행합니다.
* **Query throttle interval**: 연속 쿼리 실행 후, 다음 연속 쿼리 실행 간의 간격 (1 ~ 9,999 ms)

Expand All @@ -192,10 +192,10 @@ Redirect to custom page for SQL Requests 토글을 활성화합니다.

* 토글을 활성화한 경우
* Administrator &gt; General &gt; Workflow Configurations 페이지에 커스텀 URL을 입력할 수 있는 필드가 나타납니다.
* User Agent 사용자가 Ledger 테이블에 대해 변경 쿼리를 실행하고 승인 요청을 보낼 경우, `Send Request` 클릭 시 해당 커스텀 URL로 리디렉션되며, 이때 쿼리나 사용자 정보는 전달되지 않습니다.
* User Agent 사용자가 Ledger 테이블에 대해 변경 쿼리를 실행하고 승인 요청을 보낼 경우, `Send Request`를 클릭하면 해당 커스텀 URL로 리디렉션되며 이때 쿼리나 사용자 정보는 전달되지 않습니다.
* 토글을 비활성화한 경우
* Administrator &gt; General &gt; Workflow Configurations 페이지에 커스텀 URL을 입력할 수 있는 필드가 표시되지 않습니다.
* User Agent 사용자가 Ledger 테이블에 대해 INSERT, UPDATE, DELETE 쿼리를 실행하여 워크플로 승인 요청 모달이 표시될 때, `Send Request` 버튼을 클릭하면 기존과 같이 QueryPie 내부의 표준 워크플로 페이지로 이동합니다
* User Agent 사용자가 Ledger 테이블에 대해 INSERT, UPDATE, DELETE 쿼리를 실행하여 워크플로 승인 요청 모달이 표시될 때, `Send Request` 버튼을 클릭하면 기존과 같이 QueryPie 내부의 표준 워크플로 페이지로 이동합니다.

### 워크플로우 Request 타입별 사용자 노출 제어 기능

Expand Down Expand Up @@ -240,12 +240,12 @@ Use DB Privilege Type Based Approval
<img src="/administrator-manual/general/company-management/general/image-20250822-112026.png" alt="image-20250822-112026.png" width="432" />
</figure>

* **Routing Rule Name** : 식별하기 쉬운 라우팅 규칙의 이름을 입력합니다.
* **Condition** : Privilege에 대한 조건을 지정합니다.
* **All Match** : 사용자가 DB Access Request를 상신할 때 지정한 Privilege Type이 모두 같은 종류인 경우 동작하는 조건입니다.
* **Routing Rule Name**: 식별하기 쉬운 라우팅 규칙의 이름을 입력합니다.
* **Condition**: Privilege에 대한 조건을 지정합니다.
* **All Match**: 사용자가 DB Access Request를 상신할 때 지정한 Privilege Type이 모두 같은 종류인 경우 동작하는 조건입니다.
* **Contains**: 사용자가 DB Access Request를 상신할 때 지정한 Privilege Type이 하나라도 지정한 종류를 포함했을 때 동작하는 조건입니다.
* **Requested Privilege Type** : Administrator &gt; Databases &gt; DB Access Control &gt; Privilege Type에 정의되어 있는 Privilege 유형 중 하나를 선택합니다.
* **Approval Rule** : 위 조건이 만족했을 경우 강제할 결재선(Approval Rule)을 지정합니다.
* **Requested Privilege Type**: Administrator &gt; Databases &gt; DB Access Control &gt; Privilege Type에 정의되어 있는 Privilege 유형 중 하나를 선택합니다.
* **Approval Rule**: 위 조건이 만족했을 경우 강제할 결재선(Approval Rule)을 지정합니다.

#### Routing Rule 지정 예시

Expand Down
Loading
Loading