Configuring Export: PPAs CSV Commands

Note: This functionality is only available in systems licensed for FULL mode.

Use the File Export button to access the Export: PPAs CSV command that triggers the service to export all PPA records created within a specified time window as a .csv file.

See FMS Commands and Export: PPAs CSV for more information about this command.

See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

Configuring a PPAs CSV File Export Command

Use the following procedure to configure and optionally run the Export: PPAs CSV command.

To Configure and Optionally Run a PPA Export Command

On the Commands menu, click File Export to access the drop-down menu, and then click PPA Export to access the Run FMS Command dialog box for the Export: PPAs CSV command.

Export: PPAs CSV

Define the command definition properties.

Select a processing Priority from the drop-down menu. Options include Low, Medium, High, User, and Admin.
Select a Logging level from the drop-down menu, to determine the level of logging details reported when viewing command logs. Options include Low, Medium, and High. See Viewing Command Logs for more information.

Define the command parameters. The parameters for the PPA Export system command are described in the Command parameters box, which includes the Description, a Required indicator, and a configurable Value field. Set the value for each required and each selected optional parameter, as indicated in its Value field.
Optionally click Run Command, to run the command now.

Command Definition Properties

The following command definition properties apply to PPA Export commands.

Property	Description
Command type	For system commands, this property will be read-only and will display the selected command type. See FMS Commands for more information about command types.
Priority	Select a processing queue Priority for the command from the drop-down menu. Options from least to greatest priority are as follows. Low level Medium level High level User initiated transaction Admin initiated transaction Default value is Low level processing queue priority.
Logging	Select a Logging level for the command results from the drop-down menu. Options are as follows. Low — displays errors Medium — displays errors and warnings High — displays errors, warnings, and status Default value is Low level logging when scheduling a command in the MSS. Default value is High level logging when creating or running an ad-hoc command in FMS Explorer.

Property

Description

Command type

For system commands, this property will be read-only and will display the selected command type.

See FMS Commands for more information about command types.

Priority

Select a processing queue Priority for the command from the drop-down menu.

Options from least to greatest priority are as follows.

Low level
Medium level
High level
User initiated transaction
Admin initiated transaction

Default value is Low level processing queue priority.

Logging

Select a Logging level for the command results from the drop-down menu.

Options are as follows.

Low — displays errors
Medium — displays errors and warnings
High — displays errors, warnings, and status

Default value is Low level logging when scheduling a command in the MSS.

Default value is High level logging when creating or running an ad-hoc command in FMS Explorer.

Command Parameters

The following command parameters apply to PPA Export commands.

Description	Type	Required	Value
Start date of PPA records to retrieve	DateTime	Yes	This is in Local time (L) relative to the computer hosting your FMS Service. Do one of the following to select the beginning Time Created (L) for which to export PPA records. Type a date/time into the text box. Click ... to access the Select Date dialog box, set the date/time, and then click OK. See Notes* below this table.
End date of PPA records to retrieve	DateTime	Yes	This is in Local time (L) relative to the computer hosting your FMS Service. Do one of the following to select the end Time Created (L) for which to export PPA records. Type a date/time into the text box. Click ... to access the Select Date dialog box, set the date/time, and then click OK. See Notes* below this table.
Directory to export CSV file	String	Yes	Do one of the following to enter the directory location to which the file will be exported. Type a directory location into the text box. Click ... to access the Browse for Folder dialog box, browse to the directory location, and then click OK. Note: The directory specified is relative to the computer hosting the FMS. See Notes** below this table.
Name of CSV export file	String	Yes	Do one of the following to enter a name for the export file. Type a file name into the text box. Click ... to access the Select Name of CSV Export File dialog box, type a file name, and then click OK. See Notes*** below this table.
Data exported flag	String Enum	Yes	Select, from the drop-down menu, whether or not to use the Data Exported flag to mark PPA records as "exported" in the database. Options are as follows. Ignore flag Use flag

Notes:

*Start/End dates based on relative time - Make sure that you accurately describe exports if you are typing the start and end date/time entries into the text boxes, and are using a Relative Date/Time or Relative Day format. In this situation, the date/time range of the records to export is determined as follows.

If any of the Start or End date/time hour, minute, or second values are specified as a value other than zero or midnight, the range will be used as specified.
If both the Start and End date/time values are 00:00:00, or if both are set to midnight however, an additional day will be added to the date at the end of the range. This occurs because in this circumstance the service assumes the starting date/time to be at the start of the specified start day, and assumes the ending date/time to be at the end of the specified end day. Therefore requesting a time range from T to T will yield one entire day of data (from the beginning of day T to end of day T), and similarly from day d-1 to day d will yield two days of data. If only one day of data is desired using relative date/time therefore (and time values are equal to 00:00:00 or midnight), the start and end days must have the same value.

See Selecting Date and Time for more information.

** Directory to export CSV file - Make sure that you are cognizant of the system in which you are specifying the file location. The file location selected when you Browse For Folder will be relative to your local file system, whereas the file location generated when the command is executed will be relative to the computer hosting your FMS Service, which could be a separate system.

*** Name of CSV export file - Make sure that the specified file name does not already exist in the specified destination, or it will be overwritten by this command and could cause accidental data loss. File name collision is not detected for this command.