# 创建应用
此文档以WorkPlus v4.0
新版本为主,会与3.0
版本的交互有所不同,但创建应用所需要设置的内容基本一致。
此文档只描述轻应用相关的内容。
# 添加内部应用
登录管理后台,选择并进入对应的组织,然后点击应用管理
菜单,从右上角的添加
按钮,选择内部应用
。
# 基本信息
如下图,带红星的字段表示必填,如果没有应用分类
,点击创建分类
进行创建即可。
# 应用启动地址
如下图,启动地址为必填项。
应用启动地址,是比较重要的设置,目前提供3个平台的设置,包括苹果
、安卓
及PC客户端
,其中苹果
和安卓
的设置是一样,而PC客户端
的相对少一些。以下是各字段的各端支持说明:
字段名 | 苹果 | 安卓 | PC 客户端 |
---|---|---|---|
应用参数设置 | 支持 | 支持 | 支持 |
消息通知提醒源 | 支持 | 支持 | 支持 |
启动地址 | 支持 | 支持 | 支持 |
强制安装 | 支持 | 支持 | 支持 |
应用市场显示 | 支持 | 支持 | 支持 |
离线资源包 | 支持 | 支持 | 不支持 |
显示风格 | 支持 | 支持 | 不支持 |
是否全屏 | 支持 | 支持 | 不支持 |
标题栏设置 | 支持 | 支持 | 不支持 |
进度条颜色 | 支持 | 支持 | 不支持 |
使用应用内嵌浏览器 | 不支持 | 不支持 | 支持 |
# 应用参数设置
注意,该参数设置,并非为常见的 URL 上的参数设置,而是作为应用实体的一个属性。通常用于应对特殊的情况,例如设置参数vpn
为 1,即在启动应用之前,会开启 vpn。
提示
该设置并非为通用设置,通常情况下,需要客户端进行定制。
# 消息通知提醒源
该设置,适用于需要做红点提示的应用,例如审批类的轻应用,支持显示红点
、数字
及图标
,具体文档,请查看应用红点。
# 启动地址
顾名思义,就是轻应用的访问地址,通常都是http(s)://
的访问方式。同时,入口支持传入参数占位符,当应用在客户端被打开时,客户端会自行填充参数。
// 设置启动地址如下:
https://test-app.workplus.io?ticket={{ticket}}&language={{language}}
// 当应用启动时,ticket及language会根据当前用户信息及语言进行填充:
https://test-app.workplus.io?ticket=demo-ticket&language=en
支持的参数占位符包括以下属性:
字段名 | 说明 |
---|---|
ticket | 用户ticket,常用于单点登录 |
userId | 用户的 userId |
orgId | 打开应用时,用户所在的组织id |
domainId | 打开应用时,用户所在的域id |
language | 应用的语言类型 |
username | 用户的 username |
关于占位符
因为PC客户端
默认使用下划线的命名方式设置参数的key
值,具体原因可以查看单点登录-获取用户信息,为了保持一致性,请统一使用下划线的key
值,如:
?user_id={userId}&domain_id={domainId}
。
除了设置占位符来获取用户信息,通常为了避免缓存,上架新版本时,可以尝试在启动地址后加入版本信息参数,如下:
https://test-app.workplus.io?v=1.2.0
关于启动地址
首次创建应用,可以同时选择3个平台,安卓、苹果及 PC 客户端,但实际可以填写启动地址只有一处,那是因为创建应用实际也是创建快捷入口的一种,如果各端的访问地址不一样,需要创建应用后,再单独添加对应端的应用快捷入口。
# 离线资源包
离线资源包
设置是移动端特有,需要上传zip
压缩包,并且需要设置相应的启动地址
,具体说明,请查看离线应用。
# 应用权限
应用权限设置,实际就是对应用角色的设置。如下图,共分为3个角色:
- 普通用户,即
使用范围
- 管理员
- 超级管理员
通常开发轻应用,都需要设定普通用户
及管理员
的角色,通过平台提供的应用相关API接口,即可获取到应用对应的角色人员。
# 创建应用入口
应用入口又名快捷入口,一个应用可以创建多个快捷入口,相关设置跟上面提到的基本信息
及启动地址
一致。
# 消息模版
模版消息是一种特殊的消息类型,可以在管理后台进行可视化编辑,保存成功后,可以获得对应的模板ID
。
可以根据实际需求,设定不同的模版消息,具体使用方式,请查看模板消息。
# 添加 ISV 应用
登录管理后台,选择并进入对应的组织,然后点击应用管理
菜单,从右上角的添加
按钮,选择ISV应用
。打开后,将列出可以购买的 ISV 应用,点击获取按钮后会弹出对应的应用信息资料框,然后勾选进行获取即可。
获取成功后,可以在应用管理列表找到该应用,但并不能马上使用,还需给应用设置使用权限,参考应用权限。
离线应用 →