简介

当要访问CAST仪表盘服务模式（即通过工程仪表盘或CAST RestAPI）时，需要一个特殊的许可证密钥。这个许可证密钥授予对安装web应用（即工程仪表盘或CAST RestAPI）的一个或多个CAST仪表盘服务模式的特定访问权。

此密钥通过标记系统以两种方式限制用户：     

1. 授权访问所有目标CAST仪表盘服务模式中“所有应用”的指定用户都使用一个全局标记——例如架构师
2. 在特定的CAST仪表盘服务模式中，为每个授权访问指定应用的指定用户使用一个单元标记——例如项目负责人

注意

• 许可证密钥没有时间限制，可以无限期的使用。
• 已授予管理员权限的用户不需要许可证密钥来访问CAST仪表盘服务模式。具有管理员角色的用户只能在初始应用启动过程中使用工程仪表盘/RestAPI来验证新快照。管理员角色不能用于工程仪表盘/RestAPI的持续终端用户使用。
• 本文档中讨论的许可密钥与通过CAST 管理器安装的全局许可密钥不同。此全局许可密钥不通过CAST RestAPI授予对CAST仪表盘服务模式的任何访问权。
• 健康仪表盘不受许可证密钥需求的影响，因为仪表盘只与不需要许可证密钥访问的CAST 测量服务模式交互。

获得许可证密钥的方式?

许可证密钥只能由CAST支持生成。请联络负责项目的CAST顾问，或联络账户管理员索取密匙。此密钥通常通过电子邮件发送。

如何安装许可证密钥?

安装许可密钥相对简单：

• 首先创建一个新的空文本文件——可以通过右键单击文件资源管理器并选择New > Text Document来实现
• 重命名新的文本文件license.key——可能会警告更改文件的插件名会导致文件变得不稳定：出现提示时单击Yes。
• 现在在文本编辑器中打开文本文件，并将发送的许可密钥粘贴到第一行。
• 保存license.key文件。  
• 现在复制或移动许可证。关键文件到以下位置，其中是部署工程仪表盘或CAST RestAPI的文件夹的名称，该文件夹需要许可证：

%CATALINA_HOME%\webapps\<web_application>\WEB-INF\license.key

• 在进行任何更改之后，重新启动应用服务器以便更改生效。    

如何检查许可证密钥是否已成功安装?

要检查许可证密钥是否已成功安装在web应用中，可以使用RestAPI接口：

• 打开浏览器，转到下面的网址，确保修改符合环境：

http：//<server>：<port>/<web_application>/static/default.html

• 登录（对任何用户使用基本身份验证字段（不一定是具有ADMIN角色的用户）
• 现在在URI字段中输入“server”，然后单击Submit：

• 结果将显示Response （Pre-view）选项卡。在本例中，可以看到已安装了一个受限的许可证密钥：

注意，可以返回以下状态：

当使用受限制的许可证密钥时，如何授权用户

如果已经安装了一个受限制的许可证密钥（即键指定全球/单位指令）的数量,您可以授权指定用户访问所有应用在所有的目标CAST仪表盘服务模式（全局指令）,或者可以在一个特定的CAST仪表盘服务模式命名的授权用户访问一个应用（单位指令）。

• 此授权是使用以下XML文件实现的，可以在文本编辑器中编辑该文件：

%CATALINA_HOME%\webapps\<web_application>\WEB-INF\license.xml

• 授权是通过在文件中添加一行来实现的。您添加到文件中的每一行都将使用一个全局或单元指令。

授权指定用户访问所有目标CAST仪表盘服务模式中的所有应用

在注释文本下添加以下行，以授予用户“James”访问所有应用的权限。这样做将使用一个全局指令：

<!-- Each following line will consume a global access token -->
<authorization user="James" allApplications="true"/>

在进行任何更改之后，保存license.xml文件并重新启动应用服务器，以便更改生效。

授权指定用户访问目标CAST仪表盘服务模式中的指定应用

在注释文本下添加以下行，允许用户“John”访问存储在“V800_CENTRAL”CAST仪表板服务模式中的“MEUDON”应用。这样做将使用单个单元指令：

<!--Each following line will consume a unit access token -->
<authorization user="John" application="MEUDON" adgDatabase="V800_CENTRAL"/>   

在进行任何更改之后，保存license.xml文件并重新启动应用服务器，以便更改生效。

如果授权的用户多超出许可证数量，那么受限许可密钥上会发生什么情况?

以下列情况为例：

1. 正在使用受限制的许可证密钥（即指定全局/单元指令数量的密钥）
2. 许可证密钥上的全局指令（2个具有所有应用授权的用户）和单元指令（5个具有命名的应用授权的用户）最多只能有2个
3. 可以授权（通过license.xml文件）：      
   1. 3个用户访问所有应用
   2. 访问指定应用的6个用户

在任何一种情况下，都违反了许可证：  

• 在工程仪表盘的每个页面上将显示如下消息：

THIS SOFTWARE IS SUBJECT TO A LIMITED ACCESS.
There are too many authorized users to connect to your Engineering Dashboard.
To avoid this limitation, you can contact your CAST Project Manager to update your licensing terms & conditions.

当收到“限制访问”讯息时，应该怎样做?

如果收到上面描述的消息，有两个选项：

1. 使用license.xml文件检查和重新配置已被授权访问CAST仪表盘服务模式中数据的用户，即减少已被授权访问的用户数量。
2. 联系负责项目的CAST顾问，或者联系账户管理员，请求更新许可证。

如果在没有许可证密钥的情况下尝试访问数据，会发生什么情况?

工程仪表盘

如果用户在没有配置许可密钥的情况下试图登录到工程仪表盘，将显示以下消息：

CAST Rest API

如果直接使用CAST Rest API接口，将被允许登录，但是当试图从CAST仪表盘服务模式检索数据时，将显示403 Forbidden。