はじめに

Functions のコア機能の1つは、Foundry オントロジーに統合されたデータに容易にアクセスできることです。オントロジーは、組織のデータのセマンティックモデリングを提供し、構造化データへのアクセスを容易にし、ユースケース全体でロジックを再利用することを可能にします。

前提条件

このチュートリアルは、TypeScript リポジトリを作成し設定したことを前提としています。まだの場合は、先にはじめにのチュートリアルを完了してください。

オントロジータイプのインポート

Functionで使用する任意のオブジェクトまたはリンクタイプを、リポジトリを含むプロジェクトにインポートする必要があります。オントロジーインポートのサイドバーに移動すると、プロジェクトにインポートされたオブジェクトタイプが表示されます。

ontology-import-side-panel

ユーザーの組織にはAirportとFlightオブジェクトがない場合があります。利用可能な任意のオブジェクトタイプを使用して進めてください。

追加のオブジェクトタイプをインポートするには、オントロジーインポートのサイドバーで + ボタンを選択し、ユーザーの組織のオントロジー内のオブジェクトタイプを検索するウィンドウを開きます。ここから、オブジェクトタイプとそれらを接続するリンクタイプを選択できます。この例では、AirportとFlightオブジェクトをインポートし、それらを接続するリンクタイプを追加します。

ontology-import-example

Save をクリックして、オントロジータイプをプロジェクトにインポートします。Code Assist は自動的に再起動され、インポートした新しいオブジェクトタイプとリンクタイプを反映するためにコードバインディングが再生成されます。

ユーザーのコードでは、@foundry/ontology-api パッケージからオントロジータイプをインポートできるようになります。プライベートオントロジーを使用している場合、パッケージ名は代わりに @foundry/ontology-api/<ontology-api-name> になります。

プライベートオントロジー

プライベートオントロジーを使用している場合は、以下のすべての例で @foundry/ontology-api を @foundry/ontology-api/ユーザーのプライベートオントロジーAPI名 に置き換えてください。

オブジェクトバックドのFunctionを追加

次に、インポートしたばかりのオブジェクトタイプを使用したFunctionを書いてみましょう。ユーザーのコードは、利用可能なオブジェクトタイプ、プロパティ、リンクタイプに依存します。Code タブに戻り、追加したばかりのオブジェクトタイプの1つをインポートしてみてください：

Copied!1
2
3
// 英語: Import Airport from "@foundry/ontology-api"
// 日本語: "@foundry/ontology-api" から Airport をインポートする
import { Airport } from "@foundry/ontology-api";

次に、そのオブジェクトを入力として取る関数を書きます：

Copied!1
2
3
4
5
6
@Function()
// 公開メソッド 'myObjectFunction'
public myObjectFunction(airport: Airport) {
    airport.
    // 'airport' という名前の Airport オブジェクトを受け取ります。
}

Code Assistが起動したら、単純に airport. と入力するだけで、利用可能なプロパティとリンクタイプのオートコンプリートが表示されます。

autocomplete

この例では、テンプレートリテラルを使用して、Airport の city と country フィールドを組み合わせて、人間が読める場所情報にします。

Copied!1
2
3
4
5
6
@Function()
// 空港の場所を示す関数
public airportLocation(airport: Airport): string {
    // 市と国を結合して戻り値とする
    return `${airport.city}, ${airport.country}`;
}

ユーザーのオントロジーに基づいてAPIを試し、オブジェクトタイプに基づく値を返すFunctionを作成します。

ライブプレビューでテストする

Functionsヘルパーを開き、ライブプレビューに切り替え、上記で作成したFunctionを選択します。ライブプレビューでオブジェクトバックのFunctionを実行するには、オブジェクトタイプのバックデータソースをインポートする必要があります。Runボタンの隣の警告アイコンをクリックします。

helper-datasource-import

次に、ダイアログを使用してオブジェクトタイプのバックデータソースをインポートします。

helper-datasource-import-dialog

データソースをインポートした後、オブジェクトを選択し、Runをクリックして結果を表示します。

helper-preview-run-foo

ライブプレビューの権限

ライブプレビューでのオブジェクトタイプの権限は、各オブジェクトタイプの下にあるバックデータソースのTypeScriptリポジトリの権限によって決まります。通知を作成するFunctionをテストする際、受信者の権限は適用されません。このため、通知を作成するFunctionはライブプレビューで成功するかもしれませんが、Foundryの他の場所でActionに使用されると失敗する可能性があります。

Actionの通知設定については、詳細をご覧ください。

新しいFunctionを公開する

コードをコミットし、Branchesタブを使用して新しいタグを公開することで新しいFunctionを公開します。Functionが公開されたら、Functionsヘルパーを使用してテストすることができます。

helper-run-foo

Functionが公開されたら、プラットフォーム全体の他のアプリケーションで使用を開始できます。

次のステップ

このチュートリアルは、Objects上のFunctionsでできることの一部に過ぎません。詳しくは以下のリソースをご覧ください：

オブジェクトAPIドキュメンテーションを参照して、オブジェクトでできることを学ぶ
オブジェクトセットドキュメンテーションを読んで、オブジェクトの検索とオンデマンドでの集計について学ぶ
プラットフォームでFunctionを使用する方法について学ぶ