with IBM Corp. Link Info List of dashboar ds that ar e available in Operations and Engineering...

IBM Tivoli Netcool Performance Manager 1.4.2Operations and Engineering DashboardsDocument Revision R2E1

Developing Custom Operations andEngineering Dashboards

IBM

NoteBefore using this information and the product it supports, read the information in “Notices” on page 87.

© Copyright IBM Corporation 2016.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

Developing custom Operations andEngineering Dashboards . . . . . . . vIntended audience . . . . . . . . . . . . vOrganization . . . . . . . . . . . . . . vService Management Connect. . . . . . . . . vTivoli Netcool Performance Manager technicaltraining . . . . . . . . . . . . . . . . viSupport information . . . . . . . . . . . viConventions used in this publication . . . . . . vi

Typeface conventions . . . . . . . . . . vi

Chapter 1. Introduction . . . . . . . . 1Available dashboards . . . . . . . . . . . 1Prerequisites . . . . . . . . . . . . . . 2

Chapter 2. Creating custom dashboards 3Uploading a custom dashboard . . . . . . . . 4

Chapter 3. Operations and EngineeringDashboards API reference . . . . . . . 5Dashboard structure and layout . . . . . . . . 5Stores. . . . . . . . . . . . . . . . . 7Query modeling basics . . . . . . . . . . 11

Wireless query modeling . . . . . . . . . 11

Wireline query modeling . . . . . . . . . 14Filter bar . . . . . . . . . . . . . . . 16

icons elements . . . . . . . . . . . . 18Widget structure. . . . . . . . . . . . . 31

plots. . . . . . . . . . . . . . . . 34axes . . . . . . . . . . . . . . . . 38series . . . . . . . . . . . . . . . 43toolbar . . . . . . . . . . . . . . . 46chartidentity . . . . . . . . . . . . . 49legend . . . . . . . . . . . . . . . 57properties . . . . . . . . . . . . . . 60

Widgets available in dashboards . . . . . . . 63Lines . . . . . . . . . . . . . . . 63Bars . . . . . . . . . . . . . . . . 64Columns . . . . . . . . . . . . . . 65Badge . . . . . . . . . . . . . . . 67Donut . . . . . . . . . . . . . . . 74Grid . . . . . . . . . . . . . . . . 76Gauge . . . . . . . . . . . . . . . 80Tabs . . . . . . . . . . . . . . . . 81LayoutManager . . . . . . . . . . . . 84

Notices . . . . . . . . . . . . . . 87Trademarks . . . . . . . . . . . . . . 89Terms and conditions for product documentation. . 90

© Copyright IBM Corp. 2016 iii

iv Developing Custom Operations and Engineering Dashboards

Developing custom Operations and Engineering Dashboards

Describes how to develop and use custom IBM® Tivoli® Netcool® PerformanceManager - Operations and Engineering Dashboards on a Tivoli NetcoolPerformance Manager 1.4.2 system.

This information is designed for advanced users who need to design and createdashboards.

Intended audienceThis information is intended for:v Users who want to model and create Operations and Engineering Dashboards

on a Tivoli Netcool Performance Manager system.

Readers must be familiar with the following topics:v Tivoli Netcool Performance Manager Wireline and Wireless conceptsv Tivoli Netcool Performance Manager reporting conceptsv JSON structure and codev Tivoli Netcool Performance Manager technology packs

OrganizationThis information is organized as follows:v Chapter 1, “Introduction,” on page 1v Chapter 2, “Creating custom dashboards,” on page 3v Chapter 3, “Operations and Engineering Dashboards API reference,” on page 5

Service Management ConnectConnect, learn, and share with Service Management professionals: product supporttechnical experts who provide their perspectives and expertise.

Access Network and Service Assurance community at https://www.ibm.com/developerworks/servicemanagement/nsa/index.html. Use Service ManagementConnect in the following ways:v Become involved with transparent development, an ongoing, open engagement

between other users and IBM developers of Tivoli products. You can access earlydesigns, sprint demonstrations, product roadmaps, and prerelease code.

v Connect one-on-one with the experts to collaborate and network about Tivoliand the Network and Service Assurance community.

v Read blogs to benefit from the expertise and experience of others.v Use wikis and forums to collaborate with the broader user community.Related information:

Tivoli Netcool Performance Manager 1.4 community on developerWorks

© Copyright IBM Corp. 2016 v

https://www.ibm.com/developerworks/servicemanagement/nsa/index.html

https://www.ibm.com/developerworks/servicemanagement/nsa/index.html

https://www.ibm.com/developerworks/community/groups/service/html/communityview?communityUuid=d4b565fd-04e5-47c2-965a-943ccdfabdb9

Tivoli Netcool Performance Manager technical trainingFor Tivoli Netcool Performance Manager technical training information, see thefollowing Tivoli Netcool Performance Manager Training website at:https://tnpmsupport.persistentsys.com/training.

Support informationIf you have a problem with your IBM software, you want to resolve it quickly. IBMprovides the following ways for you to obtain the support you need:

OnlineAccess the IBM Software Support site at http://www.ibm.com/software/support/probsub.html .

IBM Support AssistantThe IBM Support Assistant is a free local software serviceability workbenchthat helps you resolve questions and problems with IBM softwareproducts. The Support Assistant provides quick access to support-relatedinformation and serviceability tools for problem determination. To installthe Support Assistant software, go to http://www.ibm.com/software/support/isa.

Troubleshooting GuideFor more information about resolving problems, see the problemdetermination information for this product.

Conventions used in this publicationSeveral conventions are used in this publication for special terms, actions,commands, and paths that are dependent on your operating system.

Typeface conventionsThis publication uses the following typeface conventions:

Bold

v Lowercase commands and mixed case commands that are otherwisedifficult to distinguish from surrounding text

v Interface controls (check boxes, push buttons, radio buttons, spinbuttons, fields, folders, icons, list boxes, items inside list boxes,multicolumn lists, containers, menu choices, menu names, tabs, propertysheets), labels (such as Tip:, and Operating system considerations:)

v Keywords and parameters in text

Italic

