2. 機能別の参考資料¶

Senju Service Managerを使用するにあたって、参考となる資料を機能別に記載します。

2.1 ステータス一覧¶

レコードのステータスを示す値が自動設定される項目について記します。

2.2 メール送信仕様まとめ¶

Senju Service Manager で送信するメールについての仕様を本章にまとめます。

2.2.1 送信メール一覧¶

Senju Service Manager ではレコードの情報を引用したメールを送信することができます。 送信できるメールについては以下の一覧を参照してください。

2.2.2 制限事項一覧¶

メール送信機能の全般に関係する制限事項を以下に記します。

2.2.2.1 共通（手動送信メール、自動送信メール、コマンド送信メール、エージェント送信メール）¶

2.2.2.2 手動送信メール¶

2.2.2.3 自動送信メール¶

2.2.2.4 コマンド送信メール（申請状況通知コマンド）¶

2.2.2.5 コマンド送信メール（自動メール通知コマンド）¶

2.2.2.6 コマンド送信メール（イベント連携）¶

2.2.2.7 コマンド送信メール（データ登録コマンド）¶

2.2.2.8 エージェント送信メール¶

2.2.3 置換文字列一覧（メールテンプレート）¶

[管理者メニュー > 機能別 > メールテンプレート> メールテンプレート]では以下の置換文字列を使用できます。

2.2.4 置換文字列一覧（メールテンプレート(自動送信)）¶

[管理者メニュー > 機能別 > メールテンプレート> メールテンプレート(自動送信)]では以下の置換文字列を使用できます。

2.2.4.1 自動送信メール（お知らせ：登録、更新）¶

以下の画面・メールアクションを選択した場合の置換項目を記します。

2.2.4.2 自動送信メール（エスカレーション）¶

以下の画面・メールアクションを選択した場合の置換項目を記します。

2.2.4.3 自動送信メール（プロセス管理：承認依頼～却下、問合せ～完了、一時停止解除実施依頼(通知)）¶

以下の画面・メールアクションを選択した場合の置換項目を記します。

2.2.4.4 自動送信メール（ナレッジ：承認依頼～却下）¶

以下の画面・メールアクションを選択した場合の置換項目を記します。

2.2.4.5 自動送信メール（申請状況通知コマンド）¶

以下の画面・メールアクションを選択した場合の置換項目を記します。

2.2.4.6 自動送信メール（自動メール通知コマンド）¶

以下の画面・メールアクションを選択した場合の置換項目を記します。

2.2.4.7 自動送信メール（プロセスタスクリストエスカレーション）¶

以下の画面・メールアクションを選択した場合の置換項目を記します。

2.2.4.8 自動送信メール（脆弱性情報：脆弱性情報登録、脆弱性情報更新、脆弱性情報確認依頼通知）¶

以下の画面・メールアクションを選択した場合の置換項目を記します。

2.2.4.9 自動送信メール（パスワード再発行）¶

以下の画面・メールアクションを選択した場合の置換項目を記します。

2.2.4.10 自動送信メール（ログイン：二要素認証）¶

以下の画面・メールアクションを選択した場合の置換項目を記します。

2.2.5 ケーススタディ（メール送信フロー）¶

Senju Service Manager で送信するメールの送信タイミングと送信先のフローを以下に記します。

2.2.5.1 手動メール送信¶

2.2.5.2 エージェント送信¶

2.2.5.3 問合せ・エスカレーション¶

2.2.5.4 問合せ・エスカレーション：補足「未回答で完了」¶

2.2.5.5 承認フロー¶

2.2.5.6 承認フロー：補足「却下」¶

2.2.5.7 承認フロー：補足「差戻し」¶

2.2.5.8 承認フロー：補足「承認フロー完了通知項目」¶

2.2.5.9 申請者／現在対応者にコマンドでメール送信¶

2.2.5.10 （自動メール通知機能）コマンドでメール通知¶

2.2.5.11 （自動メール通知機能）コマンドでクローズメール通知¶

「2.2.5.10 （自動メール通知機能）コマンドでメール通知」に引き続きの操作です。

