https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71030001/customer/work_design/notice_design/index.html Recent content in 4.3.3 通知の設計 on JP1 Cloud Service 運用統合 利用ガイド Hugo -- gohugo.io ja https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71030001/customer/work_design/notice_design/notice_ex/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71030001/customer/work_design/notice_design/notice_ex/index.html スケジュール、作業項目を起点とした通知条件のユースケースを以下に示します。 各ユースケースの番号をクリックするとユースケースごとの説明に遷移します。 （表）スケジュール・作業項目の通知条件例 ユースケース 起点 通知条件 1 作業項目 作業項目の作成、更新内容を通知する。 ただし作業項目の表示順序のみが変更された場合、通知は行われない。 2 スケジュール スケジュールの担当者変更を通知する。 3 スケジュールの開始5分前と60分前にリマインダーを通知する。 4 定期的な作業にひもづく特定のスケジュールの変更を通知する。 注意事項 スケジュールを起点にする場合は以下に注意してください。 作業項目にひもづくスケジュールの「title」の値は常に空になります。スケジュールの名前を取得するには、「.Context.title」ではなく、「.Context.workitem.name」を参照してください。 作業項目にひもづくスケジュールの場合、担当者の情報は「assignedUsers」に設定されます。また、作業項目にひもづかないスケジュールの場合、担当者の情報は「assignedTo」に設定されます。 このため、通知の本文や宛先に担当者や名前を指定する場合、作業項目にひもづくスケジュールとひもづかないスケジュールで、 Notificationのマニフェストをそれぞれ別々に作成してください。 作業項目管理機能がサポートされる前から通知機能を利用している場合、作業項目管理機能を利用する前に登録済みのマニフェストの通知条件に次の内容を追加して、作業項目の作成や更新による意図しない通知が行われないようにしてください。 - resource: '{{ .GetValue ".Context.workitem" }}'   eq: "" 各ユースケースについての、Notificationのマニフェストファイルの定義例を以下に示します。Notificationのマニフェストファイルの詳細は「Notification、Notifier」を参照してください。 【ユースケース1：作業項目の作成、更新内容を通知する】 作業項目の作成と更新時に、作業項目名や担当者などの情報を通知します。 次に示す定義例では、開始日が空の作業項目の作成と更新時には通知が行われません。このため、次の操作を行った場合、作業項目は作成されますが、通知は行われません。 カレンダーのコピー 作業項目のコピー テンプレートを利用したカレンダーの作成 apiVersion: 1.0 kind: notification type: resource name: sample_notification_work-item label: Notification sample 1 description: Notification regarding create or update work-item  event:   resource: workitem   type: update conditions:   # 作業項目の開始日が設定されていることを確認します。   # neオペレータで空文字("")と比較することで値が設定されたことを確認できます。   # ".Context"のみを条件に使用しているため、   # 作業項目の新規作成時、更新時問わず通知の対象となります。   -      - resource: '{{ .GetValue ".Context.startDate" }}'       ne: "" notifications:   - message:       title: '[{{ .GetValue ".Context.name" }}] has been updated.'       body: |         The work-item {{ .GetValue ".Context.name" }} has been updated.         Information:           planned start time: "{{ .GetValue ".Context.plannedStart" }}"           assignedUsers: "{{ .GetValue ".Context.assignedUsers.name" }}"           assignedGroup: "{{ .GetValue ".Context.assignedGroup.name" }}"     destinations:       - type: groupMember         value: '{{ .GetValue ".Context.assignedGroup.id" }}' 【ユースケース2：スケジュールの担当者変更を通知する】 スケジュールの担当者変更を通知します。 作業項目にひもづくスケジュールと作業項目にひもづかないスケジュールで別々に定義を作成します。 ①作業項目にひもづくスケジュールの場合 apiVersion: 1.0 kind: notification type: resource https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71030001/customer/work_design/notice_design/notice_workflow_ex/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71030001/customer/work_design/notice_design/notice_workflow_ex/index.html ワークフローの任意のタイミングで通知を行う場合の定義例を示します。 通知の"type"が"onDemand"の場合、ワークフローで指定した任意のタイミングで通知を行えます。 通知の内容に、ワークフローのフィールドの値や、Workflowのマニフェストファイルで設定したパラメータを以下により埋め込むことができます。 .GetValueを使用 使用できる値は「（表）Notificationで使用可能なオブジェクト・フィールド」を参照してください。 Ops I提供部品「oi.notify」を使用 Workflowのマニフェストファイルで定義したパラメータを埋め込めます。メッセージ内容や宛先をワークフロー定義で動的に変更することができます。 注意事項 Workflowのマニフェストファイルで定義したnotificationの値は、Notificationのマニフェストファイルで定義したnameの値と一致する必要があります。また、Ops I提供部品「oi.notify」を使用する場合はNotificationのマニフェストファイルに以下のように設定してください。 event.resourceは"workflow"に指定する。 event.typeは"onDemand"に指定する。 conditionsは指定しない。 Workflowのマニフェストファイルで定義した「oi.notify」のパラメータをNotificationのマニフェストファイルに埋め込む場合、次のように指定する。 {{ .OINotify.params.key }} Workflowのマニフェストについては「Workflow」を、Ops I提供部品「oi.notify」については「（表）actionのリスト（Ops I提供部品）」を参照してください。 NotificationとNotifierのマニフェストの詳細については「Notification、Notifier」を参照してください。 Workflowのマニフェストファイル、およびNotificationのマニフェストファイルの定義例を以下に示します。 【ユースケース1：メッセージのタイトルおよび内容の一部をWorkflowのマニフェストファイルに定義する】 再申請の通知内容を、Workflowのマニフェストファイルに定義し、その内容に基づいたNotificationのマニフェストファイルを作成します。 ＜Workflowのマニフェストファイルのtasks定義例＞  notify_vm_wf_02:    action: oi.notify    input:      notification: lend_request_notification      params:        type: 再申請        document: 申し送り事項    next:      - when: <% succeeded() %>        do: next_step      - when: <% failed() %>        do: fail ＜Notificationのマニフェストファイルの定義例＞ apiVersion: 1.0 kind: notification ## Meta data type: resource name: lend_request_notification label: 貸出申請通知 description: 担当者に貸出申請通知を行うマニフェストです https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71030001/customer/work_design/notice_design/notice_playbook_ex/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://itpfdoc.hitachi.co.jp/manuals/JCS/JCSM71030001/customer/work_design/notice_design/notice_playbook_ex/index.html ワークフローでジョブの自動実行をする場合は、自動実行する内容を記述するPlaybookで、通知を行うタイミングを指定できます。通知の"type"は"onDemand"を指定し、通知の内容に、Playbookで設定したパラメータを以下により埋め込むことができます。 Ops I提供部品「opsi.oi.notify」を使用 Playbookで定義したパラメータを埋め込めます。メッセージ内容や宛先をPlaybookの定義で動的に変更することができます。 注意事項 Playbookで定義したnotificationの値は、Notificationのマニフェストファイルで定義したnameの値と一致する必要があります。また、Ops I提供部品「opsi.oi.notify」を使用する場合はNotificationのマニフェストファイルに以下のように設定してください。 event.resourceは指定しない。 event.typeは"onDemand"に指定する。 conditionsは指定しない。 Playbookで定義した「opsi.oi.notify」のパラメータをNotificationのマニフェストファイルに埋め込む場合、次のように指定する。 {{ .OINotify.params.key }} Ops I提供部品「opsi.oi.notify」の実行には認証情報タイプ「OpsI Credential Type」から作成した認証情報が必要です。 「OpsI Credential Type」の「opsi_domain」と「opsi_token」を利用するため、事前に作成し、ジョブテンプレートに設定しておく必要があります。設定方法については「認証情報の登録」を参照してください。 Ops I提供部品「opsi.oi.notify」については「（表）actionのリスト（Playbook用Ops I提供部品）」を参照してください。 NotificationとNotifierのマニフェストの詳細については「Notification、Notifier」を参照してください。 ジョブの自動実行の設定手順については、「ジョブ自動実行の設定手順」を、自動化の画面操作の詳細については「自動化」を参照してください。 Playbook、およびNotificationのマニフェストファイルの定義例を以下に示します。 【ユースケース1：メッセージのタイトルおよび内容の一部をPlaybookに定義する（宛先タイプ：groupMember）】 Notificationのマニフェストファイルを作成し、通知内容をPlaybookのマニフェストファイルに定義します。 この例では宛先のタイプはgroupMemberです。 ＜Playbookの定義例＞ - hosts: localhost   gather_facts: no   tasks:     - name: Send notification       opsi.oi.notify:         notification: notification_sample         params:           title: VM貸出の再申請通知           body: VM貸出の再申請通知が到着しています。申し送り事項を確認の上、対応お願いします。           path: /sys_request/workflow/workflow_list           group: test_group ＜Notificationのマニフェストファイルの定義例＞ apiVersion: 1.0 kind: notification type: resource name: notification_sample label: notification event:   type: onDemand notifications:   - message:       title: '{{ .OINotify.params.title }}'       body: '{{ .OINotify.params.body }}'       referTo: '{{ .System.domain }}{{ .OINotify.params.path }}'       severity: Information     destinations:       - type: groupMember         value: '{{ .OINotify.params.group }}'         enableSystemNotification: false         notifiers:           - opsi_default_email_notifier 【ユースケース2：メッセージのタイトルおよび内容の一部をPlaybookに定義する（宛先タイプ：email）】 Notificationのマニフェストファイルを作成し、通知内容をPlaybookのマニフェストファイルに定義します。 この例では宛先のタイプはemailです。 ＜Playbookの定義例＞ - hosts: localhost