KNIME WebPortal用户指南

---

介绍

KNIME WebPortal是KNIME Server的扩展。它提供了一个Web界面，该界面列出了所有可访问的工作流程，使它们能够执行和调查结果。使用Configuration和Widget节点，Interactive Widget和View节点，可以对工作流程的输入和输出进行参数设置并自定义可视化。然后使用 包含这些节点的组件 (opens new window)可以创建WebPortal页面。

此外，使用KNIME报告设计器创建的报告模板及其关联的工作流程一起上传到KNIME Server，可以动态填充数据并以各种格式下载。

可以通过电子邮件提醒工作流程的成功执行，并且报告（如果存在）可以以各种格式附加发送。

为KNIME WebPortal创建工作流程

在KNIME WebPortal上执行的工作流程由一个或多个页面或向导步骤组成，在此页面中，用户将获得整个过程的指导。每个页面或步骤都对应于工作流程中组件的复合视图。有关组件的更全面的说明，请参阅《 KNIME组件指南》 (opens new window)。

复合视图

您可以在组件中创建复合视图，组装不同的Widget节点，Interactive Widget节点和View节点。

创建它们后，您还可以设置其布局的样式，以将它们排列在复合视图中，还可以向布局中添加一些其他元素。这样，您可以决定在KNIME WebPortal中运行它们后如何在页面上对其进行可视化。

小部件节点

节点存储库类别中的节点 可用于创建工作流抽象→窗口小部件，用户可在其中调整参数，然后由工作流使用这些参数来控制节点的执行。

当在通过KNIME WebPortal部署到KNIME Server的工作流中使用时，小部件节点特别有用。当KNIME WebPortal在工作流程中遇到Widget节点时，它会提示用户在继续执行工作流程之前为其变量输入新值。新值将注入到工作流程中，并用于参数化其执行。

您可以创建一个封装一个或多个Widget节点的组件。这样，您可以创建一个复合视图，该视图将成为KNIME WebPortal上的页面。

请参阅 《 KNIME组件指南》的“小部件节点”部分 (opens new window)，以获取小部件节点 (opens new window)的更全面的概述。

查看和交互式小部件节点

节点存储库类别“视图” →“ *JavaScript”*中的节点 也可以用于创建复合视图，然后将其可视化为KNIME WebPortal上的页面。

交互式窗口小部件节点可以与视图节点一起封装在组件中，以在KNIME WebPortal上构建一个页面，其中将视图和交互式窗口小部件组合在一起。

有关如何构建复合视图的概述，请参阅 《 KNIME组件指南》的“ 组件复合视图”部分 (opens new window)。

布局复合视图

您可以自定义复合视图的布局，确定如何在页面上可视化“视图”和“小部件”节点。

	请注意，在KNIME Server版本4.11中，我们引入了旧模式来执行Widget节点。请参阅“旧式窗口小部件 (opens new window)”部分， 以获取有关旧模式的更多信息。

有关如何布局合成视图的概述，请参阅 《 KNIME组件指南》中的“ 布局合成视图”部分 (opens new window)。

单页浏览

在工作流的根级别，组件的每个组合视图都代表KNIME WebPortal中的一页。

	请注意，当在KNIME WebPortal中运行工作流时，不在工作流根目录中的组件（即，包装在组件中的组件）将与页面不对应。

例如，可以用一系列三个组成部分对一系列三个页面进行建模，如图1 (opens new window)所示。

图1.工作流程由三个部分组成

每个组件的组合视图将是KNIME WebPortal中的页面，如图2 (opens new window)所示。

图2.在KNIME WebPortal上分步执行由三个页面组成的工作流

为了在执行期间动态显示和隐藏页面，可以禁用一个组件的复合视图，例如通过IF或CASE块 (opens new window)激活工作流中的停用分支 。

图3.使用IF块的工作流程

如图4 (opens new window) 所示，还可以将组件插入 循环中 (opens new window)以迭代项目集或递归地优化模型。

图4.使用循环的工作流程

创建临时目录

如果要在KNIME WebPortal上写一些数据（以后通过Web链接下载），则可以使用Create Temp Dir节点。

该节点将在唯一的临时文件夹中创建临时文件，并将临时文件的路径作为流变量公开。Writer节点可以将文件写入临时文件夹，而File Download节点可以使写入的文件可供下载。

这是“创建临时目录”节点的配置对话框：

	创建临时目录节点设置：新文件夹的前缀。唯一名称将自动创建。要创建的流变量，包含新文件夹的绝对路径如果启用，则重置节点时（连同所有包含的文件），新创建的文件夹将被删除。在工作流文件夹中创建临时目录创建文件路径添加新的变量和文件引用对于该表中的每一行，都会创建一个新的工作流变量。在左侧输入变量名称，在右侧输入要创建的文件。最终变量将引用完整路径，包括文件夹和文件名。

