IsoBean模块管理

# FastWeb IsoBean模块管理

# 1. 简介

IsoBean模块的功能界面与设计模式与RestAPI设计是相同的，与RestAPI设计的不同是，IsoBean模块可以绑定Bean模块，从而更方便地利用RestAPI的特性来与Bean模块配合达到设计的效果。且IsoBean提供了配套的监控模块用于对发布的IsoBean模块进行管理。而RestAPI仅作为单纯的API来使用，无配套的监控模块。

# 2. 设置IsoBean模块

点击左侧菜单栏中的 云服务工具-IsoBean模块管理，打开IsoBean模块管理的界面。模块列表中的项会根据分组进行排序，可从表格顶部的筛选框中输入信息来快速查找相关模块。

# 2.1. 操作说明

添加IsoBean

点击 [添加] 按钮，打开添加IsoBean模块对话框，输入IsoBean编号、标题，选择IsoBean的类别，如果当前的IsoBean需引用Bean模块，则需要额外选择要绑定的Bean模块，选择开发用户，讲基本信息输入完成后点击 [保存] 按钮即可。

修改IsoBean

如果需要修改IsoBean模块列表中已有模块的基本信息，选择要修改的IsoBean模块，点击[修改]按钮打开修改IsoBean的对话框，在其中修改模块的信息，修改完成后点击[保存]按钮保存。

删除IsoBean

如需要删除某个IsoBean模块，选择在模块列表中要删除的IsoBean模块，点击[删除]按钮，此时会弹出删除IsoBean模块的提示信息，点击[是]可删除选择的模块，如不需要删除模块，点击[否]。

API设计

选择要设计API的IsoBean，点击 [API设计] 按钮，进入至IsoBean的API设计界面。填写代码后进行测试。关于更多的用法可参考 RestAPI设置程序用法。

Bean设计

Bean设计的内容为绑定的Bean模块的设计，如果

# 2.2. IsoBean引用

IsoBean模块需通过Url参数来引用。引用的Url格式示例如下。

http://localhost:8888/?isobean=isobean-001&paramname=paramvalue&...

可使用的参数见下列表。

参数名称	类型	描述	是否必选
isobean	String	设置IsoBean模块的编号，也可使用IsoBean模块记录的唯一地址	是
token	string	身份认证的令牌，如果IsoBean未勾选免验证令牌的选项，此项为必填项	否
userkey	String	IsoBean运行的用户的ID，如果运行的是图形界面的Bean模块，此项为必填项，在使用IsoBean发布后才可使用	否
language	String	IsoBean显示的语言类型的名称，在多语言环境中适用，不设置此参数会使用简体中文作为默认显示语言	否

其中引用的示例的 paramname=paramvalue 是自行定义的参数，这些自定义的参数可在Bean模块的脚本中获取。通过这种方式，可动态获取参数，在脚本中处理后实时展示。获取参数值的脚本示例如下。

//JScript
// s获取到的Url参数paramname的取值为 paramvalue
var s = URLParams.Values["paramname"];

1
2
3

//PasScript
  s := URLParams.Values['paramname'];

1
2

// Make sure to add code blocks to your code group

IsoBean中支持特殊变量 Var_Bean 、Var_UserKey 与 Var_Language。变量的说明如下。

名称	说明
Var_Bean	Bean模块的GUID或者Bean模块的编号,此参数值从IsoBean绑定的Bean模块信息(GUID或Bean编号)中获取
Var_UserKey	IsoBean发布用户的GUID，此参数值由IsoBean调用的URL参数 `userkey` 中获取
Var_Language	IsoBean显示的语言，此参数值由IsoBean调用的URL参数 `language` 中获取，如参数未设定，默认使用简体中文 `zh-CN`

使用的WEB示例程序代码如下。

