ワークフロー承認後にメッセージを送信する

目次

はじめに

ワークフロー申請を承認したときのイベント を使い、ワークフローの申請内容をメッセージ送信します。メッセージを送信する部分は Garoon SOAP API を使用しています。

前提条件と注意事項

  • このカスタマイズには、クラウド版 Garoon またはパッケージ版 Garoon 4.10 以降の環境が必要です。
  • ワークフロー JavaScript カスタマイズは、JavaScript を適用した後に申請されたワークフローが対象です。
    それ以前に申請されたワークフローには適用されません。
  • 代理承認時にカスタマイズが動作しない不具合を確認しています。(2019/2/21 追記)

できること

ワークフローとメッセージを連携させることにより、送信前に上司の確認・承認をはさむことができます。
以前に紹介した掲示板連携と異なり、送信時に宛先を指定できるため、範囲を限定したお知らせや情報発信をできます。

完成イメージ

Garoon のワークフローを承認すると、申請内容がメッセージ送信されます。

  • 「承認する」ボタンをクリックすると、指定した宛先に対してメッセージが送信されます。

宛先機能について

  • メッセージの宛先を設定するために、JavaScript カスタマイズ項目でカスタマイズしています。
  • すべての組織をフラットにプルダウン表示し、組織をクリックすると、その下に組織の所属ユーザを一覧表示します。
  • ユーザの一覧から、宛先として含めるユーザを「追加」ボタンで選択できます。
    複数選択や別組織を選択してのユーザ追加が可能です。
  • 「削除」ボタンはありません。すでに追加した宛先を削除するためには、画面上宛先を直接編集可能ですが、サンプルプログラムでは、編集されたことによる値が不正な状態となった場合の考慮はしません。

メッセージ側には特別な設定は不要です。
ワークフローの設定にのみ、JavaScript ファイルを設定しカスタマイズしていきます。

Garoon ワークフローの設定手順

ワークフローの項目の内容は、会社によって異なります。
ここでは、サンプルということで、メッセージの SOAP API で設定可能な項目をおおむね網羅した申請フォームに JavaScript / CSS カスタマイズを設定する流れを説明します。

ワークフローの申請フォームを作成する

まずは以下の項目を配置して、ワークフローの申請フォームを作成していきます。
申請フォームの作成方法については、Garoon ヘルプ - 申請フォームの作成の流れ クラウド版 (External link) パッケージ版 (External link) を参照してください。

申請フォームは、掲示板の項目と対応付けます。それぞれの項目は以下のとおり設定してください。
項目コードは、JavaScript コード内でそれぞれの項目を指定するための一意の文字列になります。

項目名 項目タイプ 項目コード 必須 備考
タイトル 文字列(1行) Title
本文 文字列(複数行) Body
添付ファイル ファイル添付 Attach 5つまで登録可能とします。
宛先 文字列(複数行) SendTo
- JavaScriptカスタマイズ項目 select_to 「直前の項目に続けて、右隣に配置する」を選択します。
宛先を設定するためのカスタマイズ部品を配置します。
閲覧状況を確認する チェックボックス Confirm

上記のとおり設定が完了したら、土台となる申請フォームの作成は完了です。

JavaScript / CSS ファイルを適用する

申請フォームの作成が完了したので、ここから作成した申請フォームに JavaScript ファイルを適用していきます。

適用ファイルの準備

次のサンプルコードをエディタにコピーして、ファイル名を「wf_to_msg.js」、文字コードを「UTF-8」で保存します。
ファイル名は任意ですが、ファイルの拡張子は「js」にしてください。

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
/**
 * Garoon JavaScript、SOAP APIを使ったサンプルプログラム
 * ワークフロー承認時、メッセージを送信する。
 *
 * 「wf_to_msg.js」ファイル
 *
 * Licensed under the MIT License
 *
 * Copyright (c) 2018 Cybozu
 */