2.2.6 ケーススタディ（自動メール通知ルートの適用）¶

自動メール通知機能で自動メール通知ルートがプロセスのレコードに対してどのように適用されるか、以下に記します。

2.2.6.1 基本仕様¶

• 適用処理はプロセスのレコードの新規登録／更新時に行います。(※1)

• 新規登録／更新時にはプロセスのレコードが、自動メール通知適用設定に紐付いた自動メール通知条件設定に合致するか判定を行います。（図中1の処理）(※1)

• 判定は自動メール通知適用設定の優先順位で行われます。

• 合致する場合、自動メール通知適用設定に紐付いた自動メール通知ルートをプロセスのレコードに適用します。（図中2の処理）

• 一度に適用される自動メール通知ルートは最大1件です。

2.2.6.2 自動メール通知ルートが適用されていた場合の仕様¶

• 既にプロセスのレコードに自動メール通知ルートが適用されていた場合...

  • 自動メール通知適用設定に紐付いたルートと適用済みのルートが同じ場合、適用済みのルートをそのまま使用します。

  • 自動メール通知適用設定に紐付いたルートと適用済みのルートが異なる場合、適用済みのルートが紐付いたルートに切り替わります。（図中3）

• プロセスのレコードに適用された自動メール通知ルートは履歴管理され、ルートがどこまで進行したか（メール送信が行われたか）を、適用されたすべてのルートに対して保持します。（図中4）(※1)

• プロセスのレコードを更新し、以前に適用されていた自動メール通知ルートが再度適用された場合、ルートの進行状況は引き継がれます。（既にメール送信が行われていたルートNoに対してメール送信は行われません）

※ただし、「通知種別2」を設定した場合はルートの進行状況が引き継がれません。(既にメール送信が行われていたルートNoに対しても最初のルートNoからメール送信を行います) (※1)

• プロセスのレコードを更新し、合致する自動メール通知条件が存在しない場合、適用中の自動メール通知ルートを解除します。（図中5）(※1)

2.2.7 証明書のインストール（SMTPS認証によるメール送信用の設定）¶

SMTPSを使用するためには、CCFSP WEBサーバーに証明書をインストールする必要があります。 ここでは、証明書のインストール手順を説明します。

まず、インストールする証明書を用意してください。

CCFSP WEBサーバーにログインし、用意した証明書を任意のフォルダにコピーします。

コピーした証明書を選択し、右クリックして表示されるコンテキストメニューより、「証明書のインストール」を選択すると、証明書画面が表示されます。

証明書画面から、「証明書のインストール」ボタンをクリックすると、証明書のインポートウィザード画面が表示されます。

「次へ」をクリックします。

証明書ストアの選択から、「証明書をすべて次のストアに配置する」を選択し、「参照」をクリックすると、証明書ストアの選択ダイアログが表示されます。

「物理ストアを表示する」チェックボックスにチェックを入れ、「信頼されたルート証明機関＞ローカル コンピュータ」を選択し、「OK」をクリックします。

証明書ストアの画面にて、「次へ」をクリックします。

証明書のインポートウィザードの完了の画面で、「完了」をクリックし、インポートウィザード画面を終了します。 最後に証明書画面の「OK」をクリックして、証明書画面を閉じます。

以上で、証明書のインストールは完了です。

2.3 構成アイテム（構成管理）仕様まとめ¶

2.3.1 時制（表示形式）仕様¶

構成アイテム（構成管理）ではレコードの状態を3つの時制（最新の構成、現在の構成、全ての履歴）で管理します。 Senju Service Manager 上ではこの時制を「表示対象」として画面表記します。

2.3.1.1 表示対象の説明¶

2.3.1.2 表示対象の関連イメージ¶

構成管理の表示対象の関連イメージを以下に記します。

※Senju Service Manager のシステム日付は2016/6/1の状態

2.3.2 レコードの登録パターン¶

構成アイテム（構成管理）のレコードの登録はWeb画面、データ登録コマンド（sjSPU_ImportData.exe）で行うことができます。

2.3.2.1 適用処理が必要なパターン¶

