注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

コードエディター

サンセット

Foundry Forms は、Foundry でのデータ入力やライトバックのワークフローに推奨される方法ではなくなりました。代わりに、Foundry オントロジーを使用してユーザー入力のワークフローを構築し、関連するデータ構造をオブジェクトタイプとして表現して、Actions でライトバックのインタラクションを設定します。詳しくは、Forms の概要のドキュメントを参照してください。

コードエディターでは、フォームの YAML 表現を表示して編集できます。ほとんどの設定はビジュアルエディターで行えますが、コードエディターでは、4種類のコード専用フィールドを追加する機能を含め、すべての機能を利用できます。

コードエディターの動作を確認するには、フォーム左下の黒い </> ボタンを選択して開きます。次に、ビジュアルエディターでフィールドを追加します。フィールドを設定すると、コードが自動的に入力され、更新されることを確認できます。

コードエディターの右上にある本のアイコンを選択すると、コードエディターのウィンドウ内で例とドキュメントを直接開けます。

コードエディターとドキュメントを開く。

コード構造

フォームの一般的な構造は次のとおりです。

Copied!1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
name: New form
fields:
  - uri: name
    name: Full name
    type: Text
    # その他の汎用オプション
    options:
      placeholder: 'Last, First'
      # その他の固有オプション
sheets:
  - name: New sheet
    fields:
      - uri: date_of_birth
        name: Date of birth
        type: DatePicker
        options:
          precision: day
      - uri: weight_kg
        name: Weight
        type: Numeric
        options:
          unit: kg

最上位には、name（フォームのタイトル）、fields（フィールドのリスト）、sheets（シートのリスト）があります。各 sheet 自体にも、これらと同じオプションがあります。フィールドには、uri、name、type などの汎用オプションと、placeholder、precision、unit などの固有のオプション（options の下）があります。

汎用オプション

すべてのフィールドに対して、次のオプションを設定できます。

    uri: string
    type: string
    name: string
    urlParam: string
    tag: string
    helperText: string
    infoText: string
    columnSpan: integer
    disabled: Boolean
    hidden: Boolean
    isBlock: Boolean
    noLabel: Boolean
    validators: list<Validators>
    transforms: list<Transforms>

uri: フィールドの一意の識別子です。フィールドを Fusion にライトバックする場合は列名と一致させる必要があり、オントロジーにライトバックする場合はプロパティIDと一致させる必要があります。フィールドをライトバックしない場合は、接頭辞 display. で始まる必要があります。
type: フィールドの種類です（たとえば、Text、Numeric、DatePicker）。
name: フィールドのラベルです。
urlParam: フィールドに関連付けられた URL パラメーターです。これにより、フォームが iframe に埋め込まれている場合に、ユーザーが値を事前入力できます。
tag: フィールドのもう1つの一意の識別子ですが、制限はありません。添付ファイルを除き、あるフィールドが別のフィールドを参照するとき（たとえば、Calculation、Template）に使用される識別子です。
helperText: フィールドの下に表示されるキャプションです。
infoText: フィールドのラベルの横に表示される情報ツールチップの内容です。
columnSpan: フィールドが占める列数です。
disabled: ユーザーがフィールドを読み取り専用にできます。
hidden: ユーザーがフィールドを非表示にしながら、値を記録できます。
isBlock: ユーザーがラベルをフィールドの左側ではなく上に表示できます。
noLabel: ユーザーがフィールドのラベルを非表示にできます。これはコードエディターでのみ利用可能です。
validators: フィールドの検証機能です。
transforms: フィールドの変換です。

コード専用フィールド

コードエディターでのみ利用可能なフィールドは4種類あります。

非表示
リスト
複合
リスト集計

非表示

非表示フィールドでは、フィールドを表示せずに値を記録できます。次のように設定します。

- uri: Hidden
  name: Hidden
  type: Hidden
  options:
    val: string

- uri: names
  name: Full names
  type: List
  options:
    # allowZeroItems: true
    item:
      type: Text
      # その他のサポートされている汎用オプション (helperText, infoText, validators)
      options:
        placeholder: 'Last, First'
        # その他の固有オプション

allowZeroItems は任意で、デフォルトは false です。

複合

複合フィールドでは、複数のフィールドの値を、文字列化した1つの JSON として保存できます。次のように設定します。

- uri: info
  name: Composite
  type: Composite
  options:
    fields:
      - uri: date_of_birth
        name: Date of birth
        type: DatePicker
        # その他のサポートされている汎用オプション (helperText, infoText, disabled, isBlock, noLabel, validators)
        options:
          precision: day
          # その他の固有オプション
      - uri: weight_kg
        name: Weight
        type: Numeric
        options:
          unit: kg

複合フィールド内では、非表示フィールドや複数の値を許可するフィールドは使用できません。

リスト集計

リスト集計フィールドは、計算フィールドやテンプレートフィールドと似ていますが、複数の値を保存するフィールドに対して機能します。次のように設定します。

- uri: single_value
  tag: single_value
  name: Single Value
  type: RadioButtons
  options:
    options:
      - value: '10'
      - value: '20'
      - value: '30'
- uri: multi_values
  name: Multiple Values
  tag: multi_values
  type: Checkboxes
  options:
    options:
      - value: '40'
      - value: '50'
      - value: '60'
- uri: avg_value
  name: Average Value
  type: ListAggregate
  options:
    listOperation:
      operation: mean
      listTag: [single_value, multi_values]
    # errorValue: No values selected

または、複合フィールドと併用する場合は、次のように設定します。

- uri: grades
  tag: grades
  name: Grades
  type: List
  options:
    item:
      type: Composite
      options:
        fields:
          - uri: name
            name: Name
            type: Text
            options:
              placeholder: 'Last, First'
          - uri: grade
            name: Grade
            type: Numeric
            options:
              unit: '%'
- uri: all_grades
  name: All grades
  type: ListAggregate
  options:
    listOperation:
      operation: concatenate
      joinWith: ', '
      listTag: grades
      displayItem: grade
    # errorValue: No grades added

options のフィールドを設定する際の説明は次のとおりです。

errorText は任意で、デフォルトは空の文字列です。
listOperation 内：
- operation には、concatenate、sum、min、max、mean、count を指定できます。
- listTag は、集計対象のフィールドのタグ（またはタグの配列）です。
- joinWith は、操作が concatenate の場合にのみ必須です。
- displayItem は、集計対象のフィールドが複合フィールドの場合にのみ必須で、ネストされたフィールドの URI です。