定期報告の設定

画面：サイドメニュー「管理－業務の管理＞定期報告の設定」

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

日報、週報、売上報告など、店舗・本部ユーザーから報告を収集できる定期報告機能の設定を行います。

定期報告の登録・編集

定期報告を新しく登録、または既存の定期報告を編集します。

基本の設定

報告業務の報告タイミングや利用者などを設定します。

新しい定期報告の作成時に表示される［次へ］ボタンをクリックすると、フォームの編集画面へ移動します。
既存の定期報告の編集時に表示される［登録する］ボタンをクリックすると、編集内容を登録します。
［取りやめる］ボタンをクリックすると、編集内容を破棄して元の画面に戻ります。

フォームの定義

報告業務の入力フォームを設定します。

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

［戻る］ボタンをクリックすると、編集内容を破棄して元の画面に戻ります。
［プレビュー］ボタンをクリックすると、入力フォームのプレビュー画面が表示されます。
［登録する］ボタンをクリックすると、編集内容を登録します。

開発者向け機能

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

＜定期報告のWebhookとは＞

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

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

定期報告の一覧表示

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

［追加する］ボタンをクリックすると、新しく定期報告を登録できます。
一覧に表示される［編集］ボタンをクリックすると、対象の定期報告の編集／削除ができます。

定期報告のコピー

既存の定期報告をコピーして、新しい定期報告を作成します。

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

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

定期報告のエクスポート

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

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

定期報告のインポート

定期報告のエクスポートで保存したZIPファイルをインポートできます。

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

定期報告の削除

定期報告を削除します。

⚠ 注意：一度削除した定期報告は元に戻せないのでご注意ください。

［取りやめる］ボタンをクリックすると、削除を取りやめて編集画面に戻ります。
［削除する］ボタンをクリックすると、この定期報告を削除します。

Webhookの設定

定期報告の更新タイミングで、外部アプリケーションへの更新情報を通知するWebhookを設定します。
店舗からの報告を社内SNSに通知したり、報告画像を別システムに送ったりできます。

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

＜通知するイベント＞

ℹ 補足：コメントの削除時にWebhook通知は送られません。
ℹ 補足：Webhook通知後にコメントが削除された場合は、通知されたコメントを定期報告のコメント欄で確認できない可能性があります。

＜送信データ＞

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

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

定期報告のテキストデータ、画像ファイルや添付ファイルのダウンロードURLとKey情報を送信します。

{
  "logbookId": {定期報告のID},
  "recordId": {レコードID},
  "recordStatus": "registered", 
  "event": "CREATE" or "UPDATE", // 新規登録=CREATE, 更新=UPDATE
  "contentUrl": "定期報告のURL", // 新UIで開くことができるURL
  "regAccount": {
    "loginId": "登録したユーザーのID",
    "name": "登録したユーザーの名前",
    "type": "登録したユーザーの種類"
  },
  "updAccount": {
    "loginId": "更新したユーザーID",
    "name": "更新したユーザーの名前", 
    "type": "更新したユーザーの種類"
  },
  "regDate": "登録日時(UTC)", 
  "updDate": "更新日時(UTC)", 
  "sessionOwner": { 
    "loginId": "操作したユーザーID",
    "name": "操作したユーザーの名前",
    "type": "操作したユーザーの種類"
  },
  "sessionSubOwner": { // 店舗スタッフ機能を利用している場合
    "loginId": "操作したスタッフコード",
    "name": "操作したスタッフの名前",
    "type": "staff"
  },
  "data": { // フォームに配置した部品の値
    "10001": "部品10001のデータ",
    "10002": "部品10002のデータ",
    "10003": "部品10003のデータ",
    "10004": [ // ファイル添付部品の場合
      {
                "fileName": "ファイル名",
                "bytes": ファイルのバイト数,
                "key": "ファイルのKey情報",
                "contentUrl": "ファイルのダウンロードURL"
      }
    ],
    "10005": {// 画像部品の場合
                "fileName": "ファイル名",
                "bytes": ファイルのバイト数,
                "key": "ファイルのKey情報",
                "contentUrl": "ファイルのダウンロードURL"
    }
  },
  "token": "webhookの発行元を検証するためのトークン"
}

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

ペイロードで返されたダウンロード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
            },
            {
              "color": null, 
              "fontType":null, 
              "height":null, 
              "horizontalAlignment":null, 
              "id":null, 
              "isSubtle":true, 
              "isVisible":null, 
              "maxLines":null, 
              "separator":null, 
              "size":"small", 
              "spacing":"NONE", 
              "style":null, 
              "text":"登録者の所属グループ", 
              "type":"TextBlock", 
              "weight":null, 
              "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":"[登録] 定期報告のタイトル 対象期間", 
          "type":"TextBlock", 
          "weight":"bolder", 
          "wrap":null
        } ],
        "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"
    }
  }
  ]
}