構成アイテム（構成管理）のレコードの登録パターンの内、適用処理（構成管理反映コマンド（sjSPB_ReflectCI.exe））の実行が必要なものについて以下に記します。

2.3.2.2 適用処理が不要なパターン¶

構成アイテム（構成管理）のレコードの登録パターンの内、適用処理（構成管理反映コマンド（sjSPB_ReflectCI.exe））の実行が不要なパターンについて以下に記します。

2.3.3 ケーススタディ（レコードの登録パターン）¶

「2.3.2 レコードの登録パターン」について、一連の流れを以下に記します。

2.3.3.1 Web画面から新規予定起票～適用まで¶

2.3.3.2 Web画面から変更予定起票～適用まで¶

2.3.3.3 Web画面から削除予定起票～適用まで¶

2.3.3.4 コマンドから承認不要の新規予定を起票～適用まで¶

2.3.3.5 コマンドから承認不要の変更予定を起票～適用まで¶

「2.3.3.1 Web画面から新規予定起票～適用まで」からの引き続きの流れです。

2.3.3.6 コマンドから承認不要の削除予定を起票～適用まで¶

「2.3.3.2 Web画面から変更予定起票～適用まで」からの引き続きの流れです。

2.3.3.7 コマンドから新規反映にて現在の構成に即反映¶

2.3.3.8 コマンドから変更反映にて現在の構成に即反映¶

・変更予定が起票されていない構成アイテムの場合

・変更予定が起票されている構成アイテムの場合

以下、特殊なケースについて説明します。

「現在の構成」及び「最新の構成」で関連項目に関連付られている構成アイテムが存在する状態で

変更反映により該当の構成アイテムとの関連付けを解除した場合、「最新の構成」では「追加」と

して表示されます。

「最新の構成」は、該当構成アイテムと関連付けされている状態で、変更予定起票がされている

ため、「現在の構成」の状態に応じて自動的に変更されます。

逆に、変更反映により「現在の構成」に新たに関連付けが登録された場合、変更予定が起票されて

いる「最新の構成」では該当の構成アイテムが「解除」として表示されます。

2.3.3.9 コマンドから削除反映にて現在の構成に即反映¶

2.3.4 レコードの紐づけ仕様¶

Senju Service Manager で管理するレコードから構成アイテム（構成管理）のレコードを紐づける項目の仕様を以下に記します。

2.3.4.1 接続先機器と接続機器（構成管理間の紐づき）¶

構成管理の接続先機器は構成アイテム（構成管理）のレコードに対して一方向の紐づけを行います。関連先のレコードからは接続機器項目で関連元のレコードを確認することができます。 ただし、接続先機器1に対しては接続機器1が紐づけられます。そのため、例えば接続先機器1に対して接続機器2が紐づくことはありません。

2.3.4.2 関連機器（構成管理間の紐づき）¶

構成管理の関連機器項目は構成アイテム（構成管理）のレコードに対して一方向の紐づけを行います。関連先のレコードから関連元のレコードを確認することはできません。

2.3.4.3 関連構成（構成管理間の紐づき）¶

構成管理の関連構成項目は構成アイテム（構成管理）のレコードに対して双方向の紐づけを行います。 関連先のレコードから関連元のレコードの紐づけは本項目から確認できます。 ただし、関連構成1に対してのみは関連構成1が紐づけられます。そのほかの関連構成2A～2Eに対しては関連構成2A～2Eのいずれかを紐づけることができます。

2.3.4.4 関連構成（プロセス ⇒ 構成管理の紐づき）¶

プロセス管理および簡易プロセス（問合せ・申請）の関連構成1～4項目は構成アイテム（構成管理）の現在の構成へ、一方向の紐づけを行います。

2.3.4.5 申請対象機器（構成管理 ⇔ プロセス間の紐づき）¶

プロセス管理の申請対象機器項目は構成アイテム（構成管理）の予定を承認申請する時に使用する項目です。本項目に構成アイテム（構成管理）の最新の構成のレコードを登録し、承認することによって現在の構成への反映準備が完了します。

2.3.4.6 関連要員（構成管理⇔要員管理の紐づき）¶