发布工作流程

通过将工作流程从本地工作空间上载到相应的KNIME Server挂载点，工作流以及任何相关的报告模板（如果存在）将发布在KNIME WebPortal上。

为此，您可以：

1. 将工作流从本地工作流存储库复制/粘贴或拖放到服务器存储库
2. 右键单击工作流程，并选择*部署到服务器...*从上下文菜单中。

在打开的窗口中，如图5 (opens new window)所示，您可以选择服务器存储库。您还可以在上载前重置工作流程时更改服务器的默认选项。为此，请选中或取消选中“在上传之前重置工作流程”选项。

图5.将工作流部署到KNIME Server时的“目标”窗口

可以分配访问权限，以限制对某些用户组的访问。

有关更多信息，请参阅《 KNIME Explorer用户指南》 (opens new window)。

WebPortal浏览器

您可以使用标准的Web浏览器连接到KNIME WebPortal。进入登录页面的地址（URL）为：

https：// <服务器地址> / knime / webportal /

服务器的管理员可能已更改了地址的最后一部分。

提供用户的登录名和密码后，将显示所有可用工作流程的列表。仅显示用户可以读取和执行的工作流程。

	的KNIME Server版本KNIME WebPortal <4.11可用，登录页面是在地址（URL） https:///knime/。

KNIME WebPortal页面

通过KNIME WebPortal可以将上载到KNIME Server的工作流程执行。

使用标准的Web浏览器访问WebPortal，如 WebPortal浏览器部分所述 (opens new window)。

主页

登录后，将显示KNIME WebPortal主页，显示可用空间或工作流程，如图6 (opens new window)所示。

图6. KNIME WebPortal主页

您可以修改KNIME WebPortal的一般外观。《 KNIME WebPortal管理指南》的“主题”部分 (opens new window)提供了有关如何执行此操作的说明。

您可以从KNIME WebPortal中注销，单击KNIME WebPortal右上角的图标。

单击感兴趣的文件夹会将您重定向到一个新页面，如图7 (opens new window)所示， 该空间内所有可用的工作流程都显示在图块中，该图块显示该工作流程的名称以及其说明的预览（如果存在）。您可以单击相应磁贴右上角的黄色“播放”按钮以直接开始执行新作业。

图7.带有工作流磁贴的KNIME WebPortal页面

如果先前执行的作业保留在内存中，则图块中还会显示点和数字。绿点表示成功运行的作业，红点表示失败的作业，橙色点表示需要执行操作的作业中断。

工作流程页面

单击主页上工作流图块的任何其他部分，将打开工作流页面，如图8 (opens new window)所示。

图8.工作流页面

此处显示了工作流程的标题，并且如果在上传工作流程之前已输入元信息，则会在工作流程名称下方显示说明。

您可以选择在工作流运行后通过电子邮件获得通知。在这种情况下，系统将要求您插入电子邮件，如果报告是工作流程的一部分，则将插入您要接收报告的格式。

然后单击“运行”按钮以执行工作流程。一系列网页将会打开，允许您与工作流交互，或者以可视化的结果，根据工作流程组件，如解释 通过网页部分步进 (opens new window)。

所有不同的动作如图9 (opens new window)所示。

图9.在KNIME WebPortal上执行的工作流程的网页

（1）单击右下角的“取消”按钮可随时中断执行。

（2）单击右下角的“下一步”按钮导航到下一页。

（3）单击左下角的“←返回”按钮转到上一页。 在执行结束时单击“关闭”，然后决定要保留还是删除当前结果。当工作流完全执行后，消息“*成功完成”*出现在页面上部。如果在最后一个组件之后执行节点，该消息也会出现。请注意，显示工作流程最后一个组成部分的复合视图的页面无法重新执行。如果有报告可用，您还可以在最后一页下载报告，并选择不同的格式。请参阅KNIME WebPortal和报告部分 (opens new window) 以获取有关它的更多详细信息。

如果您选择不删除已执行的作业，那么结果将在工作流页面中显示，其中包含不同的信息，例如工作流的所有者名称，开始日期和最终状态，如图10 (opens new window)所示。另外，这里还列出了其他正在运行的需要交互的作业或失败的作业。

图10.具有不同已执行作业的工作流页面

您可以稍后在工作流页面上丢弃和删除任何作业，方法是单击与作业执行相对应的行上的三个点，然后从打开的上下文菜单中选择“丢弃”。您还可以在此处将直接链接复制到特定作业的最终结果页面。

