From d6ce4094ef68da0bde23119dca08247ca7579f4b Mon Sep 17 00:00:00 2001 From: pvanderknyff <44209267+pvanderknyff@users.noreply.github.com> Date: Thu, 23 May 2024 14:54:23 -0700 Subject: [PATCH 1/2] Add file type doc --- docs/mcd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mcd.md b/docs/mcd.md index 5f9e29a7..50270c2e 100644 --- a/docs/mcd.md +++ b/docs/mcd.md @@ -52,7 +52,7 @@ Each connection attribute is represented by a field element in the XML. The fiel | name | Unique name of the field: used in the platform, connection-normalizer, and connection-builder | No | Names must be unique
Name is a Tableau-defined name **OR** prefixed with `v-` | If there is a Tableau-defined name for this attribute, that name must be used. See 'Connection Field Platform Integration' section below. | | label | Label that appears on the connection dialog for the field | No | | | | placeholder | Placeholder text displayed as a help message when the field has no user input | Yes | | Only applicable for field of type `string`, `textbox` and `file`. | -| value-type | Dictates the default validation rule and the UI widget | No | Allowed Values: UI Widget Type
`string`: text field
`textbox`: text area
`option`: drop-down
`boolean`: checkbox
| In the 2020.2 and 2020.3 releases `textbox` is not supported.| +| value-type | Dictates the default validation rule and the UI widget | No | Allowed Values: UI Widget Type
`string`: text field
`textbox`: text area
`option`: drop-down
`boolean`: checkbox
`file`: file browser
| In the 2020.2 and 2020.3 releases `textbox` is not supported. File type only available on Tableau Dessktop and will be disabled on Server and Cloud. | | default-value | Default value for the attribute | Yes | Default values by value-type
string: `""`
option: first option
boolean: `false`
file: `""` | | | optional | Whether the user must specify a value for the attribute | Yes | Allowed values: `true`, `false`.
Default value: `false`. | If a field is in the `advanced` category and is not optional, it must be given a default value. | | editable | Whether the user can edit the attribute | Yes | Allowed values: `true`, `false`.
Default value: `true`. | When set to `false`, the attribute is not shown in the connection dialog, and its default-value is passed to the ConnectionBuilder(). | From 68656a3d02392bc4d37aa57045f4166eb403acef Mon Sep 17 00:00:00 2001 From: pvanderknyff <44209267+pvanderknyff@users.noreply.github.com> Date: Thu, 23 May 2024 14:59:44 -0700 Subject: [PATCH 2/2] Update docs/mcd.md Co-authored-by: Ross Brown --- docs/mcd.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mcd.md b/docs/mcd.md index 50270c2e..4472dfe9 100644 --- a/docs/mcd.md +++ b/docs/mcd.md @@ -52,7 +52,7 @@ Each connection attribute is represented by a field element in the XML. The fiel | name | Unique name of the field: used in the platform, connection-normalizer, and connection-builder | No | Names must be unique
Name is a Tableau-defined name **OR** prefixed with `v-` | If there is a Tableau-defined name for this attribute, that name must be used. See 'Connection Field Platform Integration' section below. | | label | Label that appears on the connection dialog for the field | No | | | | placeholder | Placeholder text displayed as a help message when the field has no user input | Yes | | Only applicable for field of type `string`, `textbox` and `file`. | -| value-type | Dictates the default validation rule and the UI widget | No | Allowed Values: UI Widget Type
`string`: text field
`textbox`: text area
`option`: drop-down
`boolean`: checkbox
`file`: file browser
| In the 2020.2 and 2020.3 releases `textbox` is not supported. File type only available on Tableau Dessktop and will be disabled on Server and Cloud. | +| value-type | Dictates the default validation rule and the UI widget | No | Allowed Values: UI Widget Type
`string`: text field
`textbox`: text area
`option`: drop-down
`boolean`: checkbox
`file`: file browser
| In the 2020.2 and 2020.3 releases `textbox` is not supported. File type only available on Tableau Desktop and will be disabled on Server and Cloud. | | default-value | Default value for the attribute | Yes | Default values by value-type
string: `""`
option: first option
boolean: `false`
file: `""` | | | optional | Whether the user must specify a value for the attribute | Yes | Allowed values: `true`, `false`.
Default value: `false`. | If a field is in the `advanced` category and is not optional, it must be given a default value. | | editable | Whether the user can edit the attribute | Yes | Allowed values: `true`, `false`.
Default value: `true`. | When set to `false`, the attribute is not shown in the connection dialog, and its default-value is passed to the ConnectionBuilder(). |