v Citations (examples: titles of publications, diskettes, and CDs)v Words defined in text (example: a nonswitched line is called a

point-to-point line)v Emphasis of words and letters (words as words example: "Use the word

that to introduce a restrictive clause."; letters as letters example: "TheLUN address must start with the letter L.")

v New terms in text (except in a definition list): a view is a frame in aworkspace that contains data.

v Variables and values you must provide: ... where myname represents....

Monospace

vi Developing Custom Operations and Engineering Dashboards

https://tnpmsupport.persistentsys.com/training

http://www.ibm.com/software/support/probsub.html

http://www.ibm.com/software/support/probsub.html

http://www.ibm.com/software/support/isa

http://www.ibm.com/software/support/isa

v Examples and code examplesv File names, programming keywords, and other elements that are difficult

to distinguish from surrounding textv Message text and prompts addressed to the userv Text that the user must typev Values for arguments or command options

Bold monospace

v Command names, and names of macros and utilities that you can typeas commands

v Environment variable names in textv Keywordsv Parameter names in text: API structure parameters, command

parameters and arguments, and configuration parametersv Process namesv Registry variable names in textv Script names

Developing custom Operations and Engineering Dashboards vii

viii Developing Custom Operations and Engineering Dashboards

Chapter 1. Introduction

If the existing Operations and Engineering Dashboards functions do not meet allyour requirements, you can extend the functions. You can then deploy the customdashboards into the system.Operations and Engineering Dashboards are used forenhanced visualization features in Tivoli Netcool Performance Manager.

Every dashboard in Operations and Engineering Dashboards comes with a defaultlayout. The default layout and functionality is sufficient but the real usefulness ofdashboards lies in your ability to create them the way that you want. Dashboardscontain widgets that give you an overview of the KPIs that you need.

A key aspect of these dashboards is the interactivity that they allow. You candynamically change the data that is displayed in charts/graphs or change otherobjects on the dashboard.

Typically, Operations and Engineering Dashboards are driven and controlled by aset of technology-neutral JSON files. You can easily create these dashboards andtheir associated widgets.

Available dashboardsOperations and Engineering Dashboards display the status of metrics and keyperformance indicators (KPIs) gathered and stored by Tivoli Netcool PerformanceManager Wireline and Wireless components.

A dashboard is a display of related sets of data on one screen. A dashboardprovides a simplified view of data in widgets. A widget is a graphicalrepresentation of information, which is designed to provide a quick overview ofstatistics, or other important information. A variety of widgets are available to addto dashboards depending on the dashboard type.

List of dashboards and reports that are available in Operations and EngineeringDashboards Wireline Infrastructure Monitoring use case, which supportsconsolidated reporting across packs that are used on use cases..

Network Performance Overview

v Device Overviewv CPU Utilizationv Device Memory Utilizationv Memory Pool Per Card Usagev Device Detailsv Interface Overviewv Interface Detailsv Link Overviewv Link Info <KPI>

List of dashboards that are available in Operations and Engineering DashboardsWireless UMTS Huawei use cases:

Network Overview

© Copyright IBM Corp. 2016 1

v Handover Outgoing Success Ratev CS Call Drop Rate

List of dashboards that are available in Operations and Engineering DashboardsWireless LTE Huawei use cases:

Network Overview

v Inter RAT Handover Outgoing Success Ratev Cell Availabilityv Call Setup Success Rate

For more information, see Administering and Using Operations and EngineeringDashboards.

PrerequisitesSoftware that is needed for developing and deploying the custom Operations andEngineering Dashboards.

Web host containerIBM WebSphere Application Server 8.5.0.1

Browser support

Browser Version

Chrome (32-bit) 50

Firefox ESR (32-bit) 31, 38

Internet Explorer (32-bit) 11

Libraries

v Gridx 1.3.3v ibm-dojo-1.10.0v ibm-dojo-extensions-1.5

2 Developing Custom Operations and Engineering Dashboards

Chapter 2. Creating custom dashboards

Use this information to create a JSON file and use it to create your own dashboardand upload the JSON file on Dashboard Application Services Hub to see a newdashboard and widgets.

About this task

See the step-by-step workflow to create and use custom dashboards:

Integrate the

custom dashboard

on DASH

Identify data

source

Wireline/

WirelessDefine layout of

dashboard

(Rows * Columns)

Define dashboard

ID

Define data

stores based on

DataAccess API

Define dashboard

ID

Define data

stores based on

SQL queries

Define data stores

for filter bar

look up

WirelessWireline

Define widget

layout location

Wire widget to

data store

Define widget

attributes

Define dashboard

ID attribute

(numeric)

Select the JSON

file to upload

JSON validation

at the back

ground

Save the JSON

file

Assign roles

to the dashboard Click Index


Uploading a custom dashboardOperations and Engineering Dashboards provides out-of-box dashboards that coverthe entire network performance representation. A dashboard is a type of view thathelps you to monitor events or activities at a glance. It provides key insights andanalysis about your data on one or more pages or screens.

Before you begin

You can create your own view with the help of a JavaScript Object Notation (JSON)file for dashboard customization.

To use this option, you must first create a JSON file that contains all the informationneeded for your dashboard.

Procedure1. Go to System Adminstration > User Access > Upload Dashboard.2. Click New and enter the following details:v Dashboard ID, specify a unique numeric value to identify the dashboard.v Domain, choose from the list if it is Wireline or Wireless.v Category, choose a category from the list.v Dashboard Title, specify a name for the dashboard title.v Description, specify the description of the dashboard.v Choose file, click Browse to select the created JSON file of a custom

dashboard details.3. Click Save.

The dashboard is successfully saved.4. To edit the existing dashboard information, select a dashboard from the Custom

Dashboard Creation list and click Edit.5. To delete an existing dashboard, select the dashboard from the Custom

Dashboard Creation list and click Delete.6. To refresh the dashboard list, click Refresh.

Results

The uploaded JSON files are available at: /opt/IBM/JazzSM/profile/installedApps/JazzSMNode01Cell/tnpmoed.ear/tnpmoed.1.4.2.0-0006.war/json.

The ID of the dashboard is appended to the file name of the custom JSON file. Forexample, for a custom JSON file with a name tab.JSON becomes tab_6.JSON.Where, 6 is the ID of the dashboard specified during upload.

What to do next

To ensure that the custom dashboard is accessible to the required users, followthese steps:v Grant permission to role to access the dashboards.v Integrate the new dashboard on Dashboard Application Services Hub.

For more information about these steps, see Administering and Using Operations andEngineering Dashboards.


Chapter 3. Operations and Engineering Dashboards APIreference

This reference information helps you create your custom dashboards.

You can create a set of JSON configuration files to drive your dashboards and thefunctions. One JSON file is defined per dashboard. The deployed JSON files arelocated in .

Dashboard structure and layoutOrganization of the dashboard with the required widgets.

JSON design elements

To design a JSON API, you must identify the major elements of the API. JSON isbuilt on two structures:v A collection of name-value pairs identified by elements.v An ordered list of values.


Element Required Type Description

id Yes String The unique dashboard ID.

title No StringText to be displayed as the dashboards'stitle.

description No StringText to be displayed along withdashboards's title.

dashboardType No String

Dashboard type identifies the start day ofthe week. By default, it is MONDAY. Iffor some wireless/wireline type ofdashboards, it is different, this elementvalue must be set to wireless/wireline.The week start value for that type is used.

totalrows Yes Number Total number of rows in the layout.

totalcols Yes Number Total number of columns in the layout.

stores Yes ObjectAn array of all the stores used indashboard.

filterbar No ObjectAn object that defines the behavior offilter bar on dashboard.

widgets Yes ObjectAn array of widgets to be shown orincluded as data source change.

6D

eveloping Custom

Operations and

Engineering D

ashboards

StoresThe data store objects for Wireline and Wireless components.

Chapter 3. Operations and Engineering Dashboards API reference 7

Element Required Type Description

name Yes String Name of individual store.

import NoTo import store from some otherdashboard.

dashboardId YesID of the dashboard from where to importstore.

storeName YesName of the store to be imported fromprovided dashboard.

query Yes

If not importing any stores, SQL querywith placeholders or data access API callwith query string must be provided. Forimport, provide an empty string.

default Yes/NoIf import element is available, then thiselement is optional.

cases No An object. The query cases must match.

datasource YesData source to fetch data from. Values areDataView for wireline and wirelessOne forwireless. Currently, it is not configurable.

8D

eveloping Custom

Operations and

Engineering D

ashboards

Store declaration with cases

store declaration with cases provided directly{"stores":[{"name": "teststore5","query":"select BSC_ID,TO_CHAR(tstamp,’DD-MON-YYYY HH24:MI’) as time,HUACELLUMTSCDR_CSCDRDENOM,HUACELLUMTSCDR_CSCDRNUM,100*(HUACELLUMTSCDR_CSCDRNUM/HUACELLUMTSCDR_CSCDRDENOM) as CDR fromUDC_HUA_BSCUMTSCDR_HSM_V where HUACELLUMTSCDR_CSCDRDENOM isnot null and tstamp>sysdate-1 and bsc_id =’{rnc}’order by time desc","default":{"rnc": "’SRC413’"},"rnc=?":{


"placeholder1":" WHERE rnc=’{rnc}’"},"datasource":"wirelessOne"}]}

Store declaration with import{"stores": [{"name": "cellstore","import":{"dashboardId":"6thsampletest","storeName":"nccellstore5"},"query":"","datasource":"wirelessOne"},]}


Query modeling basicsThe query element is required for retrieving data to the widget from database inWireline and Wireless components.

Typically, the stores element has two main parts:

query It has two parts:v Statement, which is the static part of the query.v Placeholders, which are the dynamic part of the query that can be

replaced based on certain conditions. It is similar to a look-up variablewhere the look-up values are defined separately in cases.

cases Cases define different values that can be replaced for placeholders in aquery that depends on certain conditions. If multiple cases match, then thecase that is defined first is used sequentially.

Wireless query modelingThe data is retrieved from database with the help of SQL queries that are added tothe query element.

Consider an example with a timePeriod filter and the Granularity filter dependson the timePeriod filter. The table name depends on the granularity that isselected. It accepts one more where conditions based on whether it is a listening toanother widget or it is loaded for the first time. For example:SELECT DECODE(C2,NULL,-999,0,NULL,C1/C2) C3,ROUND(C4,2) C4,C5/NULLIF(C6,0) C7,TO_CHAR(TSTAMP,'{dateFormat}’) TSTAMPFROM {tableName}WHERE TSTAMP BETWEEN {timeFrom} AND {timeTo}AND C8 = {value};

In this query, {tableName}, {timeFrom}, {timeTo}, {value}, {dateFormat} are theplaceholders, and the remaining part of the query is the static or the statementpart.

The cases part for this store is:{"cases": [{"default": {"tableName": "TAB_HOUR","value": "1",“dateFormat”:”MM/DD/YYYY HH24:MI”}}, {"granularity=Hourly": {"tableName": "TAB_HOUR"}}, {"granularity=Daily": {"tableName": "TAB_DAY","value": "2"",“dateFormat”:”MM/DD/YYYY”}}, {"value=?,granularity=Hourly": {"tableName": "TAB_HOUR","value": "{value}"}


}, {"value=?,granularity=Daily": {"tableName": "TAB_DAY","value": "{value}"",“dateFormat”:”MM/DD/YYYY”}}]}

Note: In cases element,“?” shows that the value for this placeholder matches withany value. So in this example, value=1,value=2,value=3 map to value=?.

When granularity=Daily, this case matches only when value of granularity isDaily. Each case determines the values of the placeholders in that query, which arereplaced in the query depending on the matching case. If the value is not specifiedexplicitly for that placeholder in matching case, the value from default case ispicked for that placeholder.

The timeFrom and timeTo placeholders come from TimePeriod filter that is definedin filterbar.

If granularity=Hourly, then data is fetched from TAB_HOUR table, and ifgranularity=Daily, then data is fetched from TAB_DAY table.

Cases Comments

"default":{"tableName": "TAB_HOUR","value": "1"","dateFormat":"MM/DD/YYYY HH24:MI"}

If any of the cases don’t match, these values can be replaced for placeholders.

"granularity=Hourly":{"tableName": "TAB_HOUR"}

If value of granularity is Hourly, this case matches. The tableName isreplaced with TAB_HOUR and value for value and for dateFormat arepicked from default case.

"granularity=Daily":{"tableName": "TAB_DAY","value": "2","dateFormat":"MM/DD/YYYY"}

If value of granularity is Daily, this case matches. The tableName isreplaced with TAB_DAY and value for value is 2, and value for dateFormatis MM/DD/YYYY.

"value=?,granularity=Hourly": {"tableName": "TAB_HOUR","value": "{value}"}

If value of granularity is Hourly, this case matches and the value as sentas the parameter. The tableName is replaced with TAB_HOUR and the valuefor value is the value that is assigned to the value parameter, and thevalue for dateFormat is picked from the default case.

"value=?,granularity=Daily":{"tableName": "TAB_DAY","value": "{value}","dateFormat":"MM/DD/YYYY"}

If value of granularity is Daily, this case matches. The tableName isreplaced with TAB_DAY and value for value is the value that is assigned tothe value parameter, and value for dateFormat is MM/DD/YYYY.

Some recommended functions in the queryUse these recommended functions in the query to achieve correct display of datain the widgets.


Function Recommended for

DECODE Used to handle NO DATA and DIVIDE BY ZERO scenario.

NULLIF Used to handle DIVIDE BY ZERO scenario.

ROUND Used to add precision to numerical values.

TO_CHAR Used to convert result to String type.

Recommended format for date is MM/DD/YYYY HH24:MI for time stamp to display correctly in Grid filters.

DECODE

To handle the NO DATA or DIVIDE BY ZERO scenarios, use the DECODE function in thequery. Typically, NO DATA is treated as null in query and returns -999 in the result.If the divisor is 0, then null is returned in the result. If these scenarios are nothandled, Oracle throws an error during the SQL execution. From the widget side,-999 is treated as “-” in Grid, Gauge, and Badge widgets, and treated as nullvalue in other widgets. The null is shown as a String literal “null” in Grid, Gauge,and Badge widgets, and is treated as null value in other widgets.

You must handle the -999 and null values, irrespective of the value inreplacevalueparam that is specified in the widget JSON in Grid and Gaugewidgets.

Example:DECODE(C2,NULL,-999,0,NULL,C1/C2) C3

If value for C2 is null, then it is replaced with -999. If value for C2 is 0, then it isreplaced with null. Otherwise, the value for C1/C2 is used directly.

NULLIF

The DIVIDE BY ZERO error can also be resolved by using NULLIF function. Forexample:C5/NULLIF(C6,0) C7

If C6 is 0, then it is replaced with null and division is performed. If you want toperform sorting on a column, use NULLIF instead of DECODE.

ROUND

The ROUND function is used to add precision to the numerical values. All widgetsexcept Grid, do not support automatic rounding off values to limit the digits afterthe decimal point.ROUND(C4,2) C4

The value of C4 is rounded off to two decimal points.

TO_CHAR

Widgets support String or Number data types. Use the TO_CHAR function to convertDate to String to display on the widget.TO_CHAR(TSTAMP,'{dateFormat}’) TSTAMP


Converts TSTAMP to String and formats the date to a specific format according tothe granularity that is selected.Related reference:“series” on page 43Series defines the data that is shown on the chart.

Wireline query modelingWireline queries are based on Data Access API, which is a web-based API toextract Tivoli Netcool Performance Management data. The DataAccess API canextract metadata and metrics directly from the DataMart.

If you have Region and timePeriod filters and the values of timeZone, timespanand fancyTimefrom are passed on from the UI framework, the query can be writtenas follows:/PV/PROVISO/DataView/Query.json?user=NOC&queryType=DVRSTProperty&subElmtIDs=1234&subElmtGrpID={Region}&timeSpan={timespan}&startTime={fancyTimeFrom}&metricIDs=29519,31511,31512,31513,31563,29526,29514&statistics1=avg&statistics2=avg&statistics3=avg&statistics4=avg&statistics5=avg&statistics6=avg&statistics7=avg&tz=GMT{timeZone};

In this query, {Region}, {timespan}, {fancyTimeFrom}, {timeZone} are theplaceholders, and the remaining part of the query is the static or the statementpart.

The cases part for this store is as follows:{"default": {},"timePeriod=Last Day": {"timespan": "day"},"timePeriod=Last Year": {"timespan": "year"},"timePeriod=Last Week": {"timespan": "week"},"timePeriod=Last Month": {"timespan": "month"},"timePeriod=Today": {"timespan": "day"}}

Each case determines the values of the placeholders in that query, which arereplaced in the query based on the matching case. If the value is not specifiedexplicitly for that placeholder in matching case, the value from default case isused for that placeholder. The Region placeholder is defined in the filterbar.

The values of timeZone and fancyTimefrom are passed on from the framework UI.The timespan placeholder is replaced based on timePeriod filter value. The casesfor timespan are as follows:

Cases Comments

"default": {} If any of the cases does not match.


Cases Comments

"timePeriod=Last Day":{"timespan": "day"

}

This case matches if the value of timePeriod is Last Day. Thetimespan is replaced with day.

"timePeriod=Last Year":{"timespan": "year"

}

This case matches if the value of timePeriod is Last Year. Thetimespan is replaced with year.

"timePeriod=Last Week":{"timespan": "week"}

This case matches if the value of timePeriod is Last Week. Thetimespan is replaced with week.

"timePeriod=Last Month": {"timespan": "month"}

This case matches if the value of timePeriod is Last Month. Thetimespan is replaced with month.

"timePeriod=Today":{"timespan": "day"

}

This case matches if the value of timePeriod is Today. The timespan isreplaced with day.

Data access query types in Wireline dashboards

The query types that are supported in Wireline dashboards are as follows:

Query Type Description

DVResDistributionReturns the number of resources in statistical ranges for a single groupand metric for the correct Timezone information for the group.

DVTopNVariationReturns the TopN ranked variations for the current and previous timeperiod and compensates for Timezone offsets.

DVRSTProperty Returns the Resource Summary data set with property columns added.

DVTSPropertyReturns time series with stats, summary data, thresholds, and propertyvalues.

DVGSTSupplies the Group Summary data from the GA tables andcompensates for Timezone offset.

DVAggOffsetDescReturns the associated group, Calendar, aggregation set IDs, and theTimezone offset relevant over a specific time interval when given agroup ID.

DVAssocSubGrpGrpReturns all children subelement groups when given a parentsubelement group ID.

For more information about these query types, see the DataAccess Help Page thatcontains a dynamically generated list of all supported InfoQs by using this URL:http://<hostname>:<port>/database/PROVISO/DataView/Query.xml?queryType=DVHelpPage

For example:https://<myserver.ibm.com>:16311/PV/PROVISO/DataView/Query.csv?queryType=DVHelpPage

Related information:

DataAccess concepts and terminology


http://www.ibm.com/support/knowledgecenter/SSBNJ7_1.4.2/data_access_api/ctnpm_da_concepts_terms.html

Filter barRequired for interactive selective display of data on the widgets.


Element Required Type Default Value Value Range Description

showFilterButton No Boolean true true, false

Whether to show the Apply Filter button.Value is case-sensitive. The value true isexpected. For other values, filter button isnot displayed.

names Yes StringComma-separated list offilter names

What filters to display.

displaynames No StringComma-separated list offilter display names

Displayed values for filter names, but atbackend filters are passed against values offilter names element.

keys No

Comma-separated list offilter’’s that does nothave any dependentfilters.

These filters are displayed on the filter bar,but it's values are provided while applyingfilter. Suggest using names instead of keysand use hidden attribute. The hiddenelement is described in next section.

dashboardId No String ID of the dashboardMandatory, if values of any filter arefetched from the store.

icons Yes ObjectObject containing information of all thefilters.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference17

icons elementsUnder icons, the separate entries for each of the filters defined by usingnames/keys.

For each filter, the are following elements are available that define it's behavior.



storeEither store or valuesare mandatory

StringName of the store to beused

Mandatory, if you want to populatedynamic values from data set

valueColumn No String valueFor store, it specifies the column namewhose value is to be used as filter values.

displayValueColumn No String value

For store, it specifies the displayedcolumn name whose values aredisplayed in the drop-down list, butvalue of valueColumn is passed whileapplying the filters.

disabled No Boolean false true, falseDrop-down list for that filter is disabledif value is true. The value true and falseare case-sensitive.

valuesEither store or valuesare mandatory

StringMandatory, if values for the filter arestatic, Comma-separated string withvalues to be displayed

displayValues No String noneComma-separated filtervalues to be displayedin drop-down list.

Values that are displayed for the filteragainst the values that can be used forbackend purpose.

defaultValue No StringFirst value ofdrop-down list

The default value to be displayed onload.

hidden No Boolean false true, falsetrue, if the filter need not be displayedon the filter bar. Case-sensitive true/falsevalue.

dependantNames No String

Comma-separatednames of the filters,which depend on thisfilter

Comma-separated names of filters thatdepend on this filter and all ofdependent filters specified under “keys”section.

dependencies No String

Comma-separatednames of the filters onwhich this filterdepends on.

Comma-separated list of filters on whichthis filter depends.

storeAndValues No Array of objectsIf it depends on some filter, this attributemust be there. Described in the nextsection.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference19

Note: The two filters that are defined here are the timePeriod and region.


storeAndValuesTypically, storeAndValues element is used when the current filter depends on someparent filter.

The storeAndValues is an array of objects where each object has following fields:


Element Required Type Value Range Description

Names of the dependent filters Yes StringfilterName that isdefined in the namessection of the filter bar.

It defines for particular value of x filter (parentfilter for current filter) what must be the value ofcurrent filter. For example,

{"timePeriod":"Last Day""values":"Hourly"}

For Last Day value of time period, use hourly asthe values for this filter.

values See “icons elements” on page 18

displayValues See “icons elements” on page 18

store See “icons elements” on page 18

valueColumn See “icons elements” on page 18

displayValueColumn See “icons elements” on page 18

Chapter

3. Operations and

Engineering D

ashboards A

PI reference25

The granularity filter is dependent on timePeriod and the value of granularity filterchanges four filters namely; granularityCondition, granularityValue,granularityGroup and granularityDisplay. The storeAndValues defines the value xof parent filter, which is the value/store for this filter. For example, for timePeriodLast Week, the Granularity filter’s values are Daily and Hourly.


The startTime and endTime are parent filters where for any value, you can use thestore infraRegionFilterStore for fetching the filter values. The displayed values inthe dropdown can be the displayValueColumns values. The valueColumn’s valuescan be passed for applying filter.

timeRange:

The timeRange is specific to timePeriod’s custom value.

It defines following values based on which values are decided for granularity filter.For custom time period, the granularity is calculated based on hour, day, week,and month values.



from No Integer 1 Numeric value

For custom timePeriod filter, some attributes define thebehavior of granularity. For example, if total time is 1 - 24(24 is exclusive) hour, then the value for granularity filtercan be Hourly. If total time is 1 - 99999 (99999 is exclusive)days, then granularity filter value is Daily. Typically, thesevalues can be used for most dashboards.

to No Integerhour: 24

day: 90Numeric value

For custom timePeriod filter, some attributes define thebehavior of granularity. For example, if total time is 1 - 24(24 is exclusive) hour, then the value for granularity filtercan be Hourly. If total time is 1 - 99999 (99999 is exclusive)days, then granularity filter value is Daily. Typically, thesevalues can be used for most dashboards.

values Yes String Comma-separated set of values.

displayValues No String Comma-separated set of display values.

28D

eveloping Custom

Operations and

Engineering D

ashboards

Widget structureJSON format of the widget element.


Element Required TypeDefaultValue

Value Range Description

id Yes String The widget's ID to be referred throughout the dashboard.

typeOptional fordata sourcechange

String

Bar

Column

Area

Line

Pie

Donut

Grid

Badge

Gauge

LayoutManager

Tabs

The type of widget. Mandatory, only if not importing anywidget.

rowspan Yes Number Numeric value >= 1 Row span of the widget in layout.

colspan Yes Number Numeric value >= 1 Column span of the widget in layout.

xpos Yes Number Numeric value >= 0 X-Position of the widget in layout that starts from 0.

ypos Yes Number Numeric value >= 0 Y-Position of the widget in layout that starts from 0.

style Yes StringStyle to be applied to the widget. Default varies perwidget

legend No Objectnone (Notdisplayed)

See “legend” on page57

Describes whether to have legends or not. Applicable toBar, Column, Area, Line, Pie, Donut widget types

tooltip No Stringnone (Notdisplayed)

true, falseDescribes whether to have tooltip or not. Applicable toBar, Column, Area, Line, Pie, and Donut widget types

chartidentity NoArray ofobjects

noneSee “chartidentity” onpage 49

Mandatory, if widget must be able to refresh the datawhen filter is applied.

toolbar No Objectnone (Notdisplayed)

See “toolbar” on page46

Specifies the chart toolbar for the widget

32D

eveloping Custom

Operations and

Engineering D

ashboards

widget elements

The associated widget attributes vary with the type of widget. These attributes areas follows:


plotsPlots define how the chart is displayed.

This element is mandatory for Bar, Column, Area, Line, Pie, and Donut widgets.The different plot types are StackedBars, ClusteredBars, StackedColumns, andClusteredColumns.


Element Plot Type Required Type Default Value Value Range Description

name

Lines

ClusteredBars

ClusteredColumns

StackedColumns

StackedAreas

StackedBars

StackedLines

Grid

Yes String Name of the plot.

type

Lines

ClusteredBars

ClusteredColumns

StackedColumns

StackedAreas

StackedBars

StackedLines

Grid

Yes String

Lines

ClusteredBars

ClusteredColumns

StackedColumns

StackedAreas

StackedBars

StackedLines

Grid

Type of the plot.

gap

ClusteredBars

ClusteredColumns

StackedColumns

StackedBars

No Number Numeric value >= 1Space between two consecutive bars or columns inchart.

minBarSize

ClusteredBars

ClusteredColumns

StackedColumns

StackedBars

No Number Minimum width of column or height of bar.

maxBarSize

ClusteredBars

ClusteredColumns

StackedColumns

StackedBars

No Number Maximum width of column or height of bar.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference35


markers

Lines

StackedLines

StackedAreasNo Boolean false true, false

Whether to draw markers at data points on thisplot.

hMajorLines Grid No Boolean true true, false Horizontal major lines to display or not.

hMinorLines Grid No Boolean false true, false Horizontal minor lines to display or not.

vMajorLines Grid No Boolean true true, false Vertical major lines to display or not.

vMinorLines Grid No Boolean false true, false Vertical minor lines to display or not.

hAxis

Lines

ClusteredBars

ClusteredColumns

StackedColumns

StackedAreas

StackedBars

StackedLines

Grid

No String X

It might be one ofthe list of axesnames defined in thewidget

Provide name of the horizontal axis for this plot.

vAxis

Lines

ClusteredBars

ClusteredColumns

StackedColumns

StackedAreas

StackedBars

StackedLines

Grid

No String Y

It might be one ofthe list of axesnames defined in thewidget

Provide name of the vertical axis for this plot.

36D

eveloping Custom

Operations and

Engineering D

ashboards


tensionLines

StackedLines

StackedAreas

No String X, x, S

(According to Dojo documentation). Adding somecurve to the lines. By default (if not providedthrough JSON) it is off.

X: cubic Bezier smooth curve. x: same as X, butassumes that point set is closed (loop).

S: quadratic Bezier smooth line. If a number is used,the simpler Bezier curve calculations are used todraw the lines.

radiusPie

DonutYes Number 0 For example, 30, 40 Radius of the Pie Chart (Circle) in pixels.

labelsPie

DonutNo Boolean true true, false

If you don’t' want to see the labels on the filled areaof each division in Pie chart, you need to set thisvalue as false. If you want to see the label(percentage of occupancy) in that circle that isrelated to that data point, you can set the value astrue.C

hapter3. O

perations and E

ngineering Dashboard

s API reference

37

axesAxes define the various properties of an axis of a chart. For example, X-axis andY-axis.

Bars, Columns, Lines, Areas in the table indicate all variants of that plot, that is,stacked or clustered types.



name

Bars

Columns

Lines

Areas

Yes String Name of the axis.

title

Bars

Columns

Lines

Areas

No String Empty string Title of the axis.

titleOrientation

Bars

Columns

Lines

Areas

No String axis axis, awayDetermines the title orientation to the axis,facing to the axis by axis, or facing away fromthe axis by away.

includeZero

Bars

Columns

Lines

Areas

No Boolean false true, falseThis element makes your lower bound value tobe zero. If your lowest data value is negativethe includeZero option has no effect.

minorTicks

Bars

Columns

Lines

Areas

No Boolean true true, false Flag to draw minor ticks on an axis.

microTicks

Bars

Columns

Lines

Areas

No Boolean false true, false Flag to draw micro ticks on an axis.

majorTicks

Bars

Columns

Lines

Areas

No Boolean true true, false Flag to draw major ticks on axis.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference39

labelSeries

Bars

Columns

Lines

Areas

Yes String

Name of aseries. Forexample,Attempts

Name of series that contains labels to show forthis particular axis.

min

Bars

Columns

Lines

Areas

No Number 0 For example, 50 The minimum number, an axis starts at.

max

Bars

Columns

Lines

Areas

No Number 1For example,100

The maximum number, an axis ends at.

titleGap

Bars

Columns

Lines

Areas

No Number 0 For example, 10The spacing between title and correspondingaxis, which is measured by pixel.

vertical

Bars

Columns

Lines

Areas

Yes Boolean false true, falseHow the axis must be displayed. A flag thatsays whether an axis is vertical (Y-axis) orhorizontal (X-axis).

fixUpper

Bars

Columns

Lines

Areas

No String none

major

minor

micro

none

Align the greatest value on the axis with thespecified tick level.

fixLower

Bars

Columns

Lines

Areas

No String none

major

minor

micro

none

Align the smallest value on the axis with thespecified tick level.

40D

eveloping Custom

Operations and

Engineering D

ashboards

minorLabels

Bars

Columns

Lines

Areas

No Boolean true true, falseFlag to labels on minor ticks when there isenough space.

microLabels

Bars

Columns

Lines

Areas

No Boolean true true, false

majorLabels

Bars

Columns

Lines

Areas

No Boolean true true, false Flag to draw labels at major ticks.

majorTickStep

Bars

Columns

Lines

Areas

No Number 4The amount to skip before a major tick isdrawn. When not set, the major ticks step iscomputed from the data range.

minorTickStep

Bars

Columns

Lines

Areas

No Number 2The amount to skip before a minor tick isdrawn. When not set, the minor ticks step iscomputed from the data range.

microTickStep

Bars

Columns

Lines

Areas

No Number 1The amount to skip before a micro tick isdrawn. When not set, the micro ticks step iscomputed from the data range.

maxLabelCharCount

Bars

Columns

Lines

Areas

No Number For example, 20 Define the max count of characters in label.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference41

dropLabels

Bars

Columns

Lines

Areas


Whether the axis automatically drops labels atregular interval or not to avoid labels tooverlap. Gives better results, but requires morecomputations. When you know that your labelsdo not overlap, you can disable it to savecomputation time.

rotation

Bars

Columns

Lines

Areas

No Number 0For example, 45,-30

Negative value supported. Angular rotation indegrees to be applied to the axis labels.

42D

eveloping Custom

Operations and

Engineering D

ashboards

seriesSeries defines the data that is shown on the chart.


Element Widget Type Required TypeDefaultValue

ValueRange

Description

name

Bars

Columns

Lines

Areas

Pie

Donut

Yes String Name of the Series.

plot

Bars

Columns

Lines

Areas

Pie

Donut

Yes String

Forexample,

default

gridPlot

plot1

Plot of the Series. Name of the plot that must be used fordisplaying data of this series.

store

Bars

Columns

Lines

Areas

Pie

Donut

Yes String Name of the store for this series.

value

Bars

Columns

Lines

Areas

Pie

Donut

Yes String The value you need to assign from the store results.

label

Bars

Columns

Lines

Areas

Pie

Donut

Yes/No StringMandatory, if this series is a label series. The label that isneeded to display if this series is labelSeries.

44D

eveloping Custom

Operations and

Engineering D

ashboards


ValueRange

Description

sortparam Donut, Pie No String The parameter from the data set to sort the data.

sortorder Donut, Pie No String asc, desc The order in which to sort the data.

replacevalueparam All No String None

Forexample,value, cssr,cstr (Neednot be onlyvalue)

The parameter to be checked for handling of -999 values,which are considered to be the values that do not have adefined value or null value. If the value is -999, then it istreated as null by the widget to handle divide by zeroerror. Pass the name of data set column for which thisvalue is checked against. When you define this parameter,the value with -999 is handled by widget. See the“DECODE” on page 13 function for further handling ofthese values from the query.Note: For Wireline dashboards, the data set with null valueis converted to -999. It is recommended to define thisparameter.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference45

toolbarToolbar is the chart toolbar or title bar of the widget.




isMaster No Boolean false true, falseIf the value is true, it is a master widget, and someother widgets might depend on this widget.

chartFamily Yes/No String nonegraphical

graphical_time

circular

Based on chart family, you must be able to viewthat widget in all of the widgets supported by thisfamily. For example, if the value is graphical, youcan see the following widget type of charts:

StackedBars

ClusteredBars

StackedColumns

ClusteredColumns

Grid

This element is optional, if you do not want toallow Charttype change for that widget.

title No String Text to be shown on widget toolbar.

dataSources No ObjectAn array that declares widgets to be displayed asdataSource change options on chart toolbar.

displayTitle Yes String Text to be displayed in dataSource option.

widgetId Yes StringID of the widget to be associated with the provideddata source change option.

titleUpdation No String append append, replace

If the titleUpdation is replace, the filter valuesmentioned in curly braces are replaced with itsvalues from filter bar. If the titleUpdation isappend, the title of the chart widget is appendedwith the values received from its dependentwidget. It might be master chart, or chart thatcauses to open a drill-down page and also replacevalues that are in curly braces from filter bar.

maximize No Boolean true true, false

If the maximize is true, the maximize or minimizeicon is added to the widget toolbar. You can clickthat icon to maximize, minimize, or restore thewidget. It is case in sensitive.

collapse No Boolean true true, falseWhether you want to display the Collapse buttonon chart toolbar.

style No String none Style to be applied to the chart toolbar.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference47



class No String none

fontSiz 8

fontSize18

width40

width100

Class to be added to chart toolbar. Some predefinedclasses can be applied like to change the font sizeor the max-width of the chart title based on classname.

48D

eveloping Custom

Operations and

Engineering D

ashboards

Note: Sample for datasource element, for example, inbounderrorcolumn1 orinterfaceavailcolumn is the widget ID in the same dashboard.

chartidentityThe chartIdentity element defines the behavior of the chart. Whether it is master,listener or drill-down from another widget. Sometimes, used for providing tooltip.


Element Widget Type Required Type Default Value Value Range Description

name All Yes String NoneName that is given to the widget. It is not necessary to have it same asthe widget ID. This name is unique in a JSON specific to one dashboard.

drilldowntype All Yes/No String None

masterlistener

navigation

navigation-mapbased (Specificto Grid)

Mandatory if it’s a master for in-place or cross-page drill down, or alistener.

masterlistener: That widget acts as a master or listener if you add onemore element called type with value master or listener.

navigation: Specified cross-page drill-down.

navigation-mapbased: Used to navigate to different pages based on theclicked row’s selected column’s values (from drillDownValue) and themap provided from targetDashboards element.

type Yes/No String master, listenerIf the drilldowntype is masterlistener, type must be master or listenerthat is based on the behavior required. Optional, if not using masterlistener.

parameter Yes/No StringMandatory, if type is master or drilldowntype is navigation. Parameteris the name that is given to the clicked value that is to be passed.

master Yes/No String Mandatory, if type is listener, chartidentity name of the master widget.

targetDashboard Yes/No String

Mandatory if drilldowntype is navigation. JSON name of the dashboardto be drill-down to, which is formed as <Dashboard Title>_<DashboardID>. Click of any data point in chart widget, the new dashboard is openthat is based on value of this key and also this dashboard can receivethe parameters provided by key parameter.

targetDashboards Grid No String None

"{’httpg711alaw’:’httpinfo_page’,’udpEchog711alaw’:’udpecho_page’,’icmpjitterg711alaw’}"

Mandatory, if the drilldowntype is navigation-mapbased. It declares a setof dashboard values to be given as the target dashboard based on thedrill down value. For example, the values from the clicked row’sselected column.

tabTitleAll exceptGrid

Yes/No String NoneMandatory, if the drilldowntype is navigation want to open a new pagein new tab. If not mentioned, it opens in the same tab.

extraparameters All No String None Key1,Key2

Used for passing multiple values while drill-down. Provides parameters(keys) for the values.

extracolumns All No String None Col1,Col2

Column names for passing extra values to while drill-down.

50D

eveloping Custom

Operations and

Engineering D

ashboards

Element Widget Type Required Type Default Value Value Range Description

extraparams All No String None {'key1':'val1'}

A JSON map with instead of. The map values are passed as is whenyour drill-down.

tooltipText

Bars

Columns

Lines

Areas

Pie

Donut

No String None Text to be appended in tooltip of a chart.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference51

legendLegend object if provided, defines the type of legend that a widget can have.




type

Bars

Columns

Lines

Areas

Pie

Donut

Yes String simpleinteractive.simple

If the type is interactive, you are able toshow and hide the series what you need.

horizontal

Bars

Columns

Lines

Areas

Pie

Donut


If the horizontal is false, the series is displayedvertically one by one in a single column. If thevalue is true, all series is displayed one by onenext in a single row. It is case in-sensitive.

style

Bars

Columns

Lines

Areas

Pie

Donut

No StringYou can specify CSS style attributes here forthe legend height, width, margins, and so on.

58D

eveloping Custom

Operations and

Engineering D

ashboards

propertiesMandatory for Gauge, Badge, and Grid widgets.


ElementWidget

TypeRequired Type

DefaultValue


dataStore Grid Yes String None Mandatory in Grid widget

paginationConf Grid No String none pages, noneIf you want to have a pagination bar, give value aspages.

filteringConf Grid No String filterBar filterBarIf you do not want to have a filter bar, then value forthis must be given as “”.

sortingConf Grid No String single single, multipleWhen you click a column, you can see a sorting feature.It can be single column sort or multiple column sort.

labelFontSize Badge No String 18px "labelFontSize":"'14px' "

Applies to the title of the badge in titleBadge.

fontsize Badge No String 30 px

Size in pixel. Forexample,

"fontsize":"'16px'"

Applies to the values of the badge in historyBadge andrangeBadge.

ranges Badge No String

None (usesdefaultcolor,black)

For example,

[0,3,5,100]

If badgeType is rangeBadge or historyBadge, itdetermines range of values to decide a color fromcolors.

colors Badge No String

None (usesdefaultcolor,black)

For example,

[’#14AE4B’,’#FDB811’,’#D9152B’]

If badgeType is rangeBadge or historyBadge, itdetermines the color to be given to the value part of thebadge.

store Badge No StringFor example,networkOverviewBadge

Mandatory, for rangeBadge and historyBadge. Name ofthe store to fetch data from.

radius Gauge Yes Integer Radius of the gauge.

store Gauge Yes StringFor example,"’storeName’"

For gauge widget, the usage is different. Store to beused for fetching value in single quotation marks.

valueAttr Gauge Yes StringFor example,

"’cssr’","’cstr’"

Name of the value column in single quotation marks.

minimum Gauge No Integer 0 Integer value Minimum to be displayed on scale.

maximum Gauge No Integer 100Integer value >minimum

Maximum to be displayed on scale.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference61

ElementWidget

TypeRequired Type

DefaultValue


ranges Gauge YesArray ofvalues

For example,

[0,3,5,100]Range for gauge.

colors Gauge YesArray ofcolors

For example,

[’#14AE4B’,’#FDB811’,’#D9152B’]

Colors for displaying ranges on the circular scale.

62D

eveloping Custom

Operations and

Engineering D

ashboards

Widgets available in dashboardsThe widgets that are used in the Operations and Engineering Dashboards.

LinesDisplays information as a series of data points that are called markers that areconnected by straight-line segments. It is a basic type of chart common in manyfields.

Plot types

StackedLines

StackedAreas

By default, the area chart draws the series on top of one another. You canstack them atop one another instead, so that the data values at eachx-value are summed.

The JSON code for Stacked areas is similar to Stacked lines. Specify theplot type value as Stacked areas.


Related reference:“plots” on page 34Plots define how the chart is displayed.

BarsA bar graph is a chart that uses either horizontal or vertical bars to showcomparisons among categories. The two types of bar charts are Stacked bars andClustered bars.

Plot types

The JSON code for Stacked bar is similar to Clustered bar. Specify the required plottype value.

StackedBars


ClusteredBars


ColumnsA column of data (a category) is a series of data points or columns along thehorizontal axis (or X-axis). The height of the point or column along the verticalaxis (or Y-axis) represents the value of the category item. The two types of columnsare Stacked column and Clustered column.

ClusteredColumns


StackedColumns



BadgeA badge is a small image that represent a specific information on the dashboard.


Element Required TypeDefaultValue


badgeType YestitleBadge

historyBadge

rangeBadge

Defines the type of badge widget that is used for displaying title, or ahistoryBadge where the difference between current and previousvalue is shown by using up or down arrows, rangeBadge that creates abadge label and value with colors according to given ranges.

badgelabel Yes String Title of the badge.

allowClick Yes Boolean false true or false Whether to allow drill-down from the badge.

labelStyle No CSS String “”For example,

padding-top:10px;Gives style to the badge label such as CSSR, CSTR.

68D

eveloping Custom

Operations and

Engineering D

ashboards

The three badge types are as follows:

historyBadge


Element Required Type Value Range Description

circleRadius Yes Number Numeric value Radius of the circle.

prevValue Yes StringMapping to the column of previous value in dataset.

differenceFontSize Yes String For example, 15px

Font size of the label here:

value Yes StringFor example,

item.cssrColumn of the data set to be used.

70D

eveloping Custom

Operations and

Engineering D

ashboards

titleBadge


rangeBadge


Element Required Value TypeDefaultValue


valueStyle Yes CSS String “”For example,

padding-top:10px;

Gives style to the badge value for labels.

value Yes StringFor example,item.cssr

Column of the dataset to be used

unit Yes String undefinedFor example,

"%", ""It is the unit that is attached to the value. If user doesn’t wantany unit attached to the value, then can use empty string

Chapter

3. Operations and

Engineering D

ashboards A

PI reference73

Note: The JSON code for labelStyle and valueStyle is as follows:"labelStyle": "width:100%;float:left;height:40px;font-size:15px;background-color:#f5f5f5;color:#000000!important;text-align:center;border-bottom:1px solid #DBDBDBD;display:block;padding:15px 0 0 0 ! important",

"valueStyle": "width:100%;float:left;height:57%;font-size:20px;font-weight:normal;background-color:#FFFFFF;text-align:center;color:#777777;display:table;",

DonutA Donut chart is a pie chart with a hole in the center. JSON for Pie is similar todonut.


Pie

Typically, a pie chart is the graphic representation of the table. Pie charts present asingle column of data as a filled-in circle. In a pie chart, each row in the valuescolumn is a slice in the circle. Each slice is proportional to a percentage of the sumof whole column. When you create a pie chart, you first identify the valuescolumn, and then identify the category column that contains the labels for eachslice.

The JSON code for Pie is similar to Donut. Specify the type element value as pie tocreate a Pie chart.



GridA grid is the standard view for a set of values that are related to a specificattribute.



columns Yes

name Yes String Label of the Column Header.

id Yes String Unique ID of the column specific to that Grid.

field Yes String Mapping with the database column.

dataType Yes String Stringnumber

date

string

Type of the data that is coming in this column. This isused for showing filter conditions in filter dialog.

precision No Number None number Floating point precision to be used.

cellformat No String none

rightalign

leftalign

bold

italic

underline

centeralign

Applies the selected formatting to this column.

shortenNumber No Boolean false true, falseWhether to shorten the number in this column by usingKilo/ Mega/ Giga/ Tera units.

ranges No String None

Comma- separatedinteger values. Forexample,

0, 95, 100

Used with colors, fontcolors, or status. Provides therange of values for choosing the colors to be given to thiscell.

colors No String None

Comma-separatedcolor values. Forexample,

red, #52C4FF

Colors the cell if value of this cell is in range 0-95 withred or #52C4FF. Gives font color to the cell content if thevalue of this cell is in range 0-95 with red or #52C4FF.

fontcolors No String None

Comma-separatedcolor values. Forexample,

red, #52C4FF

Gives font color to the cell content if the value of this cellis in range 0-95 with red or #52C4FF.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference77


type No String None ProgressBar

Creates a widget inside the cell based on the type. Forprogress bar, the set value is the value of the cell.Following code can create a progress bar based on cssrvalue. For example,

{"name":"cssr","field":"cssr","id’:"cssr","type":"ProgressBar","properties":"maximum:200","minimum:50"}

If any of the properties are not provided, default value is0-100.

78D

eveloping Custom

Operations and

Engineering D

ashboards

GaugeUse the gauge widget to represent the progress to a target or goal.


TabsEach tab entry in pages element looks as follows.



pages Yes Array none

This element contains different layout fordifferent tabs. Each page is represented bydifferent object, which has its own layout ofwidgets.

tabPosition No String top

top

bottom

left

right

Position of the tab list.

82D

eveloping Custom

Operations and

Engineering D

ashboards

Note: The totalcols and totalrows are same as described in “Dashboard structureand layout” on page 5.


LayoutManagerThe LayoutManager widget can be used to wrap some widgets in a container tovisually give a fill of related things.


Element Required Type Default Value Description

layoutWidgets Yes Array None Array of widgets.

totalrows Yes StringTotal number of rows in thelayout.

totalcols Yes StringTotal number of columns in thelayout.

Chapter

3. Operations and

Engineering D

ashboards A

PI reference85

Notices

This information was developed for products and services offered in the US. Thismaterial might be available from IBM in other languages. However, you may berequired to own a copy of the product or product version in that language in orderto access it.

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle Drive, MD-NC119Armonk, NY 10504-1785US

For license inquiries regarding double-byte character set (DBCS) information,contact the IBM Intellectual Property Department in your country or sendinquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer ofexpress or implied warranties in certain transactions, therefore, this statement maynot apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM websites are provided forconvenience only and do not in any manner serve as an endorsement of those


websites. The materials at those websites are not part of the materials for this IBMproduct and use of those websites is at your own risk.

IBM may use or distribute any of the information you provide in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Director of LicensingIBM CorporationNorth Castle Drive, MD-NC119Armonk, NY 10504-1785US

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

The performance data discussed herein is presented as derived under specificoperating conditions. Actual results may vary.

The client examples cited are presented for illustrative purposes only. Actualperformance results may vary depending on specific configurations and operatingconditions.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

Statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subjectto change without notice. Dealer prices may vary.

This information is for planning purposes only. The information herein is subject tochange before the products described become available.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to actual people or business enterprises is entirelycoincidental.

COPYRIGHT LICENSE:


This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. The sampleprograms are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative work mustinclude a copyright notice as follows:

© (your company name) (year).Portions of this code are derived from IBM Corp. Sample Programs.© Copyright IBM Corp. _enter the year or years_.

TrademarksIBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.Other product and service names might be trademarks of IBM or other companies.A current list of IBM trademarks is available on the web at "Copyright andtrademark information" at www.ibm.com/legal/copytrade.shtml.

Adobe, Acrobat, PostScript and all Adobe-based trademarks are either registeredtrademarks or trademarks of Adobe Systems Incorporated in the United States,other countries, or both.

IT Infrastructure Library is a registered trademark of the Central Computer andTelecommunications Agency which is now part of the Office of GovernmentCommerce.

Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo,Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks orregistered trademarks of Intel Corporation or its subsidiaries in the United Statesand other countries.

Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both

Microsoft and Windows are trademarks of Microsoft Corporation in the UnitedStates, other countries, or both.

ITIL is a registered trademark, and a registered community trademark of TheMinister for the Cabinet Office, and is registered in the U.S. Patent and TrademarkOffice.

UNIX is a registered trademark of The Open Group in the United States and othercountries.

Notices 89

http://www.ibm.com/legal/us/en/copytrade.shtml

Java and all Java-based trademarks and logosare trademarks or registered trademarks ofOracle and/or its affiliates.

Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in theUnited States, other countries, or both and is used under license therefrom.

Linear Tape-Open, LTO, the LTO Logo, Ultrium, and the Ultrium logo aretrademarks of HP, IBM Corp. and Quantum in the U.S. and other countries.

Terms and conditions for product documentationPermissions for the use of these publications are granted subject to the followingterms and conditions.

Applicability

These terms and conditions are in addition to any terms of use for the IBMwebsite.

Personal use

You may reproduce these publications for your personal, noncommercial useprovided that all proprietary notices are preserved. You may not distribute, displayor make derivative work of these publications, or any portion thereof, without theexpress consent of IBM.

Commercial use

You may reproduce, distribute and display these publications solely within yourenterprise provided that all proprietary notices are preserved. You may not makederivative works of these publications, or reproduce, distribute or display thesepublications or any portion thereof outside your enterprise, without the expressconsent of IBM.

Rights

Except as expressly granted in this permission, no other permissions, licenses orrights are granted, either express or implied, to the publications or anyinformation, data, software or other intellectual property contained therein.

IBM reserves the right to withdraw the permissions granted herein whenever, in itsdiscretion, the use of the publications is detrimental to its interest or, asdetermined by IBM, the above instructions are not being properly followed.

You may not download, export or re-export this information except in fullcompliance with all applicable laws and regulations, including all United Statesexport laws and regulations.


IBM MAKES NO GUARANTEE ABOUT THE CONTENT OF THESEPUBLICATIONS. THE PUBLICATIONS ARE PROVIDED "AS-IS" AND WITHOUTWARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDINGBUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY,NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.

Notices 91

IBM®

Printed in USA

with IBM Corp. Link Info List of dashboar ds that ar e available in Operations and Engineering...

Documents

Transcript of with IBM Corp. Link Info List of dashboar ds that ar e available in Operations and Engineering...