在工作流程页面，您也可以点击将链接复制到...，以获取链接到当前工作流的主页面或其网页执行的地址。

	到工作流程执行页面的链接被视为工作流程的基本URL，是参数化的起点，并且 在KNIME WebPortal中直接链接到工作流程 (opens new window)。

KNIME WebPortal页面（版本<4.11）

如WebPortal浏览器部分 (opens new window)所述，旧的WebPortal仍可访问且完全可用。

该功能与KNIME Server的4.11版中可用的新WebPortal略有不同。

有关版本低于4.10的KNIME Server上KNIME WebPortal的完整指南，请检查相应版本的 KNIME WebPortal用户指南 (opens new window)。

KNIME WebPortal和报告

如果将带有报告模板的工作流上载到KNIME Server并通过KNIME WebPortal访问，则在成功执行工作流后将生成并显示报告，如图11 (opens new window)所示：

图11.工作流执行后生成的报告

报告的预览显示在结果页面中，并且html预览可以在新窗口中打开。提供pdf，xls，ppt和docx格式的下载链接。

有关如何使用KNIME报表设计器生成报表的更多信息，请参阅《KNIME报表设计器用户指南》 (opens new window)。

	KNIME Hub (opens new window)上提供了带有报告的工作流示例。

直接链接到KNIME WebPortal中的工作流程

可以直接链接到KNIME WebPortal中的特定工作流程。基本的工作流程URL通常设置为：

http：// <服务器地址> / knime / webportal / <ItemPath>？exec＆<WorkflowParameters>

• ``是工作流，工作流组或工作流作业的路径。使用其ID引用工作流作业，例如： ?exec=job_id
• `` 可以以任何顺序出现，但必须在之后 ?exec
• ?exec 重定向到工作流程的自动执行。

此外，您还可以设置下一部分中 (opens new window)列出的一些参数 。参数始终附加&到基本URL的开头（在之后?exec）。您还可以在KNIME WebPortal中获取工作流程的基本URL，如图12 (opens new window)所示。进入所选择的工作流程页面 (opens new window)，在页面的右上角，点击 将链接复制到... →运行工作流程。

图12. KNIME WebPortal上用于复制工作流URL的工作流页面

可用的网址参数

&pm:= —设置配置参数：将命名的配置参数设置为指定值。多个配置参数对应以逗号分隔。确保每对的值均已正确进行URL / URI编码。请在下一页上查看有关此功能的更多具体说明。

&emails=sample@mail.com —启用电子邮件通知：启用电子邮件通知并设置指定的逗号分隔的电子邮件地址列表。

&formats= —设置报告格式：设置以逗号分隔列表指定的通知电子邮件中包含为附件的报告格式。可用格式为：pdf（默认情况下启用），html，doc，docx，xls，xlsx，ppt，pptx，ps，odt，ods和odp。您的服务器管理员可能已更改此列表，以减少可用选项的数量。

完整的URL可能类似于：

http：// localhost：8080 / knime / webportal / demo / file％20to％20csv？exec＆emails = sample @ mail.com＆formats = .pdf，doc

	请注意，某些字符不能成为URL的一部分（例如，空格）。要对URL进行编码，可以使用任何可用的在线URL编码器工具。

设置配置参数

使用&pm-parameter可以覆盖Configuration节点 (opens new window)的默认值。通过使用与相应节点的配置对话框中“参数名称”字段中设置的名称相同的名称，可以对它们进行寻址。最佳做法是保持这些名称唯一，但是，当工作流程中存在多个相同的参数名称时，可以通过附加节点ID（例如param-name-32:34）来寻址节点。有一些节点需要特殊格式，下面列出了这些节点。

	在正确格式化值之后，请记住要对值进行URI / URL编码。

配置节点	格式备注
日期输入	使用yyyy-MM-ddTHH:mm:ss±HH:mm的日期格式。或者，可以使用“日期和时间”配置节点中支持的其他符合ISO的字符串。
文件选择器	使用绝对knime://协议路径
布尔输入	使用true或false
双输入	使用美国数字符号

要配置，配置节点必须是：

• 根节点，即未包装在组件中
• 源节点，即没有输入传递到该节点。

不可通过URL参数配置的配置节点为：

• 多项选择
• 价值选择
• 列选择
• 值过滤器
• 列过滤器
• 标称行过滤器
• 凭证输入

	所述&pm-parameter可用于KNIME WebPortal版本<4.11，仅覆盖的缺省值Quickform节点 (opens new window)，作为相对在指定的 文档 (opens new window)。

