1. 参数
HENGSHI SENSE提出了参数概念,主要是为了实现应用的灵活控制。 之前需要修改多个地方才能实现的应用版本功能。通过创建参数后仅修改一处就解决了所有问题。
参数可以实现:
- 数据集的参数化创建
- 权限的参数化控制
- 仪表盘/图表的参数化出图
- 参数控制器参与仪表盘布局
1.1. 参数操作
参数常见的操作有新建参数、编辑参数、删除参数和参数分组。
1.1.1. 新建参数
按照下面指导创建一个参数。
- 点击应用->参数中的新建参数,弹出新建参数对话框。
- 填写参数名称、选择参数类型。参数类型支持文本、数字、日期、时间。
- 设置参数的允许值和默认值。示例中允许使用了固定列表,手动输入1-31作为值,默认值选取了数据集
来电明细1
中的来电开始日期(日)
字段。 - 参数创建完成。
参数创建过程比较简单,但因为其使用灵活性,所以参数在设置和使用上比较复杂。请阅读参数了解参数详细的功能设置,并阅读参数使用场景了解参数的应用场景。
说明
- 参数可以在应用创作中创建,也可以在数据集市中创建。
- 参数作用范围是该应用或该数据包中的数据集,这些数据集在创建图表、行权限等场景下都可以使用参数。
1.1.2. 编辑参数
点击参数列表中的三点菜单,在弹出菜单中选择编辑参数
,就可以弹出编辑参数弹窗,对参数进行修改。
如果参数已经被使用,重新编辑时可能会遇到以下情况:
- 编辑参数名称时,在表达式中使用参数的地方都会报错,提示参数xxx不存在。
- 编辑参数类型时,使用参数的地方会出错。
- 不修改参数名称和参数类型,而只是修改参数可选值,则不会报错。
1.1.3. 删除参数
点击参数列表中的三点菜单,在弹出菜单中选择删除
,可以删除参数。
1.2. 参数设置
每个参数由四部分组成:参数名称、参数类型、允许值和默认值。
- 参数名称: 即参数的名字。
- 类型:参数类型分为文本、数字、日期、时间四种类型。
- 允许值:参数的允许值支持任意、列表和范围三种形式。
- 任意: 表示参数可以取该类型的任意值。如:文本参数可以取任意文本作为参数值,数字参数可以取任意数字做参数值。
- 列表: 表示参数的允许值是列表,使用参数时需要从列表中取值。
- 范围: 表示参数的允许值是范围,使用参数的取值需要满足范围。其中文本类型无范围取值。
- 默认值: 参数创建后都需要配置默认值,保证用户使用时参数不为空。默认值设置方式与允许值和参数类型有关。
下面详细介绍各类参数的允许值和默认值的设置。
1.2.1. 任意
当参数允许值选择任意类型时,表示参数可以取该类型的任意值。如:文本参数可以取任意文本作为参数值,数字参数可以取任意数字做参数值,日期参数可以选择任意日期作为参数值,时间参数可以选择任意时间作为默认值。
当允许值为任意时,其默认值支持固定值、动态值和相对值(文本参数和数字参数无相对值)。
- 固定值:由手动编辑具体值作为参数值,参数使用时默认值固定不变。
- 动态值:从该应用中所有数据集中选取相应类型的字段作为默认值,当数据集字段的取值变化时,参数默认值随之发生变化。如图所示,文本参数选取该应用中
来电明细1
数据集中的选择服务
字段作为默认值,默认值为按键1
,当字段内容变化时,默认值也会变化。 - 相对值:日期参数和时间参数的默认值可以设置相对值。相对值时随着时间而变化。如图所示,时间参数的默认值设置为相对日期
前1天
。当系统日期为1月2日时,参数默认值为1月1日,当系统日期为1月3日时,参数默认值为1月2日。
1.2.2. 列表
当参数允许值选择列表类型时,表示参数使用时需要从列表中取值。参数列表包含值和显示值。展示时使用显示值,实际运算过程中使用值的内容。显示值可以选择配置。不配置时,展示的是值的内容。
列表支持固定和动态两种配置方式。
固定列表
固定列表即列表内容是固定不变的, 支持手动输入和从字段中取值。
手动添加: 即手动编辑列表的值和显示值。
从字段中添加值:从数据集中选择相应类型的字段作为列表值,支持添加一个或多个字段。添加到列表中的值支持编辑和修改。 值添加完成后,显示值需要手动编辑。
动态列表
动态列表是从数据集中选择相应类型的字段作为列表值,仅支持添加一个字段。值添加后,可以添加显示值。 显示值是从同一数据集中的其他字段中选择一个字段,并且要求该字段与值的字段内容一一对应。
说明:
动态列表中的值和显示值是数据集中的字段内容,如果该数据集设置了行权限,不同权限的用户看到的参数值不同。
列表默认值
列表默认值支持固定选项、动态选项、动态项三种设置方式。
- 固定选项:从列表中选择固定的选项内容作为默认值。
- 动态选项:指定列表中的第N项作为默认值,列表顺序变化时默认值也随着变化。
- 动态项:从该应用中所有数据集中选取相应类型的字段作为默认值,当数据集字段的取值变化时,参数默认值随之发生变化。如果动态项的值不在列表内时,参数创建失败,需要重新选择默认值。
参数多值
当参数允许值为列表时,参数可以开启多值功能。可以设置参数多值的分隔符、起止符、前后缀。参数多值开启后,可以设置多个默认值。
1.2.3. 范围
当参数的允许值是范围时,表示参数的取值满足范围要求。文本参数无该类型。
数字参数范围值
数字参数的范围值可以设置最小值、最大值和步长。 步长表示两个合法值之间的差值,可以选择设置,默认值为1,不能超过最大值与最小值的差。如图所示,最小值为5,最大值为100,步长为1时,参数范围内的合法值为5、6、7、8... 100。 如果步长为95,则参数范围内的合法值仅包含5和100。
默认值设置支持固定值和动态值两种方式。
固定值: 输入范围内的数值作为默认值,如果输入值超出范围会自动修正到边界值。如果设置步长,输入值不在范围内,但在最小值和最大值之间时会自动修正到前一个范围值。如图所示,参数范围值为0,3,6...99,当输入为5时,会自动更正为3。
动态值: 从该应用中所有数据集中选取数字类型的字段作为默认值,当数据集字段的取值变化时,参数默认值随之发生变化。如过字段值不在范围内,参数会报错。
日期参数范围值
日期参数的范围值需要设置开始日期、结束日期和步长。步长可以选择设置,单位为天、周、月、季度、年
。步长设置后,会提示范围内有多少个步长。
默认值设置支持固定日期、相对日期和动态值。
- 固定日期:从范围中选择日期作为默认值。
- 相对日期:默认值设置为相对于系统当前日期。
- 未设置步长时,相对日期设置时可以调整时间单位,如图所示。如果默认值不在时间范围内会自动修正。
- 设置步长后,相对日期设置以步长为单位,超出时间范围会自动修正。
- 动态值:从该应用中所有数据集中选取日期类型的字段作为默认值,当数据集字段的取值变化时,参数默认值随之发生变化。如过字段值不在范围内,参数会报错。
时间参数范围值
时间参数的范围值需要设置开始时间、结束时间和步长。步长可以选择设置,单位为秒、分、时、天、周、月、季度、年
。步长设置后,会提示范围内有多少个步长。
时间参数的设置于日期参数类似,这里不再展开描述。
1.3. 参数分组
参数支持分组展示,将相关业务含义的参数分成一组,方便数据分析过程中查找和使用。
点击参数分组
,弹出参数分组
窗口。
点击新建分组,输入分组名称回车后,创建一个参数分组。 选中分组,在右侧为该分组添加参数,最后点击确定按钮后,完成参数分组。
在参数页面可以看到每个参数的分组信息,一个参数可能会分到多个组中,有多个分组标签。
查找参数时可以通过分组快速查找到相关业务含义的字段。
1.4. 参数说明
参数默认值为动态值时,能够指定选取字段的哪一项吗?
参数默认值为动态值时,只能选取字段或指标的
第一项
做为默认值。使用参数时,图表突然报错显示没有合适范围值 ?
当参数的允许值为“列表”或“范围”时,随着时间的迁移,参数值可能会不在列表之内或者超出了指定范围,使用该参数的数据集或图表会报错。
同一个参数,不同用户看到的参数取值不同?
动态列表参数的取值是数据集字段,所以参数值会随着字段内容动态变化,如果对数据集进行了行权限控制,因为不同的用户权限不同,所以看到的参数值也不同。
同一个参数,不同用户看到的默认值不同?
默认值为动态值类型时会选取数据集中字段的内容作为默认值,如果对数据集进行了行权限控制,因为不同的用户权限不同,所以看到默认值也不同。
results matching ""
No results matching ""
衡石文档
- 产品功能一览
- 发布说明
- 新手上路
- 安装与启动
- 系统管理员手册
- 数据管理员手册
- 分析人员手册
- 数据查看员手册
- 数据服务
- 最佳实践
- 衡石分析平台 API 手册
- 附录