業務アプリの設定

画面：サイドメニュー「管理－業務の管理＞業務アプリの設定」

ℹ 補足：このページはサービス担当者の方を対象としています。
⚙ 前提条件：設定には、業務の管理権限または業務アプリの作成権限が必要です。
ℹ 補足：各利用者の詳細は「利用者について」を参照してください。

業務アプリでは、店舗から本部ユーザーへの申請や情報共有など、店舗を起点としたコミュニケーションを実現できます。
ワークフローと入力フォームのテンプレートから業務アプリを作成できます。
システムには、以下の業務アプリ雛形が用意されています。

• 申請業務
• レポート登録
• クレーム管理
• 事例共有
• 他店在庫の問合せ
• 店舗お知らせ発信
• スタッフレポート
• スタッフ申請
• プライベート申請業務

業務アプリの登録・編集

業務アプリは、システムに登録されている業務アプリ雛形をもとに、利用したい業務に合わせて入力フォームや一覧画面をカスタマイズして作成します。
業務アプリの登録数に上限はありません。

基本情報の設定

業務アプリ名、公開期間、文書の保存期間など、利用の基本となる設定を行います。
基本情報の設定項目は、業務アプリ雛形によって異なります。

共通項目

［戻る］ボタンをクリックすると、編集内容を破棄して元の画面に戻ります。
新しい業務アプリの作成時に表示される［次へ］ボタンをクリックすると、入力フォームの編集画面に移動します。
既存の業務アプリの編集時に表示される［保存する］をクリックすると、編集内容を登録します。

入力フォームの編集

業務アプリに登録する文書のテンプレートを設定します。

ℹ 補足：フォームの詳細は「フォームの詳細」を参照してください。

［戻る］ボタンをクリックすると、編集内容を破棄して元の画面に戻ります。
［プレビュー］ボタンをクリックすると、入力フォームのプレビュー画面が表示されます。
新しい業務アプリの作成時に表示される［次へ］ボタンをクリックすると、利用者の設定画面に移動します。
既存の業務アプリの編集時に表示される［保存する］をクリックすると、編集内容を登録します。

利用者の設定

業務アプリに文書を登録できる店舗・本部ユーザーや、文書の閲覧のみを行う店舗・本部ユーザーなど、利用に関する設定を行います。
利用者の種類は、アプリ雛形によって異なります。

共通項目

［戻る］ボタンをクリックすると、編集内容を破棄して元の画面に戻ります。
［保存する］ボタンをクリックすると、編集内容を登録します。

一覧表示の編集

業務アプリの文書一覧画面に表示する項目を設定します。

［取りやめる］ボタンをクリックすると、編集内容を破棄して元の画面に戻ります。
［初期設定に戻す］ボタンをクリックすると、システムにあらかじめ用意されている設定に戻します。
［登録する］ボタンをクリックすると、編集内容を登録します。

開発者向け機能

業務アプリでは、開発者向け機能として外部アプリケーションに連携するためのWebhookを用意しています。

＜業務アプリのWebhookとは＞

業務アプリの文書の更新タイミングで、外部システムが公開するHTTPエンドポイントに更新イベントをHTTPのPOSTメソッドで通知する仕組みです。
各業務アプリごとにWebhookの設定を行えます。

⚙ 前提条件：Webhookからの通知を受け取り処理を行うプログラムを自社用に開発する必要があります。

業務アプリの一覧表示

業務アプリの一覧をソート順位の昇順で表示します。
項目名をクリックすると、対象項目の昇順／降順で並び順を切り替えて表示します。

ボタン操作

［業務アプリを作成する］ボタンをクリックすると、新しく業務アプリを登録できます。
一覧に表示される［編集］ボタンをクリックすると、対象の業務アプリの編集／削除ができます。

ℹ 補足：業務アプリごとに利用データ容量が一覧に表示されます。
ℹ 補足：利用ディスクサイズの計算は1日1回深夜に行うため、サイズはリアルタイムには更新されません。

業務アプリのコピー

既存の業務アプリをコピーして、新しい業務アプリを作成します。
コピーして作成した業務アプリでは、アプリ雛形を変更できません。

編集画面の［コピーする］ボタンをクリックすると、コピー画面が表示されます。

［登録する］ボタンをクリックすると、新しく業務アプリを作成します。作成した業務アプリは「状態」が「無効」になっているため、利用する際は編集画面から「有効」に変更する必要があります。
［取りやめる］ボタンをクリックすると、コピーを取りやめて元の画面に戻ります。

業務アプリのエクスポート

既存の業務アプリをエクスポートして、ZIPファイル形式で保存できます。
トライアル時に作成した業務アプリを本番環境へ移行する際に利用できます。

