構成ファイルの形式

1つ以上の統合の定義がJSON形式で単一の構成ファイルに格納されます。

AIF構成ファイルの拡張子は、.confである必要があります。

開発者は、構成ファイルをアップロードしてユーザーが使用できるようにすることができます。「アプリケーション統合フレームワーク(AIF)の理解」を参照してください。

ノート:

「プライベート・インスタンス」またはアクセスが制限されているネットワーク環境を使用する場合は、任意のカスタム・アクションを使用できるように、サード・パーティのロケーションへのアクセス権をユーザーに提供する必要があります。

次に、あるアプリケーションの構成ファイルのサンプルを示します。構成のキーおよび値はすべて、大文字と小文字を区別します。

{
	"id": "ExampleCoPublishing",
	"name": "APP_SUBMIT_TO_PUBLISH_DOCS_NAME",
	"description": "APP_SUBMIT_TO_PUBLISH_DOCS_DESC",
	"category": "CUSTOM",
	"supportEmail": "support@example.com",
	"baseUrl": "http://www.example.com/",
  "info": {             
     "documentation": "Opens a URL with a description of the app in a popup window",
	},
  "info": {
		"presentation": {
			"view": "POPUP"
		},
		"invoke": {
			"method": "GET",
			"url": "http://www.example.com/ExampleCoDescr.jsp",
			"data": ""
		}
	},
	"tenantPrefs": {
		"presentation": {
			"view": "POPUP"
		},
		"invoke": {
			"method": "GET",
			"url": "http://www.example.com/ExampleCoAdmin.jsp",
			"data": ""
		}
	},
	"userPrefs": {
		"presentation": {
			"view": "POPUP"
		},
		"invoke": {
			"method": "GET",
			"url": "http://www.example.com/ExampleCoUser.jsp?user={user.id}",
			"data": ""
		}
	},
	"actions": [
		{
			"id": "submitToPublish",
			"name": "ACTION_SUBMIT_TO_PUBLISH_NAME",
			"description": "ACTION_SUBMIT_TO_PUBLISH_DESC",
			"type": "UI",
			"trigger": "MENU",
			"presentation": {
				"view": "POPUP",
				"popupWidth": 700,
				"popupHeight": 400
			},
			"evaluate": "type=='folder' && user.isMember && user.role=='owner' && !isReservedByAnotherUser",
			"invoke": {
				"method": "GET",
				"url": "http://www.example.com/ExampleCoSubmit.jsp?user={user.id}&ids=[{id},]&names=[{name},]"
			},
			"multi": false
		},
		{
			"id": "showPublishStatus",
			"name": "ACTION_SHOW_PUBLISH_STATUS_NAME",
			"description": "ACTION_SHOW_PUBLISH_STATUS_DESC",
			"type": "UI",
			"trigger": "SELECT",
			"presentation": {
				"view": "POPUP",
				"popupWidth": 300,
				"popupHeight": 200
			},
			"evaluate": "type=='file' && user.isMember && user.role=='owner' && _.contains(['doc','','docx','xls','xlsx','ppt','pptx','tif','png'], extension) && (_.isEmpty(reservedById) || reservedById === user.id)",
			"invoke": {
				"method": "GET",
				"url": "http://www.example.com/ExampleCoSubmit.jsp?user={user.id}&ids=[{id},]&names=[{name},]"
			},
			"multi": false
		},
		{
			"id": "publishDirect",
			"name": "ACTION_PUBLISH_DIRECT_NAME",
			"description": "ACTION_PUBLISH_DIRECT_DESC",
			"type": "DIRECT",
			"trigger": "MENU",
			"presentation": {
				"view": "CLIENT",
				"popupWidth": 500,
				"popupHeight": 100
			},
			"evaluate": "type=='folder' && user.isMember && user.hasPrivilegesAs(item, 'owner')",
			"invoke": {
				"method": "GET",
				"url": "http://www.example.com/ExampleCoMenuAction.jsp"
			},
			"multi": false
		}
	],
	"stringsMap": {
		"en": {
			"APP_SUBMIT_TO_PUBLISH_DOCS_NAME": "ExampleCo Publishing Technical Articles",
			"APP_SUBMIT_TO_PUBLISH_DOCS_DESC": "Submit an article for the ExampleCo technical knowledge base.",
			"ACTION_SUBMIT_TO_PUBLISH_NAME": "Publish",
			"ACTION_SUBMIT_TO_PUBLISH_DESC": "Submits the selected document for review and approval to ExampleCo publishing.",
			"ACTION_SHOW_PUBLISH_STATUS_NAME": "Select ExampleCo",
			"ACTION_SHOW_PUBLISH_STATUS_DESC": "Shows currently selected row info in ExampleCo Publishing",
			"ACTION_PUBLISH_DIRECT_NAME": "Audit",
			"ACTION_PUBLISH_DIRECT_DESC": "Sends an audit event to ExampleCo when document is selected"
		}
	}
}

アプリケーション統合フレームワークでは、JavaScript underscoreライブラリ(http://underscorejs.org)の単純な使用がサポートされますが、AIFではunderscore関数のパラメータとして関数を定義することはできません。

次の各項では、アプリケーション統合フレームワークの機能領域について説明します。

機能領域	説明
アプリケーション・プロパティ	アプリケーション・プロパティについて説明します。
Actionコマンド	`action`コマンドの一般的な要素について説明します。 `action`コマンドを使用して、タスクをトリガーおよび開始する方法を指定します。 `action`コマンドの`invoke`および`presentation`コンポーネントは、各自のセクションに表示されます。
Invokeコマンド	`invoke`コマンドの要素について説明します。 `invoke`コマンドを使用して、サード・パーティのサービス、ページまたはスクリプトをコールします。
Presentationコマンド	`presentation`コマンドの要素について説明します。 `presentation`コマンドを使用して、`invoke`コマンドによって取得されたサード・パーティ・コンテンツをユーザーに表示する方法を指定します。
式	`invoke`および`evaluate`コマンドで使用される式の例および一般情報を示します。
変数	使用可能なアイテム変数とユーザー変数、`permissions`オブジェクトと`status`オブジェクト、およびAIF関数について説明します。
ローカライゼーション	翻訳されたラベルおよび説明を使用したアプリケーションのローカライズ方法に関する例と一般情報を示します。