構成管理の関連要員項目は要員管理の要員に対して一方的に紐づけを行います。

2.3.4.7 関連構成品目辞書（構成管理⇒構成品目辞書管理の紐づき）¶

構成管理の関連構成品目辞書項目は構成品目辞書管理のレコードに対して一方的に紐づけを行います。

2.3.5 自動集計機能¶

構成管理では接続先機器項目（「2.3.4.1 接続先機器と接続機器（構成管理間の紐づき）」参照）を使用することによって、階層間の自動集計機能を提供します。

上記図のように、「ラック」「コンセント」「サーバー」という構成アイテムのグループ（画面）を作成し、最上位階層に「ラック」、第二階層に「コンセント」、第三階層に「サーバー」という階層を定義して構成アイテム（構成管理）の親子関係を管理することができます。

2.3.5.1 機器階層管理による自動計算用の項目¶

以下に自動集計用の構成アイテム（構成管理）の項目を記します。

2.4 外部チェック機能のWEBAPI仕様まとめ¶

Senju Service Manager の外部チェック機能で使用するWEBAPIの仕様を本章にまとめます。

2.4.1 外部チェック機能の処理フロー¶

2.4.2 チェックAPI（貴社で作成いただく場合）¶

2.4.2.1 処理概要（必要な機能）¶

• Senju Service Managerからのチェック要求を受けて、公開ビューを利用しチケット内容のチェックを行う。
• チェック処理に時間がかからない場合は、チェック結果を返却する。
• チェック処理に時間がかかる場合は「チェック未完了」のステータスを返却し、チェック完了後に「チェック結果登録API」を呼び出す。

2.4.2.2 リクエストURI¶

http://[任意のURI]

2.4.2.3 入力インターフェース¶

• HTTPメソッド：POST
• データ形式 ：XML
• 文字コード ：UTF-8
• パラメータ ：下表参照

2.4.2.3.1 Senju Service Managerが送信するリクエストの例¶

• 制御情報「外部チェックリクエスト送信設定」が「クライアントから送信する」の場合

  <?xml version='1.0' encoding='UTF-8'?>
  <wf_check_input>
      <data_type>01000001</data_type>
      <process_insert_no>0100000000000001</process_insert_no>
      <system_name>SSM初期システム</system_name>
      <type_name>種別001</type_name>
      <wf_status>2</wf_status>
      <wf_route_name>承認フロールート</wf_route_name>
      <wf_route_no>2</wf_route_no>
  </wf_check_input> 
  

  - 制御情報「外部チェックリクエスト送信設定」が「WEBサーバーから送信する」の場合

  <?xml version='1.0' encoding='UTF-8'?>
  <wf_check_input>
      <data_type>01000001</data_type>
      <process_insert_no>0100000000000001</process_insert_no>
      <system_name>SSM初期システム</system_name>
      <type_name>種別001</type_name>
      <wf_status>2</wf_status>
      <wf_route_name>承認フロールート</wf_route_name>
      <wf_route_no>2</wf_route_no>
      <web_host_identifier>{976A4B0B-9677-425D-AE86-9942148E3CFD}</web_host_identifier>
  </wf_check_input>
  

2.4.2.4 出力インターフェース¶

• データ形式 ：XML
• 文字コード ：UTF-8
• パラメータ ：下表参照

2.4.2.4.1 HTML Responseヘッダの例¶

SSMが所属するドメインと異なるドメインにチェック用APIが設置される場合、

チェックAPI側で、異なるドメインからのアクセスを許可する必要があります。

Responseヘッダに、"Access-Control-Allow-Origin"を追加してください。

• 他のドメインからのアクセスを許可する場合(ドメイン指定なし)

  Access-Control-Allow-Origin: *

• 指定したドメインからのアクセスを許可する場合(ドメイン指定あり)

  Access-Control-Allow-Origin: http://ccfsphost.nri.co.jp/(許可するドメイン名)

2.4.2.4.2 チェックAPIが返却するレスポンスの例¶

• チェックOKの場合

  <?xml version='1.0' encoding='UTF-8'?>
  <wf_check_output>
      <wf_check_status>1</wf_check_status>
      <wf_check_result>0</wf_check_result>
      <wf_check_detail>チェック OKです。</wf_check_detail>
  </wf_check_output>
  

