Parameters to open Desktops in GainSeeker Charts

Create a shortcut you can click to have GainSeeker automatically open a Desktop. This can also include changing part numbers, filters, and date ranges. GainSeeker can additionally execute tasks such as printing, exporting, and closing the desktop.

This topic applies to desktops in the GainSeeker Charts module. For information on opening Desktops in Legacy charting modules, see Parameters to open a desktop.

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 desktop and leaves it open on the GainSeeker Charts window, you would not include the ExportType= or the Close parameter. If you do not want GainSeeker to open a dialog where you can make changes to the desktop before it opens, do not include the Prompt command.

• 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=0  OpenList="Desktop123"  ExportType=Printer Close

The Additional command line parameters field on LaunchPad is highlighted in the following example. Also see Setting up shortcuts to perform automatic functions

Command line examples

The parameters for command lines shown in the following table are suggestions for ways you might use parameters to formulate your commands. There are other combinations you can use that are not featured here.

Note: To have GainSeeker prompt you for a standard, date range, filter, statistics filter, or a combination of these, add the Prompt parameter to the command. See Prompt

Export parameters

If the GainSeeker Charts module is minimized, dashboard images cannot be correctly exported.

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 and ExportType=EmailHTML will only send email if you have GainSeeker Publish.
  
  These parameters do 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 the ExportList= parameter for information about sending the item to a saved file listing multiple email recipients.
  
  When emailing charts, the email subject line will be the chart window caption for the last chart drawn.
  
  The difference between Email and EmailHTML is that EmailHTML does not include attachments. Both formats include charts in the body of the email message.

• If you use ExportType=Printer, you can also use the following parameters to set the orientation and layout:

• Orientation:  use DesktopPrintOrientation=L (for Landscape) or DesktopPrintOrientation=P (for Portrait)

• Layout: use DesktopPrintLayout=1 (1 Chart with Text), 2 (1 Chart per page), 3 (2 Charts per page), 4 (3 Charts per page), 5 (4 Charts per page), or 6 (6 Charts per page).

• For ExportType=PowerBI, see Power BI parameters.

Export=

• If you use Export="filename" and have GainSeeker Publish, GainSeeker exports the desktop to the path and filename you specify (for example: Export="Q:\reports\PN422.charts.htm"). Valid filename extensions are .htm, .rtf, .jpg, and .txt.
  
  If you do not have GainSeeker Publish, GainSeeker ignores the file path and file name you specify, and a file of the specified type is automatically created in your Windows TEMP path.

• If your ExportType= is email, enter a valid email address for a single recipient after Export= (for example: Export="gainseeker@yahoo.com"). For multiple recipients, use ExportList= instead.

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\desktop\" and the file name is "email recipients list for PN61011.txt"):

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

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

Power BI parameters

Using the command line to send data to Power BI requires GainSeeker Publish.

If ExportType=PowerBI, you must use additional Power BI Account parameters:

• PowerBIAppClientID=your_Application_Client_ID

• PowerBIUsername=your_PowerBI_login_email
  
  Please Note: If your Power BI Account uses multi-factor authentication, you will be prompted for your Microsoft login credentials once per GainSeeker Charts session (unless your computer is already logged in to the Power BI service). This may prevent you from running this command line unattended.

• PowerBIPassword=your_PowerBI_login_password_encrypted
  
  If your Power BI Account uses log in with password / single sign-on (instead of multi-factor authentication), you should include this parameter. Otherwise you will be prompted to enter a password.
  
  Use the Password Encryption utility to get the encrypted version of your Power BI login password.
  
  The encrypted password is a very long value, and the resulting command line will be longer than the character limit for a shortcut Target or Windows Run window. To run this command line, place the entire command line string into a Windows batch file and then use the shortcut Target or Windows Run window to run this batch file.

You can also include these optional parameters:

• PowerBIDataset=your_Dataset_name
  
  This specifies the Power BI Dataset where you want to send the data.
  
  If not used, GainSeeker will use the default dataset name for each chart. (You can manually send the chart to Power BI to find this default dataset name.) This is the recommended choice for a desktop with both SPC and DMS charts, because specifying a dataset name (in append mode) would add both types of data to one Power BI dataset which can be confusing.

• PowerBIAppend=option_number
  
  This sets the Existing dataset behavior.
  
  For Add data to existing data, you can omit this parameter or set this to 1.
  
  For Replace existing data, set this to 2.

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.

Prompt

If you want GainSeeker to open a dialog where you can make changes to the desktop (part numbers or processes, filters, and date periods, a retrieval) before it opens each time, include the Prompt parameter.

Including the Prompt command in your command line opens the Edit Desktop Settings dialog before the desktop opens.

Example:

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

OpenType=0 Prompt Open="desktop1"

Keys="Part Number||Process"

Between your "Part Number" name and your "Process" name, you need to insert double pipe symbols like this: ||

Hold the SHIFT key and press the Pipe/backslash key (shown below) twice to create double pipes:

Desktop with charts "keys="

All single-retrieval and/or multiple-retrieval charts on a desktop display the part numbers specified in command line arguments for the desktop. When a key is specified for a chart category (SPC or DMS multiple or single charts), that key is applied to all charts in that category for the desktop.

Note about DMS Retrievals: When using keys for DMS charts in a desktop, any DMS chart that originally retrieved a list of processes is blank when both a part number and a process is specified in the keys. Additionally, any DMS chart that originally retrieved a list of part numbers and processes is blank when only a process is specified by the keys.

Format for a desktop with single-retrieval DMS and/or SPC charts

keys=dms:"partno||process" or keys=dms:"process"

Example: keys=dms:"K-GLOVE||T-SEWING" or keys=dms:"T-SEWING"

keys=spc:"partno"

Example: keys=spc:"1250 TEMP"

Format for a desktop with multiple-retrieval DMS and/or SPC charts

keys=dmsmult:"partno||process~process~partno||process"

Example: keys=dmsmult:"D-34KW CONNECTOR||P-MOLDING~E-34KB COVER||P-PRINTING"

(Note: In the above example, a tilde (~) symbol is used a separator between part numbers and processes.)

keys=spcmult:"partno~partno"

Example: keys=spcmult:"1250 TEMP~1400 TEMP"

(Note: In the above example, a tilde (~) symbol is used a separator between part numbers.)

Format for specifying more than one retrieval type in a single command

keys=spc:"partno",dmsmult:"partno||process~partno||process"

Example: keys=spc:"1250 TEMP",dmsmult:"K-GLOVE||T-SEWING~E34KB COVER||P-PRINTING"

Setting a date range for charts on a desktop

Use the daterange parameter to filter all charts on a desktop by a specific date period you specify. For more information on filtering by a date period, see Calendar and Dates.

OpenType=