Server Code の管理

サーバー機能拡張の管理作業のため、Kii Cloud では コマンドラインツール を提供しています。

コマンドラインツールの利用

コマンドラインツールを使うと、サーバー機能拡張の管理に関連して、開発用 PC から以下のような操作を行うことができます。使用方法の詳細は Server Code を管理する をご覧ください。

  • Server Code および Server Hook 設定ファイルの設置

    開発 PC 上に準備した Server Code(JavaScript のプログラムソース)と、Server Hook 設定ファイル(JSON ファイル)を Kii Cloud にアップロードします。逆にダウンロードすることもできます。

  • バージョンの管理

    登録された Server Code と Server Hook 設定ファイルをバージョン管理し、特定バージョンの有効化や削除などの操作を行います。バージョン管理の詳細は、下記の Server Code のバージョン管理 で説明します。

  • 開発者ログの参照

    コマンドラインツールを使うと、Server Code からデバッグ用に出力されたログを参照できます。Server Code からの API による出力方法の詳細は 開発者ログへの出力 を参照してください。

    なお、このログの参照機能はサーバー機能拡張専用のものではなく、クライアント SDK からの実行結果も含まれています。使用方法全般については、開発者ログの閲覧 をご覧ください。

  • スケジュール実行履歴の参照

    コマンドラインツールから、Server Hook(スケジュール起動)の実行結果を取得できます。自動実行が成功したかどうかや、Server Code からの戻り値を確認できます。詳細は スケジュール実行の結果取得 をご覧ください。

なお、攻撃者による不正なサーバー機能拡張の操作を防止するため、コマンドラインツールの使用には ClientID と ClientSecret が必要です。これらはアプリケーションの管理者だけが持つ アクセスキー です。

Server Code のバージョン管理

Kii Cloud では、Server Code と Server Hook 設定ファイルのセットを 1 つのバージョンとして管理する機能を提供しています。過去のバージョンへの切り替えもコマンド 1 つで実行できるため、Server Code に不具合が発見されたときに、迅速に過去のバージョンに戻すことができます。

バージョン管理で切り替えの対象となるのは、アプリケーション内で作成されたサーバー機能拡張全体です。つまり、アプリケーション内で使用する Server Code すべてが記述されたファイル 1 件と、その Server Hook の設定が記述されたファイル 1 件のセットを 1 つのバージョンとして管理します。複数のエンドポイントを持つ場合や、Kii Cloud で提供されていないライブラリを利用する場合、これらのソースコードを 1 つのファイルにまとめます。同様に、対応する Server Hook 設定ファイルも 1 つにまとめます。

ある時点で有効な Server Code は 1 つのみです。新しい Server Code を設置すると、それがデフォルトバージョンとして設定され有効化されます。この際、以前設置していた Server Code は古いバージョンとして無効化されます。手動実行や自動実行での実行対象はデフォルトバージョンとなります。

Server Code と Server Hook 設定ファイルを Kii Cloud に登録すると、Kii Cloud からはバージョンを表す gulsdf6ful8jvf8uq6fe7vjy6 のようなコードが発行されます。有効なバージョンを切り替えたり、登録済みのバージョンを削除したりする場合はこのコードを使用します。