開発手順

この記事では、プラグインの作成手順とeセールスマネージャーへの公開方法について説明します。
JS プラグインを作成する方法の詳細は、チュートリアルを参照してください。

1. プラグイン作成に必要なファイルの準備

プラグインで使用するファイルを準備します。
プラグインで使用するファイルのディレクトリ構成およびファイル名は自由です。

PC 用 JavaScript ファイル

PC 画面用の JavaScript ファイルです。
マニフェストファイルで指定されたJavaScriptファイルはeセールスマネージャーに対してグローバルに適用されます。
プラグインで使用するJavaScriptではeセールスマネージャーが提供するAPIを使用することが出来ます。
JavaScriptファイルの記述方法はコーディングガイドラインを参照してください。

Important

UTF-8エンコードのみサポートしています。ファイルが UTF-8エンコードで保存されていることを確認してください。

PC 用 CSS ファイル

PC 画面用の CSS ファイルです。
マニフェストファイルで指定されたCSSファイルはeセールスマネージャーに対してグローバルに適用されます。

Important

UTF-8 エンコードのみサポートしています。ファイルが UTF-8 エンコードで保存されていることを確認してください。

任意のファイル（html, jpeg 等）

PC 画面用の JavaScript ファイル内で任意のファイル（html, jpeg 等）を使用する場合に準備します。
プラグインファイルに格納した任意のファイルは getResourceAPI を使用することで取得することが出来ます。

Info

プラグインファイルに格納可能な 1 ファイルあたりのサイズ上限は 20MB 未満です。

Important

UTF-8 エンコードのみサポートしています。ファイルが UTF-8 エンコードで保存されていることを確認してください。

2. マニフェストファイルの作成

マニフェストファイル（manifest.json）を作成します。
マニフェストファイルは、プラグイン作成に必要なファイル情報をまとめた設定ファイルです。

マニフェストファイルのフォーマット

各パラメーターの詳細は以下の通りです。

パラメーター名	型	必須	説明	制限
version	文字列	必須	プラグインのバージョンを記載します。	上限 500 文字
name	文字列	必須	プラグイン名を記載します。	上限 500 文字
author	文字列	省略可	プラグインの作成者を記載します。	上限 500 文字
description	文字列	省略可	プラグインの説明を記載します。	上限 2000 文字
pc.js	配列（文字列）	必須（pc.css に指定がない場合）	プラグインで使用する JavaScript ファイルパスを記載します。ファイルパスは、ZIP ファイルのルートディレクトリを基準とした相対パスで指定します。	上限 10 ファイル
pc.css	配列（文字列）	必須（pc.js に指定がない場合必須）	プラグインで使用する CSS ファイルを指定します。ファイルパスは、ZIP ファイルのルートディレクトリを基準とした相対パスで指定します。	上限 10 ファイル

マニフェストファイル作成例

マニフェストファイルの作成例です。

{
  "version": 1,
  "name": "サンプルプラグイン",
  "author": "ソフトブレーン株式会社",
  "description": "これはサンプルプラグインです。",
  "pc": {
    "js": ["js/customize.js"],
    "css": ["css/customize.css"]
  }
}

Important

• マニフェストファイルは、JS プラグインの作成に必須です。
• マニフェストファイルのファイル名は「manifest.json」以外使用できません。

3. プラグインファイルの作成

準備したファイル群を zip ファイルに圧縮します。
JS プラグイン機能ではこの zip ファイルのことをプラグインファイルと呼びます。

Important

• 必ず zip ファイル直下に manifest.json を配置してください。

Info

• zip ファイルの上限サイズは 100MB です。

4. eセールスマネージャーにプラグインを公開する

作成したプラグインファイルをeセールスマネージャーに公開します。

Important

eセールスマネージャーでプラグインの設定を行うにはプラグイン設定権限が必要です。事前に管理者に権限付与を依頼してください。

1. 「グローバルメニュー」を開きます。
2. 「システム設定」をクリックします。
3. 「JS プラグイン設定」をクリックします。
4. 「新規登録」をクリックします。
5. 「プラグイン名」「ステータス」「説明」「プラグイン」項目を入力します。

   Info

   「ステータス」項目で「テスト公開」を選択することでプラグインの最終更新者にのみプラグインを適用することが出来ます。 全ユーザーに公開する場合は「ステータス」項目で「公開」を選択してください。

6. 「保存」ボタンをクリックします。

   Warning

   信頼できるプラグインファイル以外は登録しないでください。

7. 「JS プラグイン設定」画面に作成したプラグインが表示されれば成功です。

注意事項

• プラグインの内容によってはeセールスマネージャーにパフォーマンスの低下や不具合が起こる可能性があります。プラグイン登録後、eセールスマネージャーに異常が発生した場合はまず作成したプラグインに問題がないかどうかを確認してください。
• 複数のプラグインをeセールスマネージャーに適用する場合、プラグイン同士が競合する可能性があります。運用に支障がないことを検証したうえでアプリにプラグインを適用してください。
• プラグインなどを利用したカスタマイズに関する内容は、弊社でサポートを行っておりません。プラグインの作成者にご相談ください。
• プラグインの影響でeセールスマネージャーが正常に動作しなくなった場合、クエリパラメータにjsplugin-disabled=trueを付与することによってブラウザでプラグインが実行されない状態にすることが出来ます。