• チェックNGの場合

  <?xml version='1.0' encoding='UTF-8'?>
  <wf_check_output>
      <wf_check_status>1</wf_check_status>
      <wf_check_result>1</wf_check_result>
      <wf_check_detail>チェック NGです。</wf_check_detail>
  </wf_check_output>
  

• チェック未完了の場合

  <?xml version='1.0' encoding='UTF-8'?>
  <wf_check_output>
      <wf_check_status>0</wf_check_status>
      <wf_check_result></wf_check_result>
      <wf_check_detail>チェック中です。</wf_check_detail>
  </wf_check_output>
  

2.4.3 チェック結果登録API（SSMで提供するAPI）¶

2.4.3.1 処理概要¶

チェックAPIからの要求を受け、チェック結果をSenju Service Managerのデータベースへ書き込む。

2.4.3.2 リクエストURI¶

http://{SSMWEBサーバー}/ccfsp/Service/CheckResultRegist/CheckResultRegist.asp

2.4.3.3 入力インターフェース¶

• HTTPメソッド：POST
• データ形式 ：XML
• 文字コード ：UTF-8

2.4.3.3.1 チェックAPIが送信するリクエストの例¶

• チェックOKの場合

  <?xml version='1.0' encoding='UTF-8'?>
  <sm_ex_wf_check_result_regist_request>
  <data_type>01000001</data_type>
  <process_insert_no>0100000000000001</process_insert_no>
  <wf_route_name>承認フロールート</wf_route_name>
  <wf_route_no>2</wf_route_no>
  <wf_check_result>0</wf_check_result>
  <wf_check_detail>チェックOKです。</wf_check_detail>
  </sm_ex_wf_check_result_regist_request>
  

• チェックNGの場合

  <?xml version='1.0' encoding='UTF-8'?>
  <sm_ex_wf_check_result_regist_request>
  <data_type>01000001</data_type>
  <process_insert_no>0100000000000001</process_insert_no>
  <wf_route_name>承認フロールート</wf_route_name>
  <wf_route_no>2</wf_route_no>
  <wf_check_result>1</wf_check_result>
  <wf_check_detail>テキスト1が未入力です。</wf_check_detail>
  </sm_ex_wf_check_result_regist_request>
  

2.4.3.4 出力インターフェース¶

• データ形式 ：XML
• 文字コード ：UTF-8
• パラメータ ：下表参照

2.4.3.4.1 結果登録APIが返却するレスポンスの例¶

• 正常終了の場合

  <?xml version='1.0' encoding='UTF-8'?>
  <sm_ex_wf_check_result_regist_responce>
  <result>0</result>
  <detail></detail>
  </sm_ex_wf_check_result_regist_responce>
  

• DB接続エラーの場合

  <?xml version='1.0' encoding='UTF-8'?>
  <sm_ex_wf_check_result_regist_responce>
  <result>1</result>
  <detail>データベースの接続中にエラーが発生しました</detail>
  </sm_ex_wf_check_result_regist_responce>
  

2.5 Webhook送信仕様まとめ¶

Senju Service Manager のWebhook送信についての仕様を本章にまとめます。

2.5.1 置換文字列一覧¶

[管理者メニュー > 機能別 > Webhook連携 > 送信メッセージテンプレート]では以下の置換文字列を使用できます。

2.6 レスポンス受信アクションのWEBAPI仕様まとめ¶

Senju Service Manager のレスポンス受信アクションで使用するWEBAPIの仕様を本章にまとめます。

Webhook連携により実行された外部WEBAPIのレスポンスにアクションを指示することで、Senju Service Managerに処理を行わせることができます。

外部WEBAPIのレスポンスで指示できるアクションは以下の通りです。

1) プロセスを更新する

2) 履歴情報を記録する

3) ダイアログを表示する

4) トリガーアクションをキャンセルする

2.6.1 レスポンス受信アクションの処理フロー¶

以下に各アクションの処理フローを記載します。