//JScript
function RestAPI()
{
  var url;
  url = "/?bean="+Var_Bean + "&userkey=" + Var_UserKey + "&language=" + Var_Language; 
  Result = " <html>"
  + "   <body style=\"margin: 0px;height: 100%;width: 100%;\">"
  + "     <iframe width=\"100%\" height=\"100%\" frameborder=\"no\" border=\"0\" marginwidth=\"0px\" marginheight=\"0px\" scrolling=\"no\" allowtransparency=\"yes\" src=\"" + url + "\"" 
  + "             width=\"100%\""
  + "             height=\"100%\""
  + "     >"
  + "     </iframe>"
  + "   </body>"
  + " </html>";
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

//PasScript
function RestAPI:String;
var
  url: String;
begin
  url := '/?bean='+Var_Bean + '&userkey=' + Var_UserKey + '&language=' + Var_Language; 
  Result := ' <html>'
  + '   <body style="margin: 0px;height: 100%;width: 100%;">'
  + '     <iframe width="100%" height="100%" frameborder="no" border="0" marginwidth="0px" marginheight="0px" scrolling="no" allowtransparency=\"yes\" src="' + url + '"' 
  + '             width="100%"'
  + '             height="100%"'
  + '     >'
  + '     </iframe>'
  + '   </body>'
  + ' </html>';
end;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

// Make sure to add code blocks to your code group

使用的APP示例程序代码如下：

//JScript
function RestAPI()
{
  var url;
  url = "/?bean="+Var_Bean + "&userkey=" + Var_UserKey + "&language=" + Var_Language; 
  Result = " <html>"
  + "<meta name=\"viewport\" content=\"width=device-width\" />"
  + "   <body style=\"margin: 0px;height: 100%;width: 100%;\">"
  + "     <iframe width=\"100%\" height=\"100%\" frameborder=\"no\" border=\"0\" marginwidth=\"0px\" marginheight=\"0px\" scrolling=\"no\" allowtransparency=\"yes\" src=\"" + url + "\"" 
  + "             width=\"100%\""
  + "             height=\"100%\""
  + "     >"
  + "     </iframe>"
  + "   </body>"
  + " </html>";
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

//PasScript
function RestAPI:String;
var
  url: String;
begin
  url := '/?bean='+Var_Bean + '&userkey=' + Var_UserKey + '&language=' + Var_Language; 
  Result := ' <html>'
  + '<meta name="viewport" content="width=device-width" />'
  + '   <body style="margin: 0px;height: 100%;width: 100%;">'
  + '     <iframe width="100%" height="100%" frameborder="no" border="0" marginwidth="0px" marginheight="0px" scrolling="no" allowtransparency=\"yes\" src="' + url + '"' 
  + '             width="100%"'
  + '             height="100%"'
  + '     >'
  + '     </iframe>'
  + '   </body>'
  + ' </html>';
end;

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

// Make sure to add code blocks to your code group

# 3. IsoBean发布

IsoBean发布的功能可以使用户用更快捷的方式打包发布IsoBean项目，亦可随时对发布的IsoBean项目进行管理，或者删除已发布的IsoBean项目。

在 IsoBean模块管理的主界面，点击 [IsoBean发布]，打开IsoBean发布界面。

新增IsoBean发布

左侧的用户列表中选择要新增IsoBean发布的用户，然后点击 [IsoBean选择...] ，打开IsoBean列表，双击要导入的IsoBean发布项目，就可以将项目导入至发布的列表中，下方可查看发布的项目的预设参数信息。点击 [保存] 按钮保存发布设置，点击 [发布] 按钮，将选择的IsoBean项目发布部署。点击 [预览] 按钮，可查看发布的链接，此链接可用于引用。

IsoBean发布的示例链接如下。

http://localhost:8888/?isobean={isobean_code}&userkey={user_guid}&language={Language}&tag={tag}

其中 {isobean_code} 是 IsoBean的编号，{user_guid} 是用户的唯一ID，{Language} 为语言类型。language参数可不使用。{tag} 为识别标记，如果不使用tag则设置默认tag为 0。

# 4. IsoBean专用API

# 4.1. getframemaps

此API可获取当前运行的会话信息。

请求示例如下，以下根据Bean模块编号查询运行的会话列表信息。

http://{url}:{port}/restapi=getframemaps

{url}:{port}表示FastWeb服务器的地址与端口号。

返回的示例如下：

[{"guid":"4Oe1nrPoNl10A5584C2#@@#O74","moduleguid":"78C1CA28-CB4F-4D78-AF2B-4F9C321ECDF7","modulecode":"picture_reco","modulename":"图像识别","moduletype":"BEAN","jsname":"O74","sid":"4Oe1nrPoNl10A5584C2","username":"admin","token":"2160645A7C365D3718F1488571D1D950","createtime":"2022-05-02 10:33:40.000","tag":0,"userkey":"84C2BF69-F6BB-43F4-9869-E705C813F488","isobeanno":null}]

可通过指定Bean模块编号筛选会话信息：

http://{url}:{port}/restapi=getframemaps&modulecode={beanname}

modulecode表示模块编号的参数名称。{beanname} 为要获取信息的模块参数编号。

也可查询用户的所有会话信息：

http://{url}:{port}/restapi=getframemaps&userkey={userguid}

其中的userkey为用户的唯一ID信息。

# 4.2. getconnections

此API用于获取连接的信息。

请求的示例如下：

http://{url}:{port}/restapi=getconnections

返回的示例如下。

[{"sid":"4DczcVjhjh10A557546","guid":"162D55EE688D466C8A8E0A175EE50B2D","nodeid":-1,"createtime":"2022-05-02 09:36:51.000"},{"sid":"y8Ryn3Oxef10A5585A3","guid":"0675B5B45378402C889DA67E06FF06A2","nodeid":-1,"createtime":"2022-05-02 10:36:54.000"}]

# 4.3. getisobeanparams

此API可用于获取IsoBean中用户可使用的参数的信息。

请求的示例如下：

http://{url}:{port}/restapi=getisobeanparams&isobean={isobeanname}&userkey={userguid}

返回的示例如下：

%5B%7B%22fdcheck%22%3Atrue%2C%22fdparamname%22%3A%22imgpath%22%2C%22fdparamvalue%22%3A%22library%5C%2Fjs%5C%2Fml5-library%5C%2Fassets%5C%2Fcat.jpg%22%2C%22fdparamdescription%22%3A%22%E8%AF%86%E5%88%AB%E5%9B%BE%E7%89%87%E7%9A%84%E8%B7%AF%E5%BE%84%22%7D%5D

返回的内容经过URL编码，使用URL解码可恢复为目标格式。

# 4.4. getisobeanlist

此API可获取用户所有可用的IsoBean模块列表。

请求的示例如下：

http://{url}:{port}/restapi=getisobeanlist&userkey={userguid}

返回的示例如下：

%5B%7B%22isobeanno%22%3A%22IB_flying%22%2C%22isobeanname%22%3A%22%E9%87%8D%E5%90%AFFlying%22%2C%22isobeantype%22%3A%22batch%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-20+14%3A36%3A59.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_chatroom_m%22%2C%22isobeanname%22%3A%22%E7%BD%91%E7%BB%9C%E8%81%8A%E5%A4%A9%E5%AE%A4(App)%22%2C%22isobeantype%22%3A%22vision%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-26+16%3A24%3A53.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_wb-vis-0011_radialgauge%22%2C%22isobeanname%22%3A%22%E5%9C%86%E5%BD%A2%E4%BB%AA%E8%A1%A8%22%2C%22isobeantype%22%3A%22vision%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-29+16%3A31%3A27.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_demolist%22%2C%22isobeanname%22%3A%22%E8%8C%83%E4%BE%8B%E6%B1%87%E6%80%BB%E7%9A%84%E8%AF%B4%E6%98%8E%22%2C%22isobeantype%22%3A%22vision%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-25+16%3A30%3A30.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_reportapi%22%2C%22isobeanname%22%3A%22URL%E8%8E%B7%E5%8F%96%E6%8A%A5%E8%A1%A8%22%2C%22isobeantype%22%3A%22report%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-23+09%3A53%3A02.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_ganttchart%22%2C%22isobeanname%22%3A%22%E7%94%98%E7%89%B9%E5%9B%BE%E5%B1%95%E7%A4%BA%22%2C%22isobeantype%22%3A%22vision%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-25+16%3A54%3A30.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_hydren_view%22%2C%22isobeanname%22%3A%22%E7%8E%AF%E7%BB%95%E9%A3%8E%E6%99%AF%E5%B1%95%E7%A4%BA%22%2C%22isobeantype%22%3A%22vision%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-25+17%3A25%3A44.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_report_mancontact%22%2C%22isobeanname%22%3A%22%E7%94%9F%E4%BA%A7%E8%AE%A2%E5%8D%95%E6%8A%A5%E8%A1%A8%22%2C%22isobeantype%22%3A%22report%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-25+22%3A43%3A38.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_picture_reco%22%2C%22isobeanname%22%3A%22%E5%9B%BE%E7%89%87%E8%AF%86%E5%88%AB%22%2C%22isobeantype%22%3A%22vision%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-25+22%3A01%3A46.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_online_document%22%2C%22isobeanname%22%3A%22%E7%BD%91%E7%BB%9C%E6%96%87%E6%A1%A3%E6%B5%8F%E8%A7%88%22%2C%22isobeantype%22%3A%22vision%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-30+16%3A04%3A39.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_process_dashboarddemo1%22%2C%22isobeanname%22%3A%22%E6%9B%B4%E6%96%B0%E5%A4%A7%E5%B1%8F%E5%B1%95%E7%A4%BA1%22%2C%22isobeantype%22%3A%22process%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-04-19+16%3A13%3A38.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%2C%7B%22isobeanno%22%3A%22IB_purorder_edit%22%2C%22isobeanname%22%3A%22%E9%87%87%E8%B4%AD%E8%AE%A2%E5%8D%95%E7%BC%96%E8%BE%91%22%2C%22isobeantype%22%3A%22vision%22%2C%22createuser%22%3A%22admin%22%2C%22createtime%22%3A%222022-05-01+00%3A37%3A34.000%22%2C%22editoruser%22%3A%22admin%22%2C%22editortime%22%3A%222022-05-01+00%3A37%3A34.000%22%7D%5D

返回的内容经过URL编码，使用URL解码可恢复为目标格式。

← IsoBean权限管理 IsoBean运行管理→