GetFieldsOnLayout

レイアウト上のフィールド一覧を JSON データとして返します。

構文 

GetFieldsOnLayout ( レイアウト名 )

引数 

レイアウト名 - レイアウトの名前を表すテキスト式。レイアウト名が空の文字列 ("") の場合、現在のレイアウトが使用されます。

戻り値のデータタイプ 

テキスト

起点バージョン 

22.0

説明 

この関数は検索に使用できる指定されたレイアウト上のフィールドに関する情報を含む JSON オブジェクトを返します。

次の条件のいずれかを満たすフィールドは除外されます:

• フィールドオブジェクトがレイアウト領域の外側にある (レイアウト上のフィールドの配置と削除を参照してください)。

• [次の場合にオブジェクトを隠す] の条件が満たされていて [検索モードで適用] が選択されている (レイアウトオブジェクトの表示と非表示を参照してください)。

• [フィールド入力] で、[検索モード] が選択されていない (フィールドへの入力の許可と禁止を参照してください)。

• [クイック検索にフィールドを含める] が選択されていない (クイック検索の設定を参照してください)。

• 現在のアカウントのアクセス権セットに表示アクセス権 (読み取りアクセス) が許可されていない (レコードアクセス権の編集を参照してください)。

• フィールドが集計、グローバル、またはオブジェクトフィールドである (集計フィールドの定義、グローバルフィールド (グローバル格納を使用するフィールド) の定義、およびオブジェクトフィールドについてを参照してください)。

返される JSON オブジェクトの構造は次のとおりです:

{
    "layout_name": "レイアウト名",
    "fields": {
        "テーブルオカレンス::フィールド名 1": {
            "type": "string",
            "description": "フィールドコメント (オプション)"
        },
        "テーブルオカレンス::フィールド名 2": {
            "type": "number"
        }
    }
}

• layout_name キーにはレイアウトの名前が含まれます。

• fields オブジェクトには使用できる各フィールドのキーと値のペアが含まれます。

• 各フィールドのキーは完全修飾名です (例: テーブルオカレンス::フィールド名)。

• 各フィールドの値は type キーを含むオブジェクトです (フィールドのデータタイプが数字の場合は number、それ以外の場合は string)。

• フィールドに [データベースの管理] ダイアログボックスのコメントがある場合、オプションの description キーが含まれます。テーブル内のいずれかのフィールドコメントが [LLM] で始まる場合、[LLM] で始まるコメントのみが表示され、[LLM] 接頭語は description の値から取り除かれます。

メモ 

• この関数は [自然言語で検索実行] スクリプトステップと同じ条件を使用して検索で使用できるフィールドと返されるフィールド情報を決定します。

例 1 

「製品」レイアウト上の検索に使用できるフィールドを記述する JSON オブジェクトを返します。

JSONFormatElements (GetFieldsOnLayout ("製品"))

「製品」レイアウトに次のフィールドがある場合:

関数は次の値を返します:

{
    "fields" : 
    {
        "製品::製造日" : 
        {
            "description" : "製品の製造日",
            "type" : "string"
        },
        "製品::価格" : 
        {
            "description" : "製品価格",
            "type" : "number"
        },
        "製品::製品ID" : 
        {
            "description" : "製品を固有に識別する主キー",
            "type" : "number"
        },
        "製品::製品名" : 
        {
            "description" : "製品のわかりやすい名前",
            "type" : "string"
        },
        "製品::状況" : 
        {
            "type" : "string"
        }
    },
    "layout_name" : "製品"
}

少なくとも 1 つのフィールドコメントは [LLM] タグで始まるため、[LLM] タグのあるフィールドのみに説明が含まれています。「g_ユーザのお気に入り」フィールドは検索に使用できないグローバルフィールドであるため、完全に省略されます。

例 2 

現在のレイアウト上のすべてのフィールドの一覧および検索に使用できるフィールドの一覧を返します。これにより検索で使用できないフィールドを確認することができます。

Let (
[
    layoutFields = FieldNames (Get (ファイル名) ; Get (レイアウト名)) ;
    findFields = JSONListKeys (GetFieldsOnLayout (Get (レイアウト名)) ; "fields") ;

    sortedLayoutFields = SortValues (レイアウトフィールド ; 1) ;
    sortedFindFields = SortValues (検索フィールド ; 1) ;

    $$result = "現在のレイアウト上のすべてのフィールド:" & ¶ & sortedLayoutFields & ¶ & 
    "これらのうち、検索に使用できるフィールド:" & ¶ & sortedFindFields
] ;
$$result
)

「製品」レイアウトの $$result に保存される可能性のある出力:

現在のレイアウト上のすべてのフィールド:
製造日
写真
価格
製品ID
製品名
状況

これらのうち、検索にアクセスできるフィールド:
製品::製造日
製品::価格
製品::製品ID
製品::製品名
製品::状況

関連項目 

• 関数リファレンス

• 関数について

• 計算式について

• [自然言語で検索実行] スクリプトステップ