Report-Recipe Commands

This group of commands is used to execute operations in the Movicon DataLoggers and Recipes.

 

 

Data Logger/Recipe

The name of the Data Logger or Recipe, where the command selected in the "Action" field is to be executed, is entered here or selected with the "..." browse button on the right.

When using "Textual Reports" this field is optional and is entered only in cases where the Textual Report must extract data from a Data Logger. In cases where a "Embedded report" is being  used, this property results disabled and therefore will be ignored by the set command.  

 

Report

This is used to enter, or select by means of using the "..." browse button to the right, the name of the Movicon "Report" for which the command selected in the "Action" field is to be executed.  This property is only enabled for the Movicon "Embedded Reports".

A report list can also be entered in this field showing each name separated with the  ";" character.  In this way, one unique report will be generated containing all the pre-selected reports to be printed or saved one after the other in one unique ".pdf" file according to the order they were entered with. In this case, the "Report Title" band will only be printed on the first report on the list.  Therefore, the first report's "Report Title" band can be used as the main title for all the reports, while the "Report Header" bands can be used to give each record, included in the main report, their own specific heading. In addition, the special field "Page n1 of n2" will not take into account the total number of pages but only the progressive number (i.e. Page 12 of ?), which cannot be zeroed until all the report pages have been printed in sequence.

Action

This is used to select the command or action type to be executed for the selected report or recipe.  Some of the commands allow reports, which have been previously associated to the DataLogger/Recipe, to be viewed or printed. In this case, the report files supported by Movicon must be created with the appropriate  "Report Designer" editor integrated in Movicon or with "Crystal Reports©" version 10.0. When using the Movicon "Embedded Reports", you must specifiy the name of the  "Report" to be used instead of selecting a Datalogger or Recipe.  

 

Action

Description

View Synchronous  

 

This command is used to open a window containing the preview of the Report associated to the DataLogger/Recipe. The Report can also be printed by using the appropriate commands in this window.

This command can be executed in reports created with the "Report Designer" or "Crystal Report".

 

Print Synchronous

 

This command is used to print the Report file associated to the DataLogger/Recipe directly without showing any previews.

This command can be executed in reports created with the "Report Designer" or "Crystal Report".

View  Report

 

This command is used to open the window containing the preview of the Report associated to the DataLogger/Recipe in safe mode by creating a new process instance. The Report can also be printed from this window by using the appropriate commands.

This command can be executed in reports created with the "Report Designer" or "Crystal Report".

 

Print Report

 

This command is used to print the Report file associated to the DataLogger/Recipe directly in safe mode, without showing any previews, by creating a new process instance.

This command can be executeds in reports created with the "Report Designer" or "Crystal Report".

 

Move First

This command is only available when a Recipe has been selected in the "DataLogger/Recipe" field.

It allows the values of the first database record to be loaded in the recipe's variable.

It's function is equivalent to that of the "Move First Variable"  variable property which can be set in the Recipe's " Execution Properties".

 

Move Last

This command is only available when a Recipe has been selected in the "DataLogger/Recipe" field.

It allows the values of the last database record to be loaded in the recipe's variable.

It's function is equivalent to that of the "Move Last Variable"  variable which can be set in the Recipe's " Execution Properties".

 

Move Prev

This command is only available when a Recipe has been selected in the "DataLogger/Recipe" field.

It allows the values of the previous database record to be loaded in the recipe's variable.

It's function is equivalent to that of the "Move Prev Variable"  variable which can be set in the Recipe's " Execution Properties".

 

Move Next

This command is only available when a Recipe has been selected in the "DataLogger/Recipe" field.

It allows the values of the next database record to be loaded in the recipe's variable.

It's function is equivalent to that of the "Move Next Variable"  variable which can be set in the Recipe's " Execution Properties".

 

Activate

This command is available only when a Recipe has been selected in the "DataLogger/Recipe" field.

It is used to activate the selected recipe. It's function is equivalent to that of the  "Activate Variable" variable which can be set in the Recipe's "Execution Properties".

 

Save

This command is available only when a Recipe has been selected in the "DataLogger/Recipe" field.

It is used to save the selected recipe. It's function is equivalent to that of the  "Save Variable" variable which can be set in the Recipe's "Execution Properties"

 

Delete

This command is available only when a Recipe has been selected in the "DataLogger/Recipe" field.

It is used to delete the selected recipe.   It's function is equivalent to that of the  "Delete Variable" variable which can be set in the Recipe's "Execution Properties".

 

Requery

This command is available only when a Recipe has been selected in the "DataLogger/Recipe" field.