辅助功能支持

KNIME WebPortal提供了对屏幕阅读器软件的完全支持，以及完全的仅键盘访问。

遵循ARIA (opens new window)准则的任何屏幕阅读器 均可用于KNIME WebPortal中的工作。推荐的屏幕阅读器软件包括JAWS（v.16），NVDA（v.2016.3）和ChromeVox（v.53.0.2784.1）。

仅使用键盘即可完全控制KNIME WebPortal，并在键盘导航上实现ARIA最佳做法：

• Tab（Shift + Tab）键将焦点移到下一个（上一个）元素
• Enter键对焦点元素执行默认操作

要使用KNIME WebPortal的UI组件进行操作，可以使用标准快捷方式。有关更多详细信息，请参见 ARIA规范页面 (opens new window)。

组件的旧版模式

旧版小部件节点

从KNIME Server 4.11版开始，我们将Widget节点更改为更新版本。无论如何，都确保了Widget节点的向后兼容性，因此您可以继续使用KNIME WebPortal版本4.11中的Widget节点，其行为和用户界面与KNIME WebPortal版本<4.11中的相同。

	的KNIME Server版本KNIME WebPortal <4.11可用，登录页面是在地址（URL） https:///knime/。

实际上，默认情况下，使用KNIME Analytics Platform 4.1创建的工作流中包含的Widget节点将在旧模式下默认显示。但是，可以更改此选项，以在KNIME Analytics Platform 4.2版中重新打开工作流程，并在“*节点使用和布局”*窗口的“*视觉布局”*选项卡中取消选择“使用旧模式”。

同样，在使用KNIME Analytics Platform 4.2版创建工作流程时，也可以将旧模式用于封装Widget节点的整个组件或单独使用每个节点。

请参阅组件指南， (opens new window) 获取有关在为KNIME WebPortal构建工作流时如何激活/停用旧标记的文档。

Quickform节点

如果工作流包含Quickform节点，则仍将以与早期版本的KNIME Server中相同的方式执行。

但是，我们不鼓励使用Quickform节点，而推荐使用Widget节点。

请注意，旧版Quickform节点将必须分别安装在服务器执行程序和任何设计或执行旧版工作流的客户端上。该插件位于“安装KNIME扩展”对话框中的KNIME和扩展→ KNIME快速表单（旧版）下。

迁移常见问题

在本节中，我们要重点介绍KNIME WebPortal版本4.11中的更改。

与KNIME WebPortal版本<4.11的差异

新网址

• 访问KNIME WebPortal版本4.11 (opens new window)的URL已更改，因此特定工作流程的路径将相应更改。
• 此外，URL参数 (opens new window)的用法 已更改。
  • 该参数&run现在由参数取代?exec。?exec 始终必须是第一个URL参数，后跟其他可用的参数。
  • 出于安全原因，无法再提供用户名和密码以及工作流URL。

主题化

将登录页面设置为KNIME WebPortal的主题与使用KNIME WebPortal的早期版本相同 (opens new window)。有关如何将自己的样式应用于KNIME WebPortal的更多信息，请参阅《 KNIME WebPortal管理指南》的“主题”部分 (opens new window)。

通用JavaScript视图

使用KNIME WebPortal版本4.11时，无法转义通用JavaScript视图的IFrame来更改WebPortal本身的CSS。配置为转义IFrame的通用JavaScript视图将不再起作用。我们也不鼓励在KNIME WebPortal中转义IFrame，因为WebPortal的CSS类在以后的KNIME WebPortal版本中可能会更改。

CSS样式

• 不再支持使用以前的css类 (opens new window)对KNIME Analytics Platform版本低于4.2的样式小部件进行样式化 。但是，仍然可以使用Widget的CSS样式，但是没有记录。我们建议您使用主题 (opens new window)来设置KNIME WebPortal和Widget元素的样式。由KNIME服务器版本<4.11和KNIME Analytics Platform版本<4.2创建的窗口小部件样式仍然可以使用，并且我们确保与旧模式 (opens new window)的使用向后兼容。
• 页面构建器的某些CSS布局选项（即，使用Bootstrap库元素）已不再受支持。 有关可用元素，请参阅 《 KNIME组件指南》中的“复合视图 (opens new window)的布局”部分。

其他迁移变更

• 不再给出与实际存在于KNIME WebPortal上的工作流版本有关的作业中工作流版本的指示。此外，未通过WebPortal启动的作业不会显示在KNIME WebPortal中。请注意，但是，在KNIME WebPortal版本4.11中启动的作业将显示在KNIME WebPortal版本4.11中，反之亦然。