(($) => {
  'use strict';

  /**
   * 共通SOAPコンテンツ
   * ${XXXX}の箇所は実施処理等に合わせて置換して使用
   */
  const SOAP_TEMPLATE =
        '<?xml version="1.0" encoding="UTF-8"?>' +
        '<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">' +
          '<soap:Header>' +
            '<Action>${ACTION}</Action>' +
            '<Timestamp>' +
              '<Created>${CREATED}</Created>' +
              '<Expires>2037-08-12T14:45:00Z</Expires>' +
            '</Timestamp>' +
            '<Locale>jp</Locale>' +
          '</soap:Header>' +
          '<soap:Body>' +
            '<${ACTION}>' +
              '${PARAMETERS}' +
            '</${ACTION}>' +
          '</soap:Body>' +
        '</soap:Envelope>';

  /**
     * メッセージ登録パラメータテンプレート
     * ${XXXX}の箇所は入力値等で置換して使用
     */
  const MSG_ADD_TEMPLATE =
        '<parameters>' +
          '<request_token>${REQUEST_TOKEN}</request_token>' +
          '<create_thread>' +
            '<thread id="dummy" version="dummy" subject="${SUBJECT}" confirm="${CONFIRM}">' +
            '${ADDRESSEE}' +
            '<content body="${BODY}">' +
              '${FILE_DEFS}' +
            '</content>' +
            '<folder id="dummy"></folder>' +
            '</thread>' +
            '${FILE_CONTENTS}' +
          '</create_thread>' +
        '</parameters>';

  /**
   * メッセージ送信先パラメータテンプレート
   * ${XXXX}の箇所は入力値等で置換して使用
   */
  const ADDRESSEE_TEMPLATE =
        '<addressee user_id="${USER_ID}" name="dummy" deleted="false"></addressee>';

  /**
   * ファイル定義
   * ${XXXX}の箇所は入力値等で置換して使用
   */
  const FILE_DEF_TEMPLATE =
        '<file id="${INDEX}" name="${FILE_NAME}" mime_type="${FILE_MIME_TYPE}"></file>';

  /**
   * ファイルコンテンツ
   * ${XXXX}の箇所は入力値等で置換して使用
   */
  const FILE_CONTENT_TEMPLATE =
        '<file xmlns="" id="${INDEX}">' +
          '<content xmlns="">${FILE_CONTENT}</content>' +
        '</file>';


  // 文字列をHTMLエスケープ
  const escapeHtml = function(str) {
    return str
      .replace(/&/g, '&amp;')
      .replace(/</g, '&lt;')
      .replace(/>/g, '&gt;')
      .replace(/"/g, '&quot;')
      .replace(/'/g, '&#39;');
  };

  // リクエストトークン取得
  const getRequestToken = function() {
    const defer = $.Deferred();

    // リクエストトークンの取得
    let request = SOAP_TEMPLATE;
    request = request.replace('${PARAMETERS}', '<parameters></parameters>');
    request = request.split('${ACTION}').join('UtilGetRequestToken');
    request = request.replace('${CREATED}', luxon.DateTime.utc().startOf('second').toISO({suppressMilliseconds: true}));

    $.ajax({
      type: 'post',
      url: '/g/util_api/util/api.csp',
      cache: false,
      async: false,
      data: request
    })
      .then((response) => {
        defer.resolve($(response).find('request_token').text());
      });
    // 本来はエラー処理を実施
    return defer.promise();
  };

  const getOrganizations = function(organizations, offset) {
    const optOffset = offset || 0;

    const size = 100;
    const params = {
      offset: optOffset,
      size: size
    };

    const defer = $.Deferred();

    $.ajax({
      type: 'get',
      url: '/v1/organizations.json',
      cache: false,
      async: false,
      data: params
    })
      .then((response) => {
        defer.resolve(response.organizations);
      });
    // 本来はエラー処理を実施
    return defer.promise();
  };

  // 指定組織IDの組織に所属するユーザ情報を取得する
  const getOrgUsers = function(orgCd) {
    const params = {
      code: orgCd
    };

    const defer = $.Deferred();

    $.ajax({
      type: 'get',
      url: '/v1/organization/users.json',
      cache: false,
      async: false,
      data: params
    })
      .then((response) => {
        defer.resolve(response.userTitles);
      });
    // 本来はエラー処理を実施

    return defer.promise();
  };

  // 指定のユーザ名に対応するユーザIDを取得する
  const getUsersByLoginName = function(userNms) {
    const defer = $.Deferred();

    const params = [];
    for (let ix = 0; ix < userNms.length; ix++) {
      params.push('<login_name>' + userNms[ix] + '</login_name>');
    }

    // 申請者情報(申請者のID)の取得
    let request = SOAP_TEMPLATE;
    request = request.replace('${PARAMETERS}',
      '<parameters>' + params.join('') + '</parameters>');
    request = request.split('${ACTION}').join('BaseGetUsersByLoginName');
    request = request.replace(
      '${CREATED}', luxon.DateTime.utc().startOf('second').toISO({suppressMilliseconds: true}));

    $.ajax({
      type: 'post',
      url: '/g/cbpapi/base/api.csp',
      cache: false,
      async: false,
      data: request
    })
      .then((response) => {
        const userIds = [];
        $(response).find('user').each(function() {
          userIds.push($(this).attr('key'));
        });
        defer.resolve(userIds);
      });
    // 本来はエラー処理を実施
    return defer.promise();
  };

  // ワークフロー申請の作成画面が表示されたときのイベント
  // 宛先ユーザを選択するための機能を追加する
  garoon.events.on('workflow.request.create.show', (event) => {
    // 組織の一覧と所属ユーザ一覧のフィールドを作成
    getOrganizations().then((organizations) => {
      const selectTo = garoon.workflow.request.getSpaceElement('select_to');
      // 組織選択のプルダウンを配置
      const selectOrg = $('<select id="selectOrg" style="width: 300px"><option>----</option></select>');
      $(selectTo).append(selectOrg);
      for (let ix = 0; ix < organizations.length; ix++) {
        const option = $('<option>').val(organizations[ix].code).text(organizations[ix].name);
        $(selectOrg).append(option);
      }

      // 宛先ユーザ選択の複数選択を配置(初期状態は空白)
      const selectUser =
        $('<div><select id="selectUser" multiple="true" style="width: 300px"><div>');
      $(selectTo).append(selectUser);

      // 組織選択変更時にユーザ一覧を書き換える
      $(selectOrg).change(function() {
        // 現在の選択肢をクリア
        $('#selectUser').children().remove();
        // 所属ユーザを追加
        // ユーザ指定に使用するユーザID、利用者が判別するための名前を表示する
        getOrgUsers($(this).val()).then((users) => {
          for (let iy = 0; iy < users.length; iy++) {
            const user = $('<option>')
              .val(users[iy].user.code + ':' + users[iy].user.name)
              .text(users[iy].user.code + ':' + users[iy].user.name);
            $('#selectUser').append(user);
          }
        });
      });

      const addButton = $('<div><button id="addUser">宛先追加</button></div>');
      $(selectTo).append(addButton);

      // 宛先追加ボタンクリック
      // 宛先複数選択フィールドに対して選択したユーザを追加する
      $('#addUser').click(() => {
        const request = garoon.workflow.request.get();

        // 改行で分割して現在の設定値を配列化
        let sendUsers = [];
        if (request.items.SendTo.value.length > 0) {
          sendUsers = request.items.SendTo.value.split('\n');
        }

        // 宛先ユーザの選択を追加する
        const selectUsers = $('#selectUser').val();
        for (let iy = 0; iy < selectUsers.length; iy++) {
          // 文字列検索し、すでに追加済みのユーザは追加対象外とする
          if ($.inArray(selectUsers[iy], sendUsers) < 0) {
            sendUsers.push(selectUsers[iy]);
          }
        }

        // 改行で連結し、再度値を戻す
        request.items.SendTo.value = sendUsers.join('\n');
        garoon.workflow.request.set(request);
      });
    });
  });
  // 指定した申請情報から添付ファイル情報を取得
  const getRequestFiles = function(requestId) {
    const defer = $.Deferred();
    let request = SOAP_TEMPLATE;
    request = request.replace('${PARAMETERS}',
      '<parameters><application_id>' + requestId + '</application_id></parameters>');
    request = request.split('${ACTION}').join('WorkflowGetReceivedApplicationsById');
    request = request.replace(
      '${CREATED}', luxon.DateTime.utc().startOf('second').toISO({suppressMilliseconds: true}));
    $.ajax({
      type: 'post',
      url: '/g/cbpapi/workflow/api.csp',
      cache: false,
      async: false,
      data: request
    })
      .then((response) => {
        defer.resolve($(response).find('file'));
      });
    // 本来はエラー処理を実施
    return defer.promise();
  };
    // 指定IDのファイルを取得
  const downloadFile = function(fileId) {
    const defer = $.Deferred();

    let request = SOAP_TEMPLATE;
    request = request.replace('${PARAMETERS}',
      '<parameters file_id="' + fileId + '"></parameters>');
    request = request.split('${ACTION}').join('WorkflowFileDownload');
    request = request.replace(
      '${CREATED}', luxon.DateTime.utc().startOf('second').toISO({suppressMilliseconds: true}));
    $.ajax({
      type: 'post',
      url: '/g/cbpapi/workflow/api.csp',
      cache: false,
      async: false,
      data: request
    })
      .then((response) => {
        defer.resolve($(response).find('content').text());
      });
    // 本来はエラー処理を実施
    return defer.promise();
  };
  // 申請に登録された全ファイルを取得
  const downloadFiles = function(files, index) {

    let optIndex = index || 0;
    // すべてのファイルコンテンツを取得し終えた場合終了
    if (files.length === optIndex) {
      const defer = $.Deferred();
      defer.resolve(files);
      return defer.promise();
    }

    return downloadFile(files[optIndex].id).then((content) => {
      files[optIndex].content = content;
      optIndex++;
      return downloadFiles(files, optIndex);
    });
  };

  // ワークフロー承認イベントで起動する
  // 申請内容をメッセージに登録する
  garoon.events.on('workflow.request.approve.submit.success', (event) => {
    // 申請内容を取得する
    const request = event.request;

    // ログイン名:氏名<改行>ログイン名:氏名 ... の形式で宛先は設定されている前提
    // 改行で分割
    const userNms = [];
    const sendTo = request.items.SendTo.value.split('\n');
    for (let iy = 0; iy < sendTo.length; iy++) {
      // [:]の前をユーザIDとして切り出す
      userNms.push(sendTo[iy].split(':')[0]);
    }
    return getUsersByLoginName(userNms).then((userIds) => {
      const requestId = request.id;
      // 申請 ID から添付されたファイルの情報を取得する
      return getRequestFiles(requestId).then(($requestFiles) => {
        const files = [];
        $requestFiles.each((_index, file) => {
          files.push(
            {
              id: $(file).attr('file_id'),
              name: $(file).attr('name'),
              contentType: $(file).attr('mime_type')
            }
          );
        });
        // 添付ファイルのbase64Binary表現を取得
        return downloadFiles(files);
      }).then((files) => {
        return getRequestToken().then((requestToken) => {
          // ファイルパラメータの構築
          const fileDefs = [];
          const fileContents = [];
          for (let ix = 0; ix < files.length; ix++) {
            let fileDef = FILE_DEF_TEMPLATE;
            fileDef = fileDef.replace('${INDEX}', files[ix].id);
            fileDef = fileDef.replace('${FILE_NAME}', files[ix].name);
            fileDef = fileDef.replace('${FILE_MIME_TYPE}', files[ix].contentType);
            fileDefs.push(fileDef);

            let fileContent = FILE_CONTENT_TEMPLATE;
            fileContent = fileContent.replace('${INDEX}', files[ix].id);
            fileContent = fileContent.replace('${FILE_CONTENT}', files[ix].content);
            fileContents.push(fileContent);
          }

          // 複数人への送信内容をまとめる配列
          const userParams = [];
          for (let iz = 0; iz < userIds.length; iz++) {
            userParams.push(ADDRESSEE_TEMPLATE.replace('${USER_ID}', userIds[iz]));
          }

          // 送信するメッセージパラメータを作成
          let msgAddParam = MSG_ADD_TEMPLATE;
          msgAddParam = msgAddParam.replace('${REQUEST_TOKEN}', escapeHtml(requestToken));
          msgAddParam = msgAddParam.replace('${ADDRESSEE}', userParams.join('')); // ユーザID
          msgAddParam = msgAddParam.replace('${SUBJECT}',
            request.items.Title.value + '(申請者:' + request.applicant.name + ')'); // 表題
          msgAddParam = msgAddParam.replace('${BODY}',
            request.items.Body.value.split('\n').join('&#xA;'));
          msgAddParam = msgAddParam.replace('${CONFIRM}', request.items.Confirm.value);
          msgAddParam = msgAddParam.replace('${FILE_DEFS}', fileDefs.join(''));
          msgAddParam = msgAddParam.replace('${FILE_CONTENTS}', fileContents.join(''));

          let msgAddRequest = SOAP_TEMPLATE;
          // SOAPパラメータを完成させる
          msgAddRequest = msgAddRequest.replace('${PARAMETERS}', msgAddParam);
          // 実行処理を指定
          msgAddRequest = msgAddRequest.split('${ACTION}').join('MessageCreateThreads');
          msgAddRequest = msgAddRequest.replace(
            '${CREATED}', luxon.DateTime.utc().startOf('second').toISO({suppressMilliseconds: true}));

          // メッセージ登録の実行
          $.ajax({
            type: 'post',
            url: '/g/cbpapi/message/api.csp',
            cache: false,
            async: false,
            data: msgAddRequest
          });
          // 本来はエラー処理を実施
        });
      });
    });
  });
})(jQuery.noConflict(true));

ポイント

  • ワークフロー申請フォームでは、ユーザを選択する項目タイプがありません。
    そのため、今回のサンプルでは、文字列(複数行)項目に対して選択ユーザを追加するカスタマイズを行います。該当箇所を抜粋します。

組織情報をエクスポートする を使用して検索し、以下のように組織一覧を元にドロップダウンフィールドを作成しています。

202
203
204
205
206
207
208
// 組織選択のプルダウンを配置
const selectOrg = $('<select id="selectOrg" style="width: 300px"><option>----</option></select>');
$(selectTo).append(selectOrg);
for (let ix = 0; ix < organizations.length; ix++) {
  const option = $('<option>').val(organizations[ix].code).text(organizations[ix].name);
  $(selectOrg).append(option);
}

②ドロップダウンで選択した組織に所属するユーザを、 組織の所属ユーザーを取得する を使用して検索し、以下のようにユーザ一覧を元に複数選択フィールドを作成しています。

210
211
212
213
// 宛先ユーザ選択の複数選択を配置(初期状態は空白)
const selectUser =
        $('<div><select id="selectUser" multiple="true" style="width: 300px"><div>');
$(selectTo).append(selectUser);

③ユーザ一覧で選択したユーザを、宛先フィールドに反映します。

  • request.approve.submit.success イベントに実装することにより、承認が行われた後に起動する処理を作成します。

  • 宛先に指定したユーザのログイン名を、 ユーザー情報を取得する で Garoon のユーザ ID へ変換し、SOAP リクエストパラメーターに設定しています。

    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    
      // ワークフロー承認イベントで起動する
      // 申請内容をメッセージに登録する
      garoon.events.on('workflow.request.approve.submit.success', (event) => {
        // 申請内容を取得する
        const request = event.request;
    
        // ログイン名:氏名<改行>ログイン名:氏名 ... の形式で宛先は設定されている前提
        // 改行で分割
        const userNms = [];
        const sendTo = request.items.SendTo.value.split('\n');
        for (let iy = 0; iy < sendTo.length; iy++) {
          // [:]の前をユーザIDとして切り出す
          userNms.push(sendTo[iy].split(':')[0]);
        }
  • 送信者は申請者ではなく、承認者になります。申請者名義での送信はできないため、タイトルに申請者名を明記しています。

    377
    378
    379
    380
    381
    382
    
    // 送信するメッセージパラメータを作成
    let msgAddParam = MSG_ADD_TEMPLATE;
    msgAddParam = msgAddParam.replace('${REQUEST_TOKEN}', escapeHtml(requestToken));
    msgAddParam = msgAddParam.replace('${ADDRESSEE}', userParams.join('')); // ユーザID
    msgAddParam = msgAddParam.replace('${SUBJECT}',
      request.items.Title.value + '(申請者:' + request.applicant.name + ')'); // 表題
    

JavaScript / CSS ファイルとして使用するファイルのおよびリンクの追加

  1. 「申請フォーム情報」部分の右端にある「JavaScript / CSS によるカスタマイズ」をクリックします。

    申請フォームの詳細画面に「JavaScript / CSS によるカスタマイズ」というリンクが表示されない場合、
    ワークフローのカスタマイズが許可されていない場合はリンクが表示されませんので、Garoon ヘルプ - ワークフローのカスタマイズを許可する クラウド版 (External link) パッケージ版 (External link) を参照してください。

  2. [カスタマイズ]項目に「適用する」を選択します。wf_to_msg.js が使用する jQuery、Luxon、および作成した「wf_to_msg.js」ファイルを追加し、「設定する」をクリックします。

本カスタマイズでは、 Cybozu CDN の以下のライブラリーを使用します。

  • jQuery
    https://js.cybozu.com/jquery/3.6.4/jquery.min.js
  • Luxon
    https://js.cybozu.com/luxon/3.3.0/luxon.min.js

jQuery、Luxon は wf_to_msg.js より上位に登録してください。

以上ですべての設定は完了です。最初にお見せした完成イメージのとおり、動けば成功です。

おわりに

Garoon API のカスタマイズサンプル ワークフローとメッセージとの連携方法を紹介しました。
ワークフローの承認実行のタイミングで Garoon 内の別アプリにデータを登録することが簡単にできます。

更新履歴

  • 2022 年 2 月 1 日
    添付ファイルの ID を取得する処理を、workflow.request.approve.submit.success イベントのワークフローオブジェクトを使う方法から、 SOAP API(受信した申請を取得する) を使う方法に変更
information

この Tips は、2023 年 4 月版 Garoon で動作を確認しています。