配置数据函数

运行数据函数时，必须定义在分析中应如何处理数据函数定义的输入和输出参数。必须指定所有必需参数到 Spotfire 的映射才能在分析中使用数据函数。

开始之前

数据函数已使用安装的 Spotfire 客户端创建完毕，并保存在库中。

参数配置可通过以下方式完成：从“文件和数据”运行数据函数时在浮出控件中完成；或从数据画布编辑输入或输出时在 f(x) 浮出控件中完成；或（仅在已安装的客户端中）通过“编辑参数”对话框完成（该对话框可通过“数据” > “数据函数属性”访问）；在创建和测试数据函数时使用“工具” > “注册数据函数”对话框完成。

注：必须配置所有必需的输入和所有输出（在汇总视图中明确排除的除外），才能运行数据函数。可选输入可以保留不动，不进行配置。

常规配置

确定是否要“自动刷新函数”。
选中此复选框可在每次输入设置发生更改时，自动更新数据函数的结果。如果清除该复选框，则需要手动刷新才能使更新生效。可以从数据画布、已安装客户端中的“数据函数”属性对话框中进行刷新，您也可以添加一个操作控件以从文本区域刷新。

如果在分析中检测到循环依赖，则配置为自动加载的数据函数将切换为手动更新。
如果通过“编辑参数”对话框进行配置，且数据函数使用以下服务之一运行，即 Spotfire® Service for R、Spotfire® Enterprise Runtime for R - 服务器版本（又名 TERR™ 服务）或 Spotfire® Service for Python，您可以确定是否“始终在单独的会话中运行”。

（对于已停止使用的 TIBCO Spotfire Statistics Services 服务器，默认情况下不在会话中重复使用引擎。）

在某些情况下，特定数据函数应该在单独的引擎会话中运行，而不是与其他数据函数一起运行。如果数据函数之间存在包冲突，或者如果包只能使用一次且性能可接受，则可能需要这样做。通过使用此设置，将为数据函数的每次调用创建并关闭一个新的、单独的引擎会话。

请注意，这意味着使用了更多的引擎会话，即使在单个分析用户会话中也是如此，因此可能需要相应地扩展和配置服务，以处理可能增加的所需引擎数。在这种情况下，一种可能有用的配置是增加服务的 engine.queue.size，以避免等待新的引擎会话。但是，这会增加空闲资源的数量。有关详细信息，请参阅有关您的服务允许的引擎的文档。
通过“编辑参数”对话框进行配置时，可以在本地或在服务器上执行数据函数（仅适用于部分引擎），还可以为执行指定“运行位置”。可用选项包括“默认”、“强制采用本地设置”或“强制采用服务器设置”。如果选择“默认”，那么数据函数将使用管理员指定的偏好执行，或者通过使用“工具” > “选项”指定的设置执行。

输入

如果数据函数设计为使用输入参数来确定计算所基于的数据，则必须配置输入项。

举例来说，输入可以是从分析中选择的值、列或数据表。并非所有数据函数都需要输入项，也可能存在可选输入会调整计算结果的情况。由数据函数的作者通过指定输入类型和所需数据来确定必须提供的数据。

提示：如果在选择的数据函数中有许多输入，并且只有其中一些是必需的，则在从

或

浮出控件运行数据函数时，可以单击“始终先显示必需的输入”，将可选输入移动到列表末尾并隐藏。（如果从已安装客户端中的数据函数属性插入数据函数，则用于指定参数的界面外观会有所不同，您可以对“必需”列进行排序。）

为所选参数指定输入时，无法从下面描述的所有输入类型中进行选择；只会看到适用于当前数据函数和分析的选项。

数据表 – 从下拉列表中选择数据表。
（数据表选择器通常是选择一个或多个列之前的第一步，但是，它也可以是单独的输入类型。在这种情况下，输入类型仅列出数据表，其中所有数据类型的列均可作为数据函数的输入。如果在列表中找不到所需的数据表，可以使用“列”选项从特定数据表中选择允许的数据类型的所有列。）
列 – 使用下拉列表从指定的数据表中选择一个列。
列 –　在“选择列”对话框中选择一个或多个列。
搜索表达式 – 根据搜索表达式选择多个列（按 Enter 键执行搜索）。如果要选择多个以相同字母开头的列，则此选项很有用。
（在“编辑参数”对话框中，这是“列”输入处理程序下的一个选项。）
自定义表达式（“编辑参数”中的“表达式”）- 在“编辑表达式”对话框中指定您自己的表达式。
（如果必须从数据表或列属性中添加输入值，或要定义自己的选择，则从“文件和数据”浮出控件或 f(x) 浮出控件添加数据函数时，请使用此选项。）
值 – 键入输入值。该值通常带有一个数据类型选择器，可以在其中更改输入值的数据类型。
文档属性 – 选择要用作输入的文档属性。使用搜索字段可帮助您查找属性。
无 – 未选择任何输入处理程序或不存在默认处理程序。它可以用于可选输入参数。如果输入参数为必填项，则必须指定一个输入才能继续。

“受限于”选项允许您将基于列值或数据表的计算限制为仅与指定的筛选和标记组合相匹配的行。如果选择了多个选项，会对仅符合选定筛选和标记的交集的行执行计算。不要在所有行的基础计算上添加任何限制。

提示：当数据函数实例已添加到分析中，并且输出是图表中使用的列或行时，可以直接在图表中调整输入值，并快速尝试不同的输入值。您还可以从“数据画布”中的数据函数视图编辑输入和输出参数。

输出

输出的配置决定了如何处理计算结果。例如，您可能会获得一个新的数据表、新的列或行，或者一个可用于在图表中定义行的文档属性值，或类似的内容。可用的输出类型取决于所选数据函数的输出（值、列或表）以及分析中当前具有的内容。例如，如果在运行数据函数时分析中没有数据表，则您唯一的选择就是添加新的数据表。有了数据表后，便可选择更多选项。

添加为新数据表 – 创建一个新数据表。
作为行添加到指定的数据表。有关详细信息，请参见将行添加到数据表。
作为列添加到指定的数据表（使用联接操作）。有关详细信息，请参见将列添加到数据表。
（仅当从或运行数据函数时可用。）
作为计算列添加到所选（最终）数据表中（“编辑参数”中的“列”）。
如果您选择将输入限制为仅标记或筛选的行，则使用“针对以下项将结果映射到受限的行”（或“编辑参数”中的“映射到输入行”）选项可以指定应如何将结果值添加到数据表中。如果清除此复选框，则结果将被添加到指定数据表的第一行中，但是如果您选择仅计算筛选值的结果，则可能需要将结果添加到执行计算时筛选出的那些行。从下拉列表中选择要匹配的输入参数。
替换数据表 – 通过从下拉列表中进行选择来替换之前添加的数据表。
在分析中添加为文档属性值。您可以定义一个新属性或更新一个现有属性。请注意，如果定义一个新属性，则只有在数据函数的执行成功完成后才能创建该属性。
添加为数据表属性值 – 选择一个数据表并创建或更新数据表属性。
添加为列属性值 – 选择一个数据表、该数据表中的列，并创建或更新列属性。
无 - 未选择任何选项（仅在“编辑参数”中可用）。要继续操作，必须指定如何处理至少一个输出。从 f(x) 或 + 浮出控件添加数据函数时，您可以选择排除特定输出。