It is used to requery the recordset of the selected recipe.  It's function is equivalent to that of the  "ReQuery Variable" variable which can be set in the Recipe's "Execution Properties".

 

Execute Query

This command is available only when a Recipe has been selected in the "DataLogger/Recipe" field.

It is used to execute a query in the SQL standard language on data to be selected from the Database. It's function is equivalent to that of the  "Query  Variable" function which can be set in the Recipe's "Execution Properties".

 

Export Report

 

This command is used to export the indicated report in a  file (format can be selected from the "Export Format" property). The exported report is saved in the project's  "DLOGGERS" folder with the "<ReportName >.<extension>" name.

This command can be executed in reports created with "Report Designer" or "Crystal Report".

 

Data Analysis

This command is used to call the DatChart.exe application, residing in the Movicon installation folder, which allows the you to display the selected DataLogger/Recipe data in tables and charts.

 

View Textual Report

This command is used to open a window to view the textual report. For further information, please see the section on "Textual Report Commands and Parameters".

 

Print Textual Report

This command is used to send the textual report directly to the printer for printing. For further information, please see the section on "Textual Report Commands and Parameters".

 

Save Textual Report

This command is used to create and save a new textual report file. For further information, please see the section on "Textual Report Commands and Parameters".

 

Append Textual Report

This command is used to add a new page to the textual report file set in the  "Textual Report - Destination File" parameter. For further information, please see the section on "Textual Report Commands and Parameters".

 

Export Recipe

 

This command is used to export values currently existing in the temporary variables of the Recipe selected in the "Data Logger/Recipe" field in  "csv" format, using the character set in the " Separator Import/Export Recipe" field as the separator. Therefore temporary variables should have previously been associated  to the Recipe fields and the desired recipe should have been loaded before going ahead with the exportation procedures.

Import Recipe

This command imports a recipe from the "csv"  file to the temporary variables of the Recipe selected in the "Data Logger/Recipe" field, using the character set in the " Separator Import/Export Recipe" field as the separator. Therefore, temporary variables should have previously been associated  to the Recipe fields.  The file must be formatted correctly by providing all the fields belonging to the Recipe selected in the "Data Logger/Recipe" field.

Export and send mail

This command is used to export or e-mail the report associated to the selected DataLogger/Recipe.  The e-mail is sent according to the settings entered in the  Plug-In SMTP, by using the   "SMTP settings" button from the project's General properties, where the editor will generate a "smtp_direct.settings" file name in the "ProgjectName\DATA" folder.  The Report export file, created in the pre-chosen format using the  "Export Format" property, is attached to the email and saved in the  "ProjectName\DLOGGERS" folder by using the name of the  Data Logger in which the report was created.

The e-mail recipient will be the user or user group defined in the "recipient" property.

 

The Timeout for executing the command to create reports and send emails can be changed in the "GeneralTimeout" registry key. The value of this key, which is set at 10 seconds for default, can be increased when using the timeout intervention.  

 

Not supported on the WinCE platform

 

This command can be executed in reports created with "Report Designer" or "Crystal Report".

View Embedded Report

This command consents a viewing of the selected Embedded Report preview.  For further information please refer to the section on  "Embedded Report Generation Commands".

 

Print Embedded Report

This command sends the selected Embedded Report to be printed.  For further information please refer to the section on  "Embedded Report Generation Commands".

 

Save Embedded Report

This command consents the selected Embedded Report pdf file to be saved. For further information please refer to the section on  "Embedded Report Generation Commands".

 

Send Embedded Report

This command consents the selected Embedded Report to be saved on pdf and sent by e-mail.  For further information please refer to the section on  "Embedded Report Generation Commands".

 

Not supported on WinCE platform

 

Read

 

This command is only available when a Recipe is selected in the "DataLogger/Recipe" field.

This command is used for reading recipe values form the filed and updating values read with the selected recipe's temporary variables. Equivalent to the  "Tag.Read" variable functionality settable in the recipe "Execution Properties".

 

Export all Recipe records

This command is used to export all the Recipe's data as a .CSV file formatted as follows:

 

The first row contains the name of the columns (e.g. TimeCol;MSecCol;LocalCol;UserCol;RecipeIndex, col1, col2, …), separated by the “Recipe separator”  (default is ; )

The other rows contain the corresponding values, separated by the “Recipe separator”  (default is ; ):

 

Import all Recipe records

This command is used to import all current data in a file formatted as described immediately above:

           

  • A Record with an existing name (RecipeIndex) will update the database values.

  • A Record with a new name will create a new entry.

 

Export Datalogger records