編集画面の［エクスポートする］ボタンをクリックすると、ZIPファイルがダウンロードされます。

業務アプリのインポート

業務アプリのエクスポートで保存したZIPファイルをインポートできます。

業務アプリの一覧画面の［インポートする］ボタンをクリックすると、定義ファイルのインポート画面が表示されます。エクスポートしたZIPファイルを選んでインポートします。
［取りやめる］ボタンをクリックすると、インポートを取りやめて元の画面に戻ります。

業務アプリの削除

業務アプリを削除します。

⚠ 注意：一度削除した業務アプリは元に戻せないのでご注意ください。

［取りやめる］ボタンをクリックすると、削除を取りやめて編集画面に戻ります。
［削除する］ボタンをクリックすると、この業務アプリを削除します。

Webhookの設定

業務アプリの文書が更新されたタイミングで、外部アプリケーションへ更新情報を通知するWebhookを設定します。
たとえば、店舗から申請が登録されたときに本部側のワークフローへ連携したり、SNSにもあわせてプッシュ通知したりできます。

［キャンセル］ボタンをクリックすると、編集内容を破棄して元の画面に戻ります。
［保存する］ボタンをクリックすると、編集内容を登録して元の画面に戻ります。
［削除する］ボタンは既存のWebhook編集時に表示され、このWebhookを削除できます。

通知するイベント

例）「レポート登録」雛形を使用時の更新通知

Webhookの送信データ

ℹ 補足：WebhookのHTTPリクエストはHTTP/1.1をサポートしています。

ペイロード形式バージョン：v1

文書のテキストデータを送信します。
添付ファイルはダウンロードできません。

{
    "appId":"業務アプリID",
    "recordId": {文書番号となる32ビット符号付整数値(long)},
    "recordStatus": "更新後の文書のステータスコード",
    "event": "CREATE" or "UPDATE" or "DELETE",
    "regAccount":{
        "loginId": "操作したユーザID",
        "name": "操作したユーザの名前",
        "type": {操作したユーザの種類}
    },
    "updAccount":{
        "loginId": "操作したユーザID",
        "name": "操作したユーザの名前",
        "type": {操作したユーザの種類}
    },
    "regDate": "登録日時(UTC)",
    "updDate": "更新日時(UTC)",
    "sessionOwner":{
　　　　"loginId": "操作した店舗ID",
　　　　"name": "操作した店舗の名前",
　　　　"type": {操作した店舗の種類}
    },
    "sessionSubOwner":{
        "loginId": "スタッフ機能を利用している場合のスタッフID",
　　　　"name": "スタッフの名前",
　　　　"type": {スタッフの種類}
    },
    "data": {
        "9001": "本部担当者(ログインID)",
        "10002": "タイトルに入力した値",
        "10003": "申請者に入力した値",
        "10004": "コメント",
        "10005": "添付ファイルのファイル名"
    },
    "token": "リクエストの発行元を検証するためのトークン"
}

ペイロード形式バージョン：v2

文書のテキストデータに加えて、添付PDFや添付ファイルのダウンロードURLとKey情報を送信します。

{
    "appId":"業務アプリID",
    "recordId": {文書番号となる32ビット符号付整数値(long)},
    "recordStatus": "更新後の文書のステータスコード",
    "event": "CREATE" or "UPDATE" or "DELETE",
    "contentUrl":"文書のURL" 
    "regAccount":{
        "loginId": "操作したユーザID",
        "name": "操作したユーザの名前",
        "type": {操作したユーザの種類}
    },
    "updAccount":{
        "loginId": "操作したユーザID",
        "name": "操作したユーザの名前",
        "type": {操作したユーザの種類}
    },
    "regDate": "登録日時(UTC)",
    "updDate": "更新日時(UTC)",
    "sessionOwner":{
　　　　"loginId": "操作した店舗ID",
　　　　"name": "操作した店舗の名前",
　　　　"type": {操作した店舗の種類}
    },
    "sessionSubOwner":{
        "loginId": "スタッフ機能を利用している場合のスタッフID",
　　　　"name": "スタッフの名前",
　　　　"type": {スタッフの種類}
    },
    "data": {
        "9001": "本部担当者(ログインID)",
        "10002": "タイトルに入力した値",
        "10003": "申請者に入力した値",
        "10004": {
            "html": "コメント",
            "files": []
        },
        "10005": [
            {
                "fileName": "ファイル名",
                "bytes": ファイルのバイト数,
                "key": "ファイルのKey情報",
                "contentUrl": "ファイルのダウンロードURL"
            }
        ]
    },
    "token": "リクエストの発行元を検証するためのトークン"
}

ファイルのダウンロード方法

