Dashboard
Use the Dashboard step type to perform actions on OpenSearch Dashboards with PTF.
Description
Counts the number of slices on pie and donut charts, bars on horizontal and vertical bar charts, and points on area and line charts.
Parameters
Parameter |
Description |
---|---|
chartlabel |
The chart title. |
charttype |
The chart type. Includes hbar, vbar, area, line, pie, and donut charts. See Supported Chart Types. |
ret |
The return value. |
axis |
Not applicable for pie and donut charts. |
Example
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
ChartCountRange |
chartlabel=Remote Worker Distribution Percentage;charttype=hbar;ret=&count;axis=X |
Remote Worker Distribution Percentage |
Description
Returns the maximum value from the given axis (X or Y axis) of the area, bar, or line chart.
Parameters
Parameter |
Description |
---|---|
chartlabel |
The chart title. |
charttype; |
The chart type. Includes hbar, vbar, area, line, pie, and donut charts. See Supported Chart Types. |
ret |
The return value. |
axis |
Not applicable for pie and donut charts. |
Example
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
ChartGetMaxValue |
chartlabel=Remote Worker Distribution Percentage;charttype=hbar;ret=&count;axis=X |
Remote Worker Distribution Percentage |
Description
Returns the minimum value from the given axis (X or Y axis) of the area, bar, or line chart.
Parameters
Parameter |
Description |
---|---|
chartlabel |
The chart title. |
charttype |
The chart type. Includes hbar, vbar, area, line, pie, and donut charts. See Supported Chart Types. |
ret |
The return value. |
axis |
Not applicable for pie and donut charts. |
Example
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
ChartGetMinValue |
chartlabel=Remote Worker Distribution Percentage;charttype=hbar;ret=&count;axis=Y |
Remote Worker Distribution Percentage |
Description
Verifies labels on a chart based on the given parameters. The chart can be identified using the chart caption (chart title).
Parameters
Parameter |
Description |
---|---|
charttype |
The chart type. Includes hbar, vbar, area, line, pie, and donut charts. See Supported Chart Types. |
chartlabel |
The chart title. |
xlabel |
The X-axis label. Not applicable for pie and donut charts. |
ylabel |
The Y-axis label. Not applicable for pie and donut charts. |
slicelabel |
The slice label on the pie or donut chart. Applicable only for pie and donut charts. |
Example
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
ChartLabelVerify |
charttype=pie;chartLabel=Remote Worker Distribution Percentage;slicelabel=Onsite |
Remote Worker Distribution Percentage |
Description
Verifies the tooltip content of the slice on pie and donut charts, the bar on horizontal and vertical bars, and the point on area and line charts.
Parameters
Parameter |
Description |
---|---|
charttype |
The chart type. Includes hbar, vbar, area, line, pie, and donut charts. See Supported Chart Types. |
categoryaxis |
Not applicable for pie and donut charts. |
axisvalue |
The axis value. Not applicable for pie and donut charts. |
field |
The field name. Applicable only for bar charts. |
value |
The value for the field. |
Example
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
ChartTooltipVerify |
charttype=hbar;categoryaxis=Y;axisvalue=Finance and Administration;field=Onsite;value=Department=Finance and Administration|Count=26|Remote Worker Type=Onsite |
Employee Distribution by Department |
Description
Verifies values on a chart based on the given parameters. The chart can be identified using the chart caption (chart title).
Parameters
Parameter |
Description |
---|---|
charttype |
The chart type. Includes hbar, vbar, area, line, pie, and donut charts. See Supported Chart Types. |
xvalues |
The X-axis values. Not applicable for pie and donut charts. |
yvalues |
The Y-axis values. Not applicable for pie and donut charts. |
slicevalue |
The slice value. Applicable only for pie and donut charts. |
Example
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
ChartValueVerify |
charttype=line;xvalues=2014;yvalues=5;Chart Label=Applications - External vs Internal |
Applications - External vs Internal |
Description
Clears all the applied filters.
Example
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
ClearAllFilter |
Description
Clicks on commonly used links to set the date range.
Example
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
ClickDateRange |
Last 30 days |
Description
Clicks on a chart based on the given parameters. The chart can be identified using the chart caption (chart title).The click operation can be performed on chart components like slice, bar, or point to apply filters.
Parameters
Parameter |
Description |
---|---|
charttype |
The chart type. Includes hbar, vbar, area, line, pie, and donut charts. See Supported Chart Types. |
categoryaxis |
Not applicable for pie and donut charts. |
axisvalue |
The axis value. Not applicable for pie and donut charts. |
field |
The field name. |
Example
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
DashboardChartClick |
charttype=line;categoryaxis=X;axisvalue=Year=2017|Application Count=1|Applicant Type=Employee;field=Employee |
Applications - External vs Internal |
Description
Downloads CSV or Raw data from the inspect pop-up of the given chart. The chart can be identified by the chart caption (chart title).
Parameters
Parameter |
Description |
---|---|
type |
The data type. |
Example
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
DataDownload |
type=Formatted CSV name=Applicants |
Current Remote Worker Details |
Description
Based on the key field name and key field value, verifies or selects the row.
Parameters
Parameter |
Description |
---|---|
keyfieldname |
The key field name. |
keyfieldvalue |
The key field value. |
action |
|
grouplabel |
The label for the group. |
actionfieldname |
The field name to perform the action. |
actionfieldvalue |
The field value to perform the action. |
keyfieldname |
The key field name. |
Example
This example shows the use of the DatatableAction action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
DatatableAction |
keyfieldname=Employee ID;keyfieldvalue=KUD002;action=Verify;actionfieldname=Remote Location;actionfieldvalue=Home |
Current Remote Worker Details |
Description
Verifies the single column header from the given data table.
Parameters
Parameter |
Description |
---|---|
headerlabel |
The label for the header. |
grouplabel |
The label for the group. |
Example
This example shows the use of the DataTableHeaderVerify action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
DataTableHeaderVerify |
headerlabel=Department |
Current Remote Worker Details |
Description
Opens the given page number on the data table visualization. This action can be performed for visible page numbers only.
Parameters
Parameter |
Description |
---|---|
pagenumber |
The page number. |
grouplabel |
The label for the group. |
Example
This example shows the use of the DataTablePageGoTo action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
DataTablePageGoTo |
pagenumber=3 |
Current Remote Worker Details |
Description
Counts the number of visible rows on the current page of the data table.
Parameters
Parameter |
Description |
---|---|
ret |
The return value. |
grouplabel |
The label for the group. |
Example
This example shows the use of the DataTableRowCount action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
DataTableRowCount |
ret=&var1 |
Current Remote Worker Details |
Description
Verifies the given value in the filter drop-down list based on the field parameter. FilterValueExist is a playback action only and cannot be recorded.
Parameters
Parameter |
Description |
---|---|
field |
The field name. |
value |
The value for the field. |
Example
This example shows the use of the FilterValueExist action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
FilterValueExist |
field=Applicant ID;value=300271 |
Description
Clicks the Refresh button present on the filter bar.
Example
This example shows the use of the RefreshFilter action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
RefreshFilter |
Description
Removes the filter from the filter bar based on the given parameters.
Parameters
Parameter |
Description |
---|---|
field |
The field name. |
operator |
The field operator. |
value |
The value for the field. |
Example
This example shows the use of the RemoveFilter action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
RemoveFilter |
field=Applicant ID;operator=is not;value=300271 |
Description
Searches any keyword or text using the search box available on the dashboard.
Example
This example shows the use of the Search action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
Search |
Employee Distribution by Department |
Description
Sets the date range from the date range pop-up.
Parameters
Parameter |
Description |
---|---|
rangetype |
|
value |
The date range value. |
period |
Set the period in
|
Example
This example shows the use of the SetDateRange action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
SetDateRange |
rangetype=Last;period=years;value=150 |
Description
Sets the filter using filter pop-up form.
Parameters
Parameter |
Description |
---|---|
field |
The field name. |
operator |
The field operator. |
value |
The value for the field. |
Example
This example shows the use of the SetFilter action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
SetFilter |
field=Applicant ID;operator=is not between;value=300 to 315 |
Description
Verifies labels on a chart (inside the PIA tile) based on the given parameters. The chart can be identified using the chart caption (chart title).
Parameters
Parameter |
Description |
---|---|
charttype |
The chart type. Includes hbar, vbar, area, line, pie, and donut charts. See Supported Chart Types. |
chartlabel |
The chart title. |
xlabel |
The X-axis label. Not applicable for pie and donut charts. |
ylabel |
The Y-axis label. Not applicable for pie and donut charts. |
slicelabel |
The slice label on the pie or donut chart. Applicable only for pie and donut charts. |
Example
This example shows the use of the TileChartLabelVerify action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
TileChartLabelVerify |
charttype=line;xlabel=Year |
Application Details |
Description
Verifies labels on a chart (inside the PIA tile) based on the given parameters. The chart can be identified using the chart caption (chart title).
Parameters
Parameter |
Description |
---|---|
charttype |
The chart type. Includes hbar, vbar, area, line, pie, and donut charts. See Supported Chart Types. |
xvalues |
The X-axis values. Not applicable for pie and donut charts. |
yvalues |
The Y-axis values. Not applicable for pie and donut charts. |
slicevalue |
The slice value on the pie or donut chart. Applicable only for pie and donut charts. |
Example
This example shows the use of the TileChartValueVerify action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
TileChartValueVerify |
charttype=line;xvalues=2018;yvalues=10 |
Application Details |
Description
Clicks the dashboard tile on the PIA homepage.
Example
This example shows the use of the TileClick action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
TileClick |
id=win0groupletPTNUI_LAND_REC_GROUPLET$153 |
Application Details |
Description
Verifies the dashboard tile on the PIA homepage.
Example
This example shows the use of the TileVerify action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
TileVerify |
id=win0groupletPTNUI_LAND_REC_GROUPLET$153 |
Application Details |
Description
Verifies the filter on the filter bar based on given parameters.
Parameters
Parameter |
Description |
---|---|
field |
The field name. |
operator |
The field operator. |
value |
The value for the field. |
Example
This example shows the use of the VerifyFilter action:
Type |
Action |
Recognition |
Parameters |
Value |
---|---|---|---|---|
Dashboard |
VerifyFilter |
field=Applicant ID;operator=is between;value=1021 to 1050 |
Application Details |
Supported Chart Types
The following chart types are supported in the Dashboard step type:
Chart Type |
PTF Keyword (for charttype parameter) |
---|---|
Area |
area |
Donut |
pie |
Pie |
pie |
Line |
line |
Horizontal Bar |
hbar |
Vertical Bar |
vbar |