This command is used to export all the data present for this datalogger in a .CSV file formatted as follows:

 

The first row contains the names of the columns (e.g. TimeCol;MSecCol;LocalCol;UserCol;ReasonCol;Col00001;Col00002;Col00003, …), separated by the “Recipe separator”  (default is ; )

The other rows contain the corresponding values, separated by the “Recipe separator”  (default is ; ):

 

Export Trace (Audit)

This command exports all the data present for the varialbe Trace in a .CSV file formatted as follows:

 

The first row contains the name of the columns: TableName;TimeCol;MSecCol;LocalCol;UserCol;ActionCol;BeforeCol;AfterCol;ValueCol;QualityCol;TimeStampCol;TagNameCol;TagGroupNameCol;TagDescCol

The names are separated by the “Recipe separator”  (default is ; ).

 

The other rows contain the corresponding values, separated by the “Recipe separator”  (default is ; ).

 

Data are ordered by TimeCol and Ms.

 

 

X Pos

This property is used to enter the horizontal position of Report preview window's origin. The value is expressed in pixels ( '-1' value is the default position).

This option will only be managed when the report is in the Crystal Report format and will be ignored when not.

 

Y Pos

This property is used to enter the vertical position of the Report preview window's origin. The value is expressed in pixels ('- 1 ' value is the default position).

This option will only be managed when the report is in the Crystal Report format and will be ignored when not.

 

Width

This property is used to set the Report preview window's width. The value is expressed in pixels ('0' value is the default size).

This option will only be managed when the report is in the Crystal Report format and will be ignored when not.

 

Height

This property is used to set the Report preview window's length. The value is expressed in pixels (' 0 ' value is the default size).

This option will only be managed when the report is in the Crystal Report format and will be ignored when not.

 

Toolbar

This check box is used to set display or hide the toolbar in the report preview window.

This option will only be managed when the report is in the Crystal Report format and will be ignored when not.

 

Group Tree

This check box is used to display or hide the group Tree in the report preview window.

This option will only be managed when the report is in the Crystal Report format and will be ignored when not.

 

Report Template File

For further information, please see the section on "Textual Report Commands and Parameters".

 

Report Destination  File

For further information, please see the section on "Textual Report Commands and Parameters".

 

Report Query

This field is used to insert the query to be used to extract data from the Data Logger or Historical Log to display in the report.  This property can only be enabled if the "Embedded Report" or Textual Report" command has been selected in the "Action" field.

 

 

The query's text is entered in this field and it is not possible to enter the name of a variable for dynamic queries.  In order to create the query dynamically, you will need to use the   "ExecuteCommand()"  script function from the "UIInterface" interface or the  "TextualRptSQLQuery" property from the "CommandReportCmdTarget" interface.

 

Report Max Pages

This field is used to enter the maximum number of printed pages with one single Textual Report command ("View Textual Report", "Print Textual Report", "Save Textual Report" and "Append Textual Report") or Embedded Report command ("View Embedded Report", "Print Embedded Report", "Save Embedded Report" and "Send Embedded Report").  The "0" value is used to set an unlimited number of printed pages, (it is advised not to use the '0' value to avoid occupying too much memory and printer use in cases where errors occur in the data extraction query formulation).

 

The maximum number of pages is evaluated only for those commands which have also been set with a Data Logger from where to extract data or for report commands used in the Historical Log.  

 

The first and last pages will be used to print the "Chart" when using an "Embedded Report" command with a Report containing a "Chart" object in the "Report Header" band or in the "Report Footer". The number of pages to print indicated in the "Maximum Page Number" parameter will therefore be the number of pages of the "Details" band only.  In addition, when generating a multiple report, which is composed of a list of reports, this parameter will only be considered individually for each report and will not be applied to the total number of pages of all the reports listed.  

 

Reference Period

The time ranges for extracting data to be displayed on the Report can be selected in this field.  The possible selections are:

 

 

This parameter is only considered if one of the following commands has been selected in the Action field: "View Report", "Print Report", "Export Report", "View Embedded Report", "Print Embedded Report", "Save Embedded Report"and "Send Embedded Report"

 

Export Format

This parameter is used to select the file format in which to export the Report when using the "Export Report" command.  The possible selections are:

 

 

This parameter is only considered if the "Export Report" command has been selected in the Action field.

 

Select Date

When enabling this check box, a dialog window will display when the Report is opened to allow the user to enter the date and time for the selection query of the data to be displayed on the Report.

This parameter is only considered if one of the following commands has been selected in the Action field:  "View Report", "Print Report" and "Export Report".

 