ペイロードで返されたダウンロードURL{contentUrl}にWebAPIキーを設定してリクエストを発行します。
WebAPIキーは「WebAPIキーの管理」で確認してください。

例）

GET {contentUrl} HTTP/1.1
X-ShopRun-Auth: {WebAPIキー}

データの値について

ペイロード形式バージョン：Microsoft Teams

TeamsのIncoming Webhookコネクタを利用して、アダプティブカード形式のデータを送信します。
カードには、フォームに配置された部品のデータが上から下、左から右の順で出力されます。

{
  "type": "message",
  "attachments": [{
    "contentType": "application/vnd.microsoft.card.adaptive",
    "contentUrl": null,
    "content": {
      "actions": [{
        "iconUrl": null,
        "id": null,
        "isEnabled": null,
        "mode": null,
        "style": null,
        "title": "表示する",
        "tooltip": "文書URL",
        "type": "Action.OpenUrl",
        "url": "文書URL"
      }],
      "body": [{
        "backgroundImage": null,
        "bleed": null,
        "id": null,
        "isVisible": null,
        "items": [{
          "columns": [{
            "backgroundImage": null,
            "bleed": null,
            "id": null,
            "isVisible": null,
            "items": [{
              "altText": "操作したユーザ",
              "backgroundColor": null,
              "height": null,
              "horizontalAlignment": null,
              "id": null,
              "isVisible": null,
              "selectAction": null,
              "separator": null,
              "size": "small",
              "spacing": null,
              "style": "person",
              "type": "Image",
              "url": "URL",
              "width": null
            }],
            "minHeight": null,
            "selectAction": null,
            "separator": null,
            "spacing": null,
            "style": null,
            "type": "Column",
            "verticalContentAlignment": null,
            "width": "auto"
          }, {
            "backgroundImage": null,
            "bleed": null,
            "id": null,
            "isVisible": null,
            "items": [{
              "color": null,
              "fontType": null,
              "height": null,
              "horizontalAlignment": null,
              "id": null,
              "isSubtle": null,
              "isVisible": null,
              "maxLines": null,
              "separator": null,
              "size": null,
              "spacing": null,
              "style": null,
              "text": "操作したユーザの名前",
              "type": "TextBlock",
              "weight": "bolder",
              "wrap": true
            }],
            "minHeight": null,
            "selectAction": null,
            "separator": null,
            "spacing": null,
            "style": null,
            "type": "Column",
            "verticalContentAlignment": null,
            "width": "stretch"
          }],
          "spacing": null,
          "type": "ColumnSet"
        }, {
          "color": null,
          "fontType": null,
          "height": null,
          "horizontalAlignment": null,
          "id": null,
          "isSubtle": null,
          "isVisible": null,
          "maxLines": null,
          "separator": null,
          "size": "medium",
          "spacing": null,
          "style": null,
          "text": "[登録 or 更新 or 削除] 業務アプリ名",
          "type": "TextBlock",
          "weight": "bolder",
          "wrap": null
        }, {
          "facts": [{
            "title": "タイトル",
            "value": "文書タイトル"
          }, {
            "title": "番号",
            "value": "文書番号"
          }, {
            "title": "状態",
            "value": "文書のステータス"
          }],
          "type": "FactSet"
        }],
        "minHeight": null,
        "selectAction": null,
        "separator": null,
        "spacing": null,
        "style": null,
        "type": "Container",
        "verticalContentAlignment": null
      }, {
        "height": null,
        "horizontalAlignment": null,
        "id": null,
        "inlines": [{
          "color": "accent",
          "fontType": null,
          "highlight": null,
          "isSubtle": null,
          "italic": null,
          "size": null,
          "strikethrough": null,
          "text": "最初の部品（ラベル）",
          "type": "TextRun",
          "weight": null
        }, "\n", "最初の部品に入力したデータ"],
        "isVisible": null,
        "separator": null,
        "spacing": null,
        "type": "RichTextBlock"
      },
      ：（省略）
      ],
      "msteams": {
        "width": "Full"
      },
      "schema": "http://adaptivecards.io/schemas/adaptive-card.json",
      "type": "AdaptiveCard",
      "version": "1.5"
    }
  }]
}

Webhookの一覧

登録したWebhookの一覧を確認できます。

［Webhookを追加］ボタンをクリックするとWebhookを登録できます。
［Webhookの履歴を見る］ボタンをクリックするとWebhookの履歴を確認できます。
一覧の［編集］ボタンをクリックすると、Webhookの設定確認／編集ができます。

Webhookの削除

設定しているWebhookを削除します。

［取りやめる］ボタンをクリックすると削除を取りやめて元の画面に戻ります。
［削除する］ボタンをクリックすると、このWebhookを削除できます。