> For the complete documentation index, see [llms.txt](https://ia-cloud.gitbook.io/cloudia-manual/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ia-cloud.gitbook.io/cloudia-manual/administrator/setting/alarm-setting.md).

# 알림 설정

## 알림 설정

**알림 설정** 메뉴에서는 `메일 전송 설정(SMTP)`와 `웹훅 설정` 탭을 통해 이벤트 트리거에서 사용할 알림 채널 설정을 관리할 수 있습니다.

기본 탭은 `메일 전송 설정(SMTP)`이며, `웹훅 설정` 탭에서는 목록 기반으로 웹훅 설정을 관리합니다.

## 메일 전송 설정(SMTP)

#### 화면 개요

`메일 전송 설정(SMTP)` 탭은 SMTP 설정의 조회 화면입니다. 상단 도구 영역에는 `편집`, `연결 테스트`, `설정 초기화` 버튼이 표시됩니다.

`편집` 버튼은 항상 사용할 수 있으며, 설정이 없는 초기 상태에서는 편집 화면으로 이동해 SMTP 설정을 최초 등록할 수 있습니다. 설정이 없는 경우에는 본문에 `편집 버튼을 눌러 설정을 추가해주세요.` 문구가 표시되고, `연결 테스트`, `설정 초기화` 버튼은 비활성화됩니다.

설정이 존재하면 SMTP 정보가 읽기 전용으로 표시됩니다.

#### 주요 작업

* `편집`: SMTP 설정 편집 화면으로 이동합니다. 최초 등록과 기존 설정 변경에 공통으로 사용합니다.
* `연결 테스트`: 현재 저장된 SMTP 설정으로 테스트 메일 발송을 수행합니다. SMTP 설정이 존재할 때만 사용할 수 있습니다.
* `설정 초기화`: 저장된 SMTP 설정을 삭제합니다. SMTP 설정이 존재할 때만 사용할 수 있습니다.

#### 조회 화면 표시 항목

| 항목               | 설명                                             |
| ---------------- | ---------------------------------------------- |
| **SMTP 서버명**     | 현재 저장된 SMTP 서버 주소를 표시합니다.                      |
| **SMTP 포트**      | 현재 저장된 SMTP 포트 번호를 표시합니다.                      |
| **발신자 이메일 주소**   | 현재 저장된 발신자 계정 주소를 표시합니다.                       |
| **발신자 이메일 비밀번호** | 실제 비밀번호 대신 `********`로 표시합니다.                  |
| **보안 연결**        | `사용 안 함`, `SSL`, `StartTLS` 중 현재 저장된 값을 표시합니다. |

### SMTP 편집

#### 화면 개요

SMTP 편집 화면의 제목은 `메일 전송 설정(SMTP) 편집`입니다. 이 화면은 기존 SMTP 설정 편집뿐 아니라, 설정이 없는 상태에서 최초 등록할 때도 동일하게 사용합니다.

#### 기본 정보

* **SMTP 서버명**: 발신(SMTP) 서버 주소를 입력합니다. 툴팁에는 `smtp.example.com` 형식 예시와 `http/https 없이 호스트명 또는 IP만 입력` 안내가 표시됩니다.
* **SMTP 포트**: SMTP 접속 포트 번호를 입력합니다.
* **발신자 이메일 주소**: 메일을 보내는 계정(From) 주소를 입력합니다.
* **발신자 이메일 비밀번호**: 발신자 계정의 로그인 비밀번호 또는 앱 비밀번호를 입력합니다.
* **보안 연결**: `사용 안 함`, `SSL`, `StartTLS` 중 하나를 선택합니다.

#### 입력 필드 유효성

| 필드               | 허용 값                        | 검증 규칙                                                                                                                 | 비고                                                                          |
| ---------------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| **SMTP 서버명**     | 호스트명 또는 IP 형식 문자열           | 필수입니다. `http://`, `https://` 같은 프로토콜은 허용되지 않습니다. 영문자 또는 숫자로 시작하고 끝나야 하며, 점(`.`)으로 구분된 세그먼트 사이에서 하이픈(`-`)을 사용할 수 있습니다. | 공란일 때는 `ex) smtp.example.com` 도움말이 표시됩니다.                                   |
| **SMTP 포트**      | `1` 이상 `65535` 이하의 정수       | 필수입니다. 숫자만 입력할 수 있습니다.                                                                                                | `0`, 음수, 소수, 문자 입력은 허용되지 않습니다.                                              |
| **발신자 이메일 주소**   | 이메일 주소 형식 문자열               | 필수입니다. 유효한 이메일 형식이어야 합니다.                                                                                             | 발송 계정입니다.                                                                   |
| **발신자 이메일 비밀번호** | 문자열                         | 필수입니다.                                                                                                                | 편집 화면에서는 기존 비밀번호가 `********`로 표시되며, 변경하려면 새 비밀번호를 다시 입력해야 합니다. 저장 시 암호화됩니다. |
| **보안 연결**        | `사용 안 함`, `SSL`, `StartTLS` | 필수입니다. 제공된 값 중 하나를 선택합니다.                                                                                             | `SSL`은 일반적으로 `465` 포트, `StartTLS`는 일반적으로 `587` 포트를 사용합니다.                   |

#### 편집 조건

* `SMTP 서버명`, `SMTP 포트`, `발신자 이메일 주소`, `발신자 이메일 비밀번호`가 모두 유효해야 합니다.
* 기존 값과 비교해 변경된 내용이 있어야 합니다.
* SMTP 편집 중이 아니어야 합니다.

#### 사용 시 참고

* `SMTP 서버명`, `SMTP 포트`, `발신자 이메일 주소`, `보안 연결` 중 하나라도 바뀌면 `편집` 버튼 활성화 조건에 반영됩니다.
* 편집 화면에서는 `발신자 이메일 비밀번호`를 새로 입력한 경우에도 변경사항으로 간주합니다.
* 저장 후 “메일 전송 설정(SMTP) 편집 완료” 메세지가 표시됩니다.
* 설정이 완료되면 `연결 테스트` 기능으로 정상 작동 여부를 확인할 수 있습니다.

### SMTP 연결 테스트

#### 화면 개요

`연결 테스트` 버튼을 클릭하면 `연결 테스트` 모달이 열립니다. 모달 하단 확인 버튼 라벨은 `발송`입니다.

모달 상단에는 다음 안내 문구가 순서대로 표시됩니다.

* `메일을 발송하기까지 최대 10초가 소요될 수 있습니다.`
* `메일 발송에 실패한 경우, 설정한 값이 정확한지 확인해주세요.`

#### 입력 항목

* **수신 이메일 주소**: 테스트 메일을 받을 이메일 주소입니다.

#### 입력 필드 유효성

| 필드            | 허용 값          | 검증 규칙                     | 비고                               |
| ------------- | ------------- | ------------------------- | -------------------------------- |
| **수신 이메일 주소** | 이메일 주소 형식 문자열 | 필수입니다. 유효한 이메일 형식이어야 합니다. | 유효한 값이 입력된 경우에만 `발송` 버튼이 활성화됩니다. |

#### 테스트 절차

1. SMTP 설정이 저장된 상태에서 `연결 테스트` 버튼을 클릭합니다.
2. `수신 이메일 주소`를 입력합니다.
3. `발송` 버튼을 클릭합니다.
4. 성공 시 `연결 테스트를 위한 메일 발송되었습니다.` 메시지가 표시됩니다.
5. 실패 시 오류 메시지가 표시되며, 현재 SMTP 설정값을 다시 확인해야 합니다.

> 💡 **참고:** 스팸함으로 분류될 수 있으므로, 메일이 보이지 않을 경우 스팸함을 확인하세요.

### SMTP 설정 초기화

기존 SMTP 설정을 삭제하고 메일 알람 기능을 비활성화할 수 있습니다. `설정 초기화` 버튼을 클릭하면 `설정 초기화` 모달이 열립니다. 모달 본문에는 `모든 설정을 초기화하시겠습니까?` 문구가 표시되며, 확인 버튼 라벨은 `초기화`입니다.

#### 초기화 절차

1. SMTP 설정이 저장된 상태에서 `설정 초기화` 버튼을 클릭합니다.
2. 확인 후 `초기화` 버튼을 클릭합니다.
3. 성공 시 `초기화되었습니다.` 메시지가 표시됩니다.
4. 화면은 초기 상태로 돌아가며 `편집 버튼을 눌러 설정을 추가해주세요.` 문구가 다시 표시됩니다.

> ⚠️ **주의:**
>
> * 초기화 후에는 이메일 알람이 전송되지 않습니다.
> * 초기화 작업은 되돌릴 수 없습니다.

#### 사용 시 참고

* SMTP 설정 후에는 반드시 `연결 테스트`를 통해 정상 동작 여부를 확인해야 합니다.
* Gmail 등 외부 메일 서비스를 사용하는 경우 **앱 비밀번호**를 발급받아 입력해야 할 수 있습니다.
* 관리자 이메일 주소가 올바르게 등록되어야 알람을 받을 수 있습니다.
* SMTP 설정이 올바르지 않으면 이벤트 감지 시에도 이메일 알람이 발송되지 않습니다.

## 웹훅 설정

#### 화면 개요

`웹훅 설정` 탭은 목록 기반 관리 화면입니다. 상단 도구 영역에는 `생성`, `편집`, `삭제`, `연결 테스트` 버튼이 표시됩니다.

`편집`, `삭제`, `연결 테스트`는 웹훅을 한 건 선택했을 때만 사용할 수 있습니다.

#### 주요 작업

* `생성`: 웹훅 생성 화면으로 이동합니다.
* `편집`: 선택한 웹훅 설정 편집 화면으로 이동합니다.
* `삭제`: 선택한 웹훅 설정 삭제 확인 모달을 엽니다.
* `연결 테스트`: 선택한 웹훅 설정 기준으로 테스트 알림을 발송합니다.

#### 목록 컬럼

| 컬럼        | 설명                                     |
| --------- | -------------------------------------- |
| **이름**    | 클릭하면 웹훅 설정 상세 화면으로 이동하는 컬럼입니다.         |
| **ID**    | 웹훅 설정 식별자를 표시하는 컬럼입니다.                 |
| **설명**    | 웹훅 설명을 표시하는 컬럼입니다.                     |
| **채널 타입** | 채널 타입을 `Slack` 또는 `Teams`로 표시하는 컬럼입니다. |
| **생성 일시** | 생성 시각을 로컬 시간 기준으로 표시하는 컬럼입니다.          |

### 웹훅 설정 상세

#### 상세 정보

* **이름**: 웹훅 이름을 표시합니다.
* **ID**: 웹훅 식별자를 표시합니다.
* **설명**: 웹훅 설명을 표시합니다.
* **채널 타입**: `Slack` 또는 `Teams`로 표시합니다.
* **생성 일시**: 생성 시각을 로컬 시간으로 표시합니다.

### 웹훅 생성

#### 화면 개요

웹훅 생성 화면의 제목은 `웹훅 설정 생성`입니다. 화면에는 `이름`, `설명`, `채널 타입`, `웹훅 URL` 입력 항목이 표시됩니다.

#### 기본 정보

* **이름**: 웹훅 이름을 입력합니다.
* **설명**: 웹훅 설명을 입력합니다.
* **채널 타입**: `Slack`, `Teams` 중 하나를 선택합니다.
* **웹훅 URL**: 웹훅 호출 주소를 입력합니다.

#### 입력 필드 유효성

| 필드         | 허용 값                           | 검증 규칙                                         | 비고                                       |
| ---------- | ------------------------------ | --------------------------------------------- | ---------------------------------------- |
| **이름**     | 영문 대/소문자, 숫자, `-`, `_` 조합의 문자열 | 필수입니다. 30자 이내로 입력합니다. 공백과 다른 특수문자는 허용되지 않습니다. | 생성/편집 공통 이름 규칙입니다.                       |
| **설명**     | 문자열                            | 200자 이내로 입력합니다.                               | 생성/편집 공통 설명 규칙입니다.                       |
| **채널 타입**  | `Slack`, `Teams`               | 필수입니다. 제공된 값 중 하나를 선택합니다.                     | 생성 화면에서만 선택합니다.                          |
| **웹훅 URL** | 문자열                            |                                               | 생성 화면에서만 입력하며, 저장 후 다시 조회하거나 편집할 수 없습니다. |

#### 생성 조건

* `이름`이 유효해야 합니다.
* `채널 타입`이 선택되어야 합니다.
* 웹훅 생성 중이 아니어야 합니다.

> ⚠️ **주의:**
>
> * 채널 타입, 웹훅 URL은 생성 후에 변경할 수 없습니다.
> * 웹훅 URL은 저장 후 상세 화면에서도 표시되지 않습니다. 이름/설명에 용도를 명확하게 지정하세요.

#### 사용 시 참고

* 저장 후 “웹훅 설정 생성 완료” 메시지가 표시됩니다.
* 설정이 완료되면 `연결 테스트` 기능으로 정상 작동 여부를 확인할 수 있습니다.

### 웹훅 편집

#### 화면 개요

웹훅 편집 화면의 제목은 `웹훅 설정 편집`입니다. 편집 화면에서는 `이름`, `설명`만 수정할 수 있습니다.

#### 기본 정보

* **이름**: 웹훅 이름을 입력합니다.
* **설명**: 웹훅 설명을 입력합니다.

#### 입력 필드 유효성

| 필드     | 허용 값                           | 검증 규칙                                         | 비고                 |
| ------ | ------------------------------ | --------------------------------------------- | ------------------ |
| **이름** | 영문 대/소문자, 숫자, `-`, `_` 조합의 문자열 | 필수입니다. 30자 이내로 입력합니다. 공백과 다른 특수문자는 허용되지 않습니다. | 생성/편집 공통 이름 규칙입니다. |
| **설명** | 문자열                            | 200자 이내로 입력합니다.                               | 생성/편집 공통 설명 규칙입니다. |

#### 편집 조건

* `이름`이 유효해야 합니다.
* 기존 값과 비교해 변경된 내용이 있어야 합니다.
* 웹훅 편집 중이 아니어야 합니다.

#### 사용 시 참고

* 저장 후 “웹훅 설정 편집 완료” 메시지가 표시됩니다.
* 설정이 완료되면 `연결 테스트` 기능으로 정상 작동 여부를 확인할 수 있습니다.

### 웹훅 삭제

#### 화면 개요

웹훅 삭제 모달의 제목은 `웹훅 설정 삭제`입니다. 모달 본문에는 `웹훅 설정 삭제하시겠습니까?` 문구가 표시되며, 확인 버튼 라벨은 `삭제`입니다.

#### 삭제 절차

1. 삭제하려는 웹훅을 선택합니다.
2. `삭제` 버튼을 클릭하여 웹훅 설정 삭제 확인창으로 이동합니다.
3. 웹훅 설정 내용을 확인 후, `삭제` 버튼을 클릭합니다.
4. 삭제 후 “웹훅 설정 삭제 - 삭제되었습니다.” 메시지가 표시됩니다.

> ⚠️ **주의:** 이벤트 트리거의 알림 채널로 사용 중인 웹훅 설정은 삭제할 수 없습니다.

### 웹훅 연결 테스트

웹훅 설정이 완료된 후 `연결 테스트` 로 실제 웹훅 메시지가 정상적으로 발송되는지 확인합니다.

#### 테스트 절차

1. 확인하려는 웹훅 설정을 선택합니다.
2. `연결 테스트` 버튼을 클릭합니다.
3. `웹훅 연결 테스트` 확인 창에서 `연결` 버튼을 클릭합니다.
4. 성공 시 `연결 테스트를 위한 웹훅 알림이 발송되었습니다.` 메시지가 표시됩니다.
5. 실패 시 오류 메시지가 표시되며, 해당 웹훅 설정값을 다시 확인해야 합니다.

> 💡 **참고:** 테스트 발송은 수신까지 약 10초 정도 소요될 수 있습니다.