Separator Import/Export Recipe

This field is used to set a separator for the ".csv" file  when using the "Import Recipe" and "Export Recipe" commands.  The default character is";".

 

Report Page Width

This command is used to set the Width of the printed Report page.  Values are set in millimeters and the -1 value for default uses the printer's sizes.

This parameter is only considered when the "Print Embedded Report" command has been selected from the "Action" field and if the report's  "Use Paper Settings" property has been enabled.

 

Report Page Height

This command is used to set the Height of the printed Report page. Values are set in millimeters and the -1 value for default uses the printer's sizes.

This parameter is only considered when the "Print Embedded Report" command has been selected from the "Action" field  and if the report's  "Use Paper Settings" property has been enabled.

 

Report Left Margin (mm)

This command is used to set the left print margin which will be added to the one used by the printer for default. This margin is set in millimeters and the -1 value (default value) allows you to use any default print margin retrieved through the driver of the printer being used.

This parameter is only considered when the "Print Textual Report" or "Print Embedded report" has been selected in the "Action" field.

 

Report Right Margin (mm)

This command is used to set the right print margin which will be added to the one used by the printer for default. This margin is set in millimeters and the -1 value (default value) allows you to use any default print margins retrieved through the driver of the printer being used.

This parameter is only considered when the "Print Textual Report" or "Print Embedded report" has been selected in the "Action" field.

 

Report Top Margin (mm)

This command is used to set the top print margin which will be added to the one used by the printer for default.This margin is set in millimeters and the -1 value (default value) allows you to use any default print margins retrieved through the driver of the printer being used.

This parameter is only considered when the "Print Textual Report" or "Print Embedded report" has been selected in the "Action" field.

 

Report bottom margin (mm)

This command is used to set the bottom print margin which will be added to the one used by the printer for default. This margin is set in millimeters and the -1 value (default value) allows you to use any default print margins retrieved through the driver of the printer being used.

This parameter is only considered when the "Print Textual Report" or "Print Embedded report" has been selected in the "Action" field.

 

Show Print Dialog

When this option is enabled, a dialog window will open the printer settings before printing the report.  This will enable you to select which printer to use among those available on the PC.

This parameter is only considered when the "Print Textual Report" or "Print Embedded Report"command  has been selected from the "Action" field.

 

Printer

This field is used to select the printer to send the report to.  The printer can be selected from the PC's local printers.  If a printer is not specified in this field, the Windows default printer will be used instead.  The  "Chose Printer" option always has priority in this setting.

If the project has been setup for the Windows CE platform, the list of printers is fixed and will show those supported by the  "PrintCE.dll" tool as follows:

 

 

This parameter is only considered when the "Print Textual Report" or "Print Embedded Report"command  has been selected from the "Action" field.

 

Landscape

When enabling this setting, the Report page will be printed horizontally instead of vertically.

This parameter will only be considered when the "Print Textual report", "View Embedded Report", "Save Embedded Report", "Print Embedded Report" or "Send Embedded Report" have been selected from the "Action" field.

 

Printer Port

This field is used to select the port to be used for printing.  The choices are listed below and cannot be changed:

 

 

This parameter will only be considered if printing is executed in Windows CE and when the "Print Embedded Report" command has been selected in the "Action" field. In projects where the  "Windows CE" platform has not been selected, the "Printer Port" will remain disabled.

 

Port Settings

This field is used to enter a printer port configuration string.  This setting is only used when one of the "File", "Network Printer", "Broadcom Bluetooth" or "Microsoft Bluetooth" options has been selected in the "Printer Port" parameter:

 

File: the file name and path as well as the printer driver to be used for saving print  output must be set here (i.e. "\FlashDrv\Output.prn")

Network Printer: the printer's network path must be set here (i.e. "\\ServerName\PrinterName")

Broadcom Bluetooth: the three delimited values separated by the pipe ('|') character must be set here. The first value represents the bluetooth card address (i.e. 00:0A:D9:EB:66:C7), the second value represents the service to be used, and the third value represents the channel number.

Microsoft Bluetooth: the bluetooth card address must be set here (i.e. 00:0A:D9:EB:66:C7)

 

This parameter will only be considered if printing is executed in Windows CE and when the "Print Embedded Report" command has been selected in the "Action" field. In projects where the  "Windows CE" platform has not been selected, the "Printer Port" will remain disabled.

Recipient

This field is used to enter the name of the  user or user group to be sent the email with the attached report file.

This parameter is only considered when the "Export and End Email" or "Send Embedded Report" command has been selected from the "Action" field.

 

 

See Also