CHT_OPT_DASH

This command sets options for the CHT_DASH command.

Syntax

CHT_OPT_DASH option_number, "setting"

Valid entries for the option_number and "setting" parameters are:

option

explanation

setting

description

0

Reset all CHT_OPT_DASH options to their default settings.

""

 

1

Data Source Name (DSN)

name of a GainSeeker DSN

The default setting is the GainSeeker DSN that was used to launch the SPC Data Entry module and run the current template.

You can use this option to chart data from a different GainSeeker DSN. For more information on specifying data source names, see dsn=.

2

User or Group Name

an existing user or group name

The default setting is the User or Group Name that was used to log in to the SPC Data Entry module and run the current template.

You can use this option to chart data from a different GainSeeker login name.

Note: This command uses the configuration of the user currently logged into GainSeeker. If you choose to Change Configuration for the current-running data entry session, the original configuration for the GainSeeker user is used with this command. The changed to configuration is not used.

3

Login password for User or Group Name

login password

The default setting is the login password for the User or Group Name that was used to log in to the SPC Data Entry module and run the current template.

If you specified a different GainSeeker DSN and/or User or Group Name, you can use this setting to specify the login password for the specified GainSeeker login name.

4

Database login name

database login name

The default setting is the database login name for the GainSeeker DSN that was used to launch the SPC Data Entry module and run the current template. This setting is not used for Pervasive.SQL databases.

If you specified a different GainSeeker DSN, you can use this setting to specify the database login name for that DSN.

5

Database login password

database login password

The default setting is the database login password for the database login name that was used to launch the SPC Data Entry module and run the current template. This setting is not used for Pervasive.SQL databases.

If you specified a different database login name, you can use this setting to specify the database login password for that database login name.

6

Date Period.

When retrieving a desktop, this setting will be ignored.

number

This setting overrides the date period that is configured for the specified dashboard.

The following numbers are valid for this setting:

Periods that include 'today'

 

Other periods

Today

1

 

Yesterday

2

Last n hours ending now

35

 

Last week

8

One day ending now

36

 

Last month

9

One week ending today

16

 

Last quarter

10

One month ending today

17

 

Last three months

33

One quarter ending today

18

 

Last six months

34

One year ending today

19

 

Last year

11

Today to default low

32

 

January this year

20

Current week

4

 

February this year

21

Current month

5

 

March this year

22

Current quarter

6

 

April this year

23

Current year

7

 

May this year

24

All dates

3

 

June this year

25

 

 

 

July this year

26

 

 

 

August this year

27

 

 

 

September this year

28

 

 

 

October this year

29

 

 

 

November this year

30

 

 

 

December this year

31

 

 

 

First quarter

12

 

 

 

Second quarter

13

 

 

 

Third quarter

14

 

 

 

Fourth quarter

15

 

 

 

Custom by date

0

 

 

 

the date period currently being used for SPC entry
(from the user's configuration, DE_OPT 13 or Session menu)

-1

Note: As with all "setting" parameters for this command, the number you specify should be formatted as a string.

7

High Date/Time for date period 0.

When retrieving a desktop, this setting will be ignored.

date/time stamp

If you use this setting to specify a High Date/Time, you must also use CHT_OPT_DASH 8 to specify a Low Date/Time.

You can specify a date/time stamp using one of two formats:

 the date format that is valid for your Windows regional options

 the HSI date format. This is a 16-character string format (YYYYMMDDHHmmsshh) used to store date/time stamps in GainSeeker tables.

8

Low Date/Time for date period 0.

When retrieving a desktop, this setting will be ignored.

date/time stamp

If you use this setting to specify a Low Date/Time, you must also use CHT_OPT_DASH 7 to specify a High Date/Time.

You can specify a date/time stamp using one of two formats:

 the date format that is valid for your Windows regional options

 the HSI date format. This is a 16-character string format (YYYYMMDDHHmmsshh) used to store date/time stamps in GainSeeker tables.

31

Image attributes

attributes for the <IMG> HTML tag

By default, GainSeeker applies the ALIGN=MIDDLE HTML image attribute to the charts generated by the CHT_DASH command.

You can use this setting to specify the HTML attributes that will be applied to the charts generated by CHT_DASH. A list of <IMG> tag attributes is available at the w3schools website

Example:

CHT_OPT_DASH 31, ' title="Use the Interact menu to interact with this data."'

This example would add the "title" attribute to the <IMG> tag when the HTML file is generated.

32

Image only

"Y"

When using the Dashboard module to send a dashboard to HTML, headers and/or footers may be displayed on the resulting HTML page. You can use this setting (the default) to avoid saving this additional information to HTML.

"N"

Include the additional information in the HTML.

33

Body attributes

attributes for the <BODY> HTML tag

By default, GainSeeker does not apply any HTML body attributes to the web pages generated by the CHT_DASH command.

You can use this setting to specify the HTML attributes that will be applied to the web pages generated by CHT_DASH. A list of <BODY> tag attributes is available at the w3schools website

Example:

CHT_OPT_DASH 33, ' title="Use the Interact menu to interact with this data."'

This example would add the "title" attribute to the <BODY> tag when the HTML file is generated.

34

Table attributes

attributes for the <TABLE> HTML tag

By default, GainSeeker automatically applies the HTML table attributes border=1 and cellpadding=3 to the tables generated by the CHT_DASH command.

You can use this setting to specify the HTML attributes that will be applied to the tables generated by CHT_DASH. A list of <TABLE> tag attributes is available at the w3schools website

Example:

CHT_OPT_DASH 34, 'border="2"'

This example would set the border="2" attribute for the <TABLE> tag when the HTML file is generated.

50

SPC filter name.

The default setting is the traceability filters set for the current template row by the FILTER command.

When retrieving a desktop, this setting will be ignored.

name of existing SPC filter

You can use this setting to name an existing filter that is available to the specified user or group name.

"DE:Rown"

Use the traceability filters set by the FILTER command for template row n.

"Content:filter_contents"

You can use this setting to specify the SQL string to use for filter_contents.

To view an example of an SQL string, use the SPC Charts and Reports module to create or edit a filter. On the Traceability Filter screen, click the SQL Statement button. For more information on creating and editing filters, see Working with Filters.

To specify that no filters should be applied to the data you are charting, leave the filter_contents blank.

51

DMS filter name.

The default setting is the traceability filters set for the current template row by the FILTER command.

When retrieving a desktop, this setting will be ignored.

name of existing DMS filter

You can use this setting to name an existing filter that is available to the specified user or group name.

"DE:Rown"

Use the traceability filters set by the FILTER command for template row n.

"Content:filter_contents"

You can use this setting to specify the SQL string to use for filter_contents.

To view an example of an SQL string, use the DMS Charts and Reports module to create or edit a filter. On the Traceability Filter screen, click the SQL Statement button. For more information on creating and editing filters, see Working with Filters.

To specify that no filters should be applied to the data you are charting, leave the filter_contents blank.

99

Unloads the chart object so it is recreated the next time a chart is drawn when used in conjunction with these commands:

""

Used in conjunction with CHT_OPT_SPC 99, "" and CHT_OPT_DMS 99, "" commands, the chart COM object is destroyed so it can be recreated the next time a chart is drawn.

Note: These settings do not modify or reset any previously executed CHT_OPT_* settings.

Return value

This command does not return a value.

Notes

These commands can be executed in any order.

Example

CHT_OPT_DASH 6, "9" : MySVar "HTML" = CHT_DASH 1, "Plant Overview"

This formula first sets the date period for charts to "Last Month". Then it opens the real-time failure dashboard named "Plant Overview", and it uses this dashboard to create an HTML file.