名前

サーバーサイドコマンドの名前を設定します。

非公開のサーバーサイドコマンドでない場合、呼び出し用のURLが表示されます。アクセス許可の設定が「誰でも」に設定されている場合には、本URLを使用して外部アプリケーションや外部プログラムからサーバーサイドコマンドを実行することが可能です。

以下にURLの例を示します。

アプリケーションのURL：http://example.com/app1

サーバーサイドコマンドの名前：mycommand1

呼び出し用のURL：http://example.com/app1/ServerCommand/mycommand1

サーバーサイドコマンド内でパラメーターが定義してある場合、GETメソッドではクエリ文字列（URLパラメーター）を使用してパラメーターを指定します。

パラメーター名：title

パラメーター名:content

呼び出し用のURL：http://example.com/app1/ServerCommand/mycommand1?title=通知メール&content=これはテストメールです。

パラメーターとして定義されていない場合であっても、クエリ文字列（URLパラメーター）を指定した場合にはそれらはパラメーターとしてサーバーサイドコマンド内で自動的に作成され、使用することができます。

説明

作成したサーバーコマンドがどのような処理を行うかなど、説明を記述しておくことができます。説明はコマンドのコメントと同様に主に後継の開発者の理解を助けるためのものであり、サーバーサイドコマンドの動作に影響するものではありません。

非公開

本チェックオプションを有効化した場合、通常のコマンドの「サーバーサイドコマンド呼び出し」を使用してそのサーバーサイドコマンドを実行することができなくなります。ほかのサーバーサイドコマンド内でのみ使用されるサーバーサイドコマンドについては、本チェックオプションを有効に設定することをお勧めします。

また、スケジュールタスクから呼び出すサーバーサイドコマンドの場合、本チェックオプションを有効にすることが必須条件となります。

アクセス許可の設定

通常のコマンドの「サーバーサイドコマンド呼び出し」を使用してそのサーバーサイドコマンドを実行する場合に、実行可能なロールを指定します。「誰でも」をチェックしている場合、そのサーバーサイドコマンドは外部アプリケーションや外部プログラムからURLによる呼び出しで実行が可能となります。セキュリティの観点から、本設定に「誰でも」を指定しないことを推奨します。

アクセス許可の設定が「誰でも」以外の場合、OAuthクライアントの設定を行うことで外部アプリケーションからの呼び出しが可能です。詳細についてはセキュリティの「外部連携」部分を参照してください。

使用するHTTPメソッドの種類

そのサーバーサイドコマンドがサポートする呼び出し時のHTTPメソッドの種類を指定します。「GET」に設定した場合、通常のコマンドの「サーバーサイドコマンド呼び出し」を使用して呼び出すことはできません。

Forguncy Builder上でサーバーサイドコマンドをテスト実行します。

1. テスト実行とユーザー選択

   ［テスト実行］ボタンをクリックすると以下のダイアログが表示されます。サーバーサイドコマンドをテスト実行したい権限を持ったユーザーを選択します。

   

2. パラメーターの入力

   サーバーサイドコマンドにパラメーターがある場合、ダイアログボックスにはサーバーサイドコマンドのパラメーターが表示され、テスト実行時のパラメーターの値を入力できます。

   

   配列型のパラメーターの場合は、パラメーターの値はJSON文字列で入力します。

   配列の個数が1つの場合は、「{"prop1":"string","prop2":"string"}」のように値を入力します。複数個ある場合は「[{"prop1":"string","prop2":"string"},{"prop1":"string1","prop2":"string1"}] 」のように入力します。

   

3. タイムアウト

   サーバーサイドのコマンドをテストする場合、Forguncy Builderはサーバーにリクエストを送信してサーバーサイドコマンドを実行します。
   時間のかかる処理を実行する場合、実行時間が既定のタイムアウト時間を超えると、リクエストタイムアウトエラーが発生します。このような場合タイムアウト時間を長く設定することが可能です。タイムアウトの既定値は100秒です。

   

4. テスト結果

   ［テスト実行］ボタンをクリックするとテストが完了するまで進行状況ウィンドウが表示され、テストが完了するとテスト結果のダイアログが表示されます。結果ダイアログボックスにはリターンコードとログが表示されます。ログの内容は「Ctrl + C」でクリップボードにコピーできます。［］アイコンのクリックでログのすべての情報をコピーすることもできます。

   

   なお、テスト実行には100秒のタイムアウトが設定されており、100秒経過するとダイアログで「タスクが取り消されました」と表示されます。このタイムアウトはForguncy Builderの操作が長時間ブロックされることを避ける目的で設けられており、タイムアウトが発生してもテスト実行した処理が中止されることはありません。