※アクションを組み合わせた指示を行うことも可能です。

2.6.1.1 プロセスを更新する・履歴情報を記録する¶

• Webhook○○前の場合

• Webhook○○後の場合

2.6.1.2 ダイアログを表示する¶

• Webhook○○前の場合

• Webhook○○後の場合

2.6.1.3 トリガーアクションをキャンセルする¶

2.6.2 外部WEBAPI¶

2.6.2.1 処理概要（必要な機能）¶

Senju Service Managerに行わせるアクションをレスポンスで返却する。

2.6.2.2 リクエストURI¶

http://[任意のURI]

2.6.2.3 入力インターフェース¶

• データ形式 ：JSON
• 文字コード ：UTF-8
• リクエストボディ ：任意

2.6.2.4 出力インターフェース¶

• データ形式 ：JSON
• 文字コード ：UTF-8　※

• レスポンスボディ ：下表参照

• レスポンスボディの形式

  {
      "ssm_webhook_response": {
          "trigger_action_execute": bool,
          "actions": [
              <アクション1>,
              …
              <アクションn>
          ]
      }
  }
  

  項目名		値の形式	説明
  trigger_action_execute		bool	トリガーアクション実行フラグ true:トリガーアクションを実行する false:トリガーアクションをキャンセルする
  actions		array of object	-
  	<アクション>	(後述)	各アクション固有の記述 　※詳細は後述します

• レスポンスボディの形式：「プロセスを更新する」アクション

  {
      "type": "update_process_data",
      "param": {
          "process_type_id": "<画面ID>",
          "process_id": "<プロセスレコードID>",
          "system_id": "<システム名>",
          "<項目名>" : "<値>",
          …
          "<項目名>" : "<値>"
      }
  }
  

  typeにupdate_process_data、paramオブジェクト配下にパラメータとして 「\<項目名>: \<値>」の形でレスポンス受信アクションで更新する項目と値を列挙します。

  キー名		値	値の形式	上限(byte)	説明
  type		update_process_data	string	-	-
  param		-	object	-	-
  	process_type_id	<値>	string	8	プロセス管理1～103の画面ID (01000001～01000103)
  	process_id	<値>	string	16	レコードID
  	system_id	<値>	string	60	システム名
  	<項目名>	<値>	※	※	※

  仕様補足

  各項目の項目名は「項目一覧」の以下を参照してください。
  1.1.2.1 プロセス管理
  9. 項目機能5
  レスポンス受信アクション

  仕様補足

  各項目の値の形式および上限は「項目一覧」の以下を参照してください。
  1.1.2.1 プロセス管理
  2. 項目定義（詳細）1

  仕様補足

  更新対象のレコードを特定するため、paramオブジェクト配下の項目名に以下の3つを必ず指定する必要があります。指定しない場合「プロセスを更新する」処理は失敗し、レスポンス受信アクションのエラーが表示されます。
  

  項目名
  process_type_id
  process_id
  system_id

• レスポンスボディの形式：「履歴情報を記録する」アクション

  {
      "type": "register_process_history",
      "param": {
          "comment": "string"
      }
  }
  

  typeにregister_process_history、paramオブジェクト配下にパラメータとして 「comment」を指定しレスポンス受信アクションで履歴に登録する値を送信します。

  キー名		値	値の形式	上限(byte)	説明
  type		register_process_history	string	-	-
  param		-	object	-	-
  	comment	<値>	string	2000	履歴情報に記録するコメント

• レスポンスボディの形式：「ダイアログを表示する」アクション

  {
      "type": "display_dialog",
      "param": {
          "title": "string",
          "content": "string"
      }
  }
  

  typeにdisplay_dialog、paramオブジェクト配下にパラメータとして 「title,content」を指定しレスポンス受信アクションでダイアログ表示内容を送信します。

  キー名		値	値の形式	上限(byte)	説明
  type		display_dialog	string	-	-
  param		-	object	-	-
  	title	<値>	string	100	ダイアログのタイトル
  	content	<値>	string	2000	ダイアログの内容

