Parameters to open a Dashboard

You can create a shortcutyou can click to have GainSeeker automatically open a dashboard and execute other functions for the dashboard such as printing or emailing it. You can also have GainSeeker prompt you to make changes before the dashboard opens. This topic applies to dashboards in the GainSeeker Charts module.

Tips

• Include only parameters in the command line that you want GainSeeker to automatically execute.

For example, if you want to a create a shortcut in which GainSeeker opens a specified dashboard and leaves it open on the GainSeeker Charts window, you would not include the ExportType= or the Close parameter.

• Replace words and characters shown in italics with the name of the item you want to open, and enclose the name with quotation marks as shown in the table.

For example, standard P-123 Length would be written like this with the Keys= parameter: Keys="P-123 Length"

• Insert a blank space between parameters in the command line, similar to this example:

OpenType=1 Open="OEE Dashboard"  ExportType=Printer Close

Command Line examples

Prompt

If you want GainSeeker to open a dialog where you can make changes to the dashboard (such as part number, date period, filter) before it opens each time, include the Prompt parameter.

Including the Prompt command in your command line opens the Edit Dashboard Settings dialog before the dashboard opens.

Example:

The following example would prompt GainSeeker to first open the Edit Dashboard Settings dialog before opening the specified dashboard. Opening the dialog allows you to make changes to "dashboard1" before it opens.

OpenType=0 Prompt Open="dashboard1"

Export= and ExportType=

Note: If you do not have the Server Edition of GainSeeker, GainSeeker ignores the file path and file name you specify, and a file of the specified type is automatically created for you in your Windows TEMP path. Also, if you do not have Server Edition and you specify an email address, it will not send it as an email. You can contact the Hertzler Sales team for information about purchasing the Server Edition of GainSeeker.

Using the Export= or ExportType = parameters, you can opt to have GainSeeker automatically export the item specified in the Open= and OpenType= parameters to a:

• Destination path and file name that you specify, or

• Windows TEMP path

ExportType=

• If you use ExportType=Email or EmailHTML or HTML or Printer, GainSeeker creates the export file in your Windows TEMP path. This parameter is used to tell GainSeeker only the type of export to execute. If you select Printer, you do not need to additionally use the Export = parameter.

• ExportType=Email or ExportType=EmailHTML does not tell GainSeeker to direct the email to a specific recipient. See the Export= parameter below for information about sending the item to a specific email recipient or HTML file. See ExportList= for information about sending the item to a saved file listing multiple email recipients.
  
  When emailing a dashboard, the email subject line will be the dashboard caption.

• The difference between Email and EmailHTML is that EmailHTML does not include attachments. Both formats include dashboards in the body of the email message.

Export=

• If you use Export="filename" ,GainSeeker exports the dashboard to a file you specify (for example: Export="PN422.dashboard.htm" [or .rtf or .txt or .xml or .jpg.] Note: The .jpg option is only available when there are graphical controls on the dashboard, a Dial gage, for example. ). If your export type is email, enter a valid email address for a single recipient after Export = . For example: Export="gainseeker@yahoo.com"  .

• For information about sending an email to multiple recipients:

• See ExportList= below.

ExportList=

To send the item specified in the Open= and OpenType= parameters to multiple email recipients:

1. First, create a .txt file of email recipients using a text editor such as NotePad if you have not already created one you would like to use (Fig. 1). Use a separate row for each email address recipient, then save the file:

Fig. 1

2. Use the ExportType=Email parameter followed by the ExportList="filename" parameter. Include the name of the file you created that lists your email recipients, and include the path to that file.

Example: The parameters for emailing an item to a list of email names saved in a file as in Figure 1 above, would read similar to this (the location of the file name in this example is "c:\Users\bob\dashboard\" and the file name is "email recipients list for PN61011.txt"):

ExportType=Email ExportList="c:\Users\bob\dashboard\email recipients list for PN61011.txt"

(This would send emails to John, Betty, and Joan using the above example.)

View

Add the View parameter to your command line to have GainSeeker use Windows to launch the file executed by the ExportType= or the Export= parameter using the program that is associated with that file type.