• 外部WEBAPIが返却するレスポンスの例

  • トリガーアクションをキャンセルし、プロセスを更新、ダイアログを表示する場合

    {
    "ssm_webhook_response": {
        "trigger_action_execute": false,
        "actions": [
            {
                "type": "update_process_data",
                "param": {
                    "process_type_id": "01000001",
                    "process_id": "0000000000000001",
                    "system_id": "営業管理システム",
                    "text_1": "申請前チェックNG"
                }
            },
            {
                "type": "display_dialog",
                "param": {
                    "title": "申請前チェックNG",
                    "content": "システム管理者に問い合わせてください。"
                }
            }
        ]
    }
    }
    

2.7 WEBAPI連携(プロセス管理入力)のWEBAPI仕様まとめ¶

Senju Service Manager のWEBAPI連携(プロセス管理入力)で使用するWEBAPIの仕様を本章にまとめます。

プロセス管理画面での新規登録・編集・経過追加・経過編集時および簡易プロセス（問合せ・申請） 画面での新規登録・編集時、コンボボックスの選択値変更をトリガーとし外部WEBAPIを実行します。

実行された外部WEBAPIのレスポンスに画面の入力値を指定することで、編集中画面の項目に値を自動入力させることができます。

2.7.1 WEBAPI連携(プロセス管理入力)の処理フロー¶

2.7.2 外部WEBAPI¶

2.7.2.1 処理概要（必要な機能）¶

値を自動入力したい項目の項目名・値をレスポンスで返却する。

2.7.2.2 リクエストURI¶

http://[任意のURI]

2.7.2.3 入力インターフェース¶

• データ形式 ：JSON
• 文字コード ：UTF-8
• リクエストボディ ：固定

• リクエストボディの形式

  {
      <項目名>: <値>,
      …
      <項目名>: <値>
  }
  

  以下の情報は常にリクエストボディに設定されます。

  項目名	値の形式	最大桁数	説明
  data_type	string	8	プロセス管理1～103の番号　※1 (00000001～00000103)
  process_id	string	16	レコードID　※2

  仕様補足

  ※1…番号を画面IDに変換するには、上位2桁目を1に置換してください。
  例）プロセス1の場合、00000001→01000001

  仕様補足

  ※2…プロセス新規登録画面では、レコードIDは未採番のため値が空となります。

  仕様補足

  常にリクエストボディに設定される項目以外は、編集中の画面に表示されている項目、かつ「項目一覧」に記載されている本機能の対象項目の項目名・値がリクエストボディに設定されます。

• リクエストボディの例

  編集中画面にステータス、システム、タイトル、インパクト、(経過)内容が表示されている場合

  {
  "data_type": "00000001",
  "process_id": "0000000000000001",
  "status": "受付済",
  "system": "営業管理システム",
  "title": "",
  "impact_level": "",
  "progress_content": ""
  }
  

2.7.2.4 出力インターフェース¶

• データ形式 ：JSON
• 文字コード ：UTF-8　※

• レスポンスボディ ：下表参照

• レスポンスボディの形式

  {
      "out": {
          "<項目名>": "<値>",
          …
          "<項目名>": "<値>"
      }
  }
  

  キー名		値	値の形式	上限(byte)	説明
  out		-	object	-	-
  	<項目名>	<値>	※	※	自動入力したい項目の項目名・値を記載します。※

  項目の入力制御およ自動入力処理時に該当項目にすでに入力されているかどうかによって 値を自動入力可能かどうかが異なります。値を自動入力可能な項目は以下の通りです。

  項目		値の自動入力
  非表示		×
  参照		×
  編集/必須	入力済み	× ※
  	未入力	○

  仕様補足

  各項目の項目名は「項目一覧」の以下を参照してください。
  1.1.2.1 プロセス管理
  9. 項目機能5
  WEBAPI連携(プロセス管理入力)

  仕様補足

  各項目の値の形式および上限は「項目一覧」の以下を参照してください。
  1.1.2.1 プロセス管理
  2. 項目定義（詳細）1

  仕様補足

  ※項目がテキストの場合、既に値が入力済みであると値を自動入力できません。
  項目がコンボボックスの場合、既に入力済みでも値を上書きする形で自動入力します。

• 外部WEBAPIが返却するレスポンスの例

  • トリガーとなるプルダウンを選択時に、インパクト、(経過)内容に値を自動入力する場合

    {
        "out": {
            "impact_level": "緊急",
            "progress_content": "■障害発生日時\n日時を入力してください。"
        }
    }
    

  仕様補足

  以下の特殊記号を使用した場合、該当の特殊記号が使用可能な項目の場合は置換されて表示されます。
  
  ・\" (ダブルクォーテーション)
  ・\\ (バックスラッシュ)
  ・\n (改行)
  ・\t (タブ)

2.8 API連携用テキストのWEBAPI仕様まとめ¶

Senju Service Manager のAPI連携用テキストで使用するWEBAPIの仕様を本章にまとめます。

プロセス管理画面の新規登録・編集・検索条件および簡易プロセス（問合せ・申請）画面の新規登録・編集・検索条件にて、API連携用テキストのリスト選択ボタン押下時に、外部WEBAPIを実行します。

実行された外部WEBAPIのレスポンスにリスト情報を指定することで、リスト情報を取得して画面に表示することができます。

2.8.1 API連携用テキストの処理フロー¶

2.8.2 外部WEBAPI¶

2.8.2.1 処理概要(必要な機能)¶

・リスト表示する内容 及び 最大選択数をレスポンスで返却する。

2.8.2.2 リクエストURI¶

http://[任意のURI]

2.8.2.3 入力インターフェース¶

• データ形式 ：JSON
• 文字コード ：UTF-8
• リクエストボディ ：固定

• リクエストボディの形式

  {
      <項目名>: <値>,
      …
      <項目名>: <値>
  }
  

  以下の情報は常にリクエストボディに設定されます。

  項目名	値の形式	最大桁数	説明
  data_type	string	8	プロセス管理1～103の番号　※1 (00000001～00000103)
  process_id	string	16	レコードID　※2
  sp_account_id	string	16	該当画面操作を行ったログインユーザーのユーザーID
  login_user_name	string	32	該当画面操作を行ったログインユーザーの氏名

  仕様補足

  ※1…番号を画面IDに変換するには、上位2桁目を1に置換してください。
  例）プロセス1の場合、00000001→01000001

  仕様補足

  ※2…プロセス新規登録および検索条件でリスト選択ボタンを押下した場合、レコードIDは未採番のため値が空となります。

  仕様補足

  常にリクエストボディに設定される項目以外は、編集中の画面に表示されている項目、かつ「項目一覧」に記載されている本機能の対象項目の項目名・値がリクエストボディに設定されます。

• リクエストボディの例

  編集中画面にステータス、システム、タイトル、インパクト、(経過)内容が表示されている場合

  {
      "data_type": "00000001",
      "process_id": "0000000000000001",
      "status": "受付済",
      "system": "営業管理システム",
      "title": "",
      "impact_level": "",
      "progress_content": ""
  }
  

2.8.2.4 出力インターフェース¶

• データ形式 ：JSON
• 文字コード ：UTF-8　※

• レスポンスボディ ：下表参照

• レスポンスボディの形式

  {
      "data_list": [<値>, <値> ,<値>,・・・],
      "sel_max": <値>
  }
  

  JSONキー	入力形式	説明
  data_list	array of string	API連携リスト選択ダイアログの、選択元リストに表示する内容。
  sel_max※	number	API連携リスト選択ダイアログから選択できる最大選択数を指定します。

  仕様補足

  ※sel_maxの指定は任意となります。
  新規登録・編集画面の場合、sel_maxの値が指定されていない場合には1が指定されます。検索画面の場合は指定した値に関わらず3が固定となります。

  仕様補足

  画面表示後の動作に影響があるため、外部のWEBAPIから以下に該当する選択肢を返却しないようにしてください。
  ・選択肢にタブ文字や改行が含まれている
  ・data_listに同じデータ名が存在している

• 外部WEBAPIが返却するレスポンスの例

  {
      "data_list": [ "データ1", "データ2", "データ3", "データ4", "データ5" ],
      "sel_max": "3"
  }