dloggereditor

October 2020

Overview

Purpose:

The dloggereditor program is a Graphical User Interface that guides a user through steps to generate the specification file for the dlogger program.

The dloggereditor task is started from the command line.

Enter:

dloggereditor [dlogger_spec_filename] &

Where:

dlogger_spec_filename	- Optional Argument
	- The pathname of the file to edit or create

Example:

dloggereditor /specs/dlogger_spec.103 &

General Actions and Information

Creating a New dlogger Specs File

Execute the following steps to create a new file:

Select File – New from the menu bar as in Figure 1.

Figure 1: New-File Selection
The New File screen is displayed as in Figure 2.

Figure 2: New File Screen
Specify the location and name of the dlogger specification file to create in the File name: field as in Figure 3.
Figure 3: Populated New File name Field
Select Save to create the file as in Figure 3.

Loading an Existing dlogger Specs File

Execute the following steps to load an existing file:

Select File – Open from the menu bar as in Figure 4.

Figure 4: Open File Selection

Specify the location and name of the dlogger specification file to open in the File name: field as in Figure 5.

Figure 5: Populated Open File name Field

Select Open to display the file as in Figure 5.

Loading a File in the Command Environment

Enter dloggereditor [spec_filename] & at the command line. Refer to Usage Help for dloggereditor.

A pop-up message as in Figure 6 is displayed if an invalid file is specified.

Figure 6: Invalid File Specification Message

Click OK and the Empty File screen will display as in Figure 7.

Figure 7: Empty File

Setting Font Preferences

Execute the following steps to set font preferences:

Select Edit - Preferences from the menu bar as in Figure 8.

Figure 8: Edit - Preferences Selection

The Editor Preferences dialog is displayed as in Figure 9.

Figure 9: Editor Preferences Dialog

Select preferences:
1. Editor Font: Click the drop-down and select the desired font.
2. Size: Click the up/down arrow heads to scroll and select a font size.
3. Select OK to incorporate selections.

Hovering the Mouse to Display Information

Hover the mouse over data in a tab screen column or row entry to display a description of that file element’s usage.

Hovering the mouse also displays error information for a file element. See the Error Counts section for related information.

The bottom row of each tab screen lists the number of errors in the currently displayed tab and total number of errors in the file as in Figure 10. Errors in the currently displayed tab screen are indicated by red text accompanied by a red‘”x”. Errors may be syntax errors, excluded or empty fields, or any other file element that fails checking.

Figure 10: Error Counts Example

Tab Editing Actions

Keywords Tab

Select the Keywords tab to display dlogger spec file keywords. When a new dlogger spec file is created, default values appear within the screen for several of the required spec file keywords as in Figure 11.

Figure 11: Keywords Tab Screen

Refer to the following sub-sections for descriptions of Keywords tab screen functions.

Editing Value Column Information

Execute the following steps to edit applicable Value column information:

Double-click the Value column of a row to edit.
The Variable Selection dialog is displayed as in Figure 12.

Figure 12: Variable Selection Dialog

Click the drop-downs to select new variable names or enter the information in the appropriate input fields.
Select OK to incorporate changes.

Inserting Additional Keywords

Execute the following steps to insert additional keywords into a dlogger spec file:

Right-click an existing Keywords tab row and select Insert Row on the resulting pop-up menu as in Figure 13. A new row is inserted below the selected row.

Figure 13: Insert Keyword Row

Select the drop-down list within the Keyword column of the newly inserted row and select a new keyword to add to the specification file as in Figure 14.

Figure 14: Add New Keyword

Deleting Keywords from the Spec File

Right-click over the row to remove on the Keywords tab and select Remove Row as in Figure 15.

Figure 15: Remove a Keyword Row

Keywords that can be Added to the Spec File via the Keywords Tab

Table 1 lists the keywords that can be added via the Keywords tab.

Table 1: Keywords that can be Added via the Keywords Tab

Generated Keyword In Spec File	Definition	Type
*@DLOGGER	Identifies this is a dlogger spec file	String
*@DESCRIPTION	A title to be written to the output file	Computed Expression
*@GROUP	Measurement name in meta-data section of output file for GROUP	String Variable
*@MODE	Test mode to include in the output file meta-data section for MODE	String Variable
*@PROGRAM	Program name to include in the output file meta-data section for PROGRAM	String Variable
*@TEST_ID	Test Id to include in the output file meta-data section for TEST ID	String Variable
*@TEST_TYPE	Test Name to include int the output file meta-data section for TEST TYPE	String Variable
*@SCAN_INTERVAL	Time between data samples in output file	Literal value (<time>[units]) or Variable name
@CLEAR_STATISTICS_EVENT	Event to trigger statistical buffers within dlogger to reset to 0	Event Name - String
@DONE_EVENT	Name of event set at completion of data collection	Event Name - String
@ENABLE	Logical variable that must be TRUE before logging can start	Logical Variable
@FIFO_LOG_BUFFER	Presence of keyword signifies to activate First-In First-Out Logging
@FIFO_POST_TRIGGER_INTERVAL	Length of time to obtain scans after the FIFO trigger event (stop or release event) has been received
@FIFO_POST_TRIGGER_SCANS	Number of scans to obtain after the FIFO trigger event (stop or release event) has been received	Integer value
@FILENAME	Enables a computed expression to be entered after the keyword. The expression is evaluated during each scan to see if the result has changed. If it has, then the present file is closed and transferred to DARTS, and a new file is opened. It does not affect the name of the output file, which is a fixed format that includes the date, time, and specification file name.	Computed Expression
@FORCE_DIRECT_FILE_WRITE	Indicates that data should be written directly to the output file when high data rates are used	Yes or No
@FTP_EVENT	Event that triggers the output file to be finalized, and initiates file transfer	Event Name - String
@GET_NEW_SCAN_INTERVAL	Event that triggers a re-evaluation of the SCAN_INTERVAL computed expression	Event Name – String
@LOG_DIGITAL_DESCRIPTION	Flag used to determine if logical variable descriptions for all logical variables should be logged instead of 0 or 1	Yes or No
@LOG_STATISTICS	Flag used to specify that statistics should be computed for the variables specified via the @SCAN_LIST keyword	Yes or No
@LOGGING_ACTIVE_LABEL	The name of a CyFlex logical variable that indicates dlogger is actively collecting data and logging it.	Logical Variable
@MAX_SCANS	Maximum number of samples in a sampling session	Integer value
@MAX_STATISTICAL_SCANS	Maximum number of scans when the @LOG_STATISTICS keyword is specified	Integer value
@OUTPUT_PATH	Directory path to the output file	String variables or Directory Path - String
@DARTS_STEADY_STATE	Presence of keyword signifies the darts_ss_specs file variables should be included in the scan list
@READ_SPEC_FILE_EVENT	Event that triggers the dlogger to re-read the spec file	Event Name - String
@REG_NAME	Name that identifies the instance of dlogger within the OS	String
@RELEASE_EVENT	Event that signals the end of a sampling interval and terminates the dlogger task after the data files are written	Event Name - String
@RUNNING_AVERAGE	Window width of a running average window in units of time and the event that causes the data to be logged	Note: The second and third column are used to enter information for this keyword. The Value column should contain the window_width[units]. The right most column should contain the name of the event that causes the averages to be written to the output file.
@SEND_ON_PATH_CHANGE	By default, the existing file is closed, transferred to DARTS, and a new file is opened when one of the following values change: ·Mode ·Test ID ·Test type ·Program ·Group Select No from the drop-down to disable the default behavior.	Yes or No
@START_EVENT	Event that triggers the start of a sampling interval	Event Name - String
@STOP_EVENT	Event that triggers the end of a sampling interval	Event Name - String
@SYNC_EVENT	Event that triggers a scan of all channels	Event Name - String
* - Denotes required keyword

Scan List Tab

Select the Scan List tab to display CyFlex Variables, associated Statistical Members, and Channel Keywords. When a new dlogger spec file is created by dloggereditor, a default dummy variable row is added to the Scan List Tab as in Figure 16.

Figure 16: Scan List Dummy Row

This dummy row is available to edit and add rows to the Scan List; refer to Figure 17.

Execute the following steps to edit a Scan List dummy variable row:

Double-click the CyFlex Variable column to display the Variable Selection dialog as in Figure 17.
Figure 17: Scan List Variable Selection Dialog
In the Variable Selection dialog, select the type of variable to log from the Group drop-down as in Figure 17 above.

Select the variable name to log from the Variable drop-down in Figure 17.

If a Statistical Variable type variable name is selected, click the drop-down to select the SubVariable statistical member to be logged as in Figure 18.

Figure 18: Scan List SubVariable Selection

If a Logical Variable type variable name is selected, a choice between logging the logical variable true and false state descriptions or 0 or 1 can be made. To log the logical variable true and false state descriptions, select LOG_DIGITAL_DESC within the Statistical Variable column for the selected variable as in Figure 19.

Figure 19: LOG_DIGITAL_DESC Selection

Select the PAM keyword to associate with the selected variable name. Double-click the Channel Keyword column and select the corresponding PAM keyword from the drop-down as in Figure 20.

Figure 20: Scan List Select PAM Keyword

Inserting Additional Scan List Rows

Right-click a table row within the Scan List tab and select Insert Row from the pop-up menu as in Figure 21.

Figure 21: Insert Scan List Row

Removing a Scan List Row

Right-click a table row within the Scan List tab and select Remove Row from the pop-up menu as in Figure 22.

Figure 22: Remove Scan List Row

Keywords that can be Added to the Spec File via the Scan List Tab

Table 2 lists the keyword that can be added via the Scan List tab.

Table 2: Keywords that can be Added via the Scan List Tab

Generated Keyword In Spec File	Definition
*@SCAN_LIST	PAM keyword names correlating to CyFlex Variable Names to be logged
* - Denotes required keyword

Meta Data List Tab

Select the Meta Data List tab to display the meta data list of PAM keywords and associated CyFlex variables. When a new dlogger spec file is created by dloggereditor, a default dummy variable row is added to the Meta Data List Tab as in Figure 23.

Figure 23: Meta Data List Dummy Row

This dummy row is available to edit and get additional rows added to the Meta Data List; refer to Figure 24.

Execute the following steps to edit a default Meta Data List dummy variable row:

Double-click the PAM Keyword column to display the PAM Keyword drop-down list as in Figure 24.
Figure 24: PAM Keywords List
Select a corresponding CyFlex Variable for the selected PAM Keyword. Double-click within the CyFlex Variable column to display the Variable Selection Select the variable name from the Variable drop-down as in Figure 25.

Figure 25: Meta Data List Variable Selection – Add Corresponding Variable

Select OK to incorporate the change.
Enable a string literal value written to the output file for a selected PAM Keyword. Double-click the CyFlex Variable column to display the Variable Selection
Enter the desired string enclosed by quotes in the Literal input field as in Figure 26.

Figure 26: Meta Data List Variable Selection – Add Literal Value

Select OK to incorporate the change.

Inserting Additional Meta Data List Rows

Right-click a table row within the Meta Data List tab and select Insert Row from the pop-up menu as in Figure 27.

Figure 27: Insert Meta Data List Row

Removing a Meta Data List Row

Right-click a table row within the Meta Data List tab and select Remove Row from the pop-up menu as in Figure 28.

Figure 28: Remove Meta Data List Row

Keywords that can be Added to the Spec File via the Meta Data List Tab

Table 3 lists the keyword that can be added via the Meta Data List tab.

Table 3: Keywords that can be Added via the Meta Data List Tab

Generated Keyword In Spec File	Definition
* @META_DATA	List of specified PAM Keywords and corresponding CyFlex variable names where the CyFlex variable values will be captured once when the dlogger output file is written.
* - Denotes required keyword

Scan List Aux User Tab

Select the Scan List Aux User tab to display CyFlex Variables and associated Alternate Names.

Inserting Additional Scan List Aux User Rows

Right-click a table row within the Scan List Aux User tab and select Insert Row from the pop-up menu as in Figure 29.

Figure 29: Insert Scan List Aux User Row

Editing Scan List Aux User Rows

Execute the following steps to edit data in a Scan List Aux User row:

Double-click the CyFlex Variable column to display the Variable Selection dialog as in Figure 30.

Figure 30: Scan List Aux User Variable Selection

Select the type of variable to log from the Group drop-down and select the variable name to log from Variable drop-down.
Select OK to incorporate changes.
When selecting a variable name from the Variable Selection dialog, the Alternate Name box is automatically populated with the selected variable name. To edit the data within Alternate Name box, double click within the Alternate Name column and enter the correct information as in Figure 31.

Figure 31: Edit Alternate Name

Removing a Scan List Aux User Row

Right-click a table row within the Scan List Aux User tab and select Remove Row from the pop-up menu as in Figure 32.

Figure 32: Remove Scan List Aux User Row

Keywords that can be Added to the Spec File via the Scan List Aux User Tab

Table 4 lists the keyword that can be added via the Scan List Aux User tab.

Table 4: Keywords that can be Added via the Scan List AUX User Tab

Generated Keyword In Spec File	Definition
@SCAN_LIST_AUX_USER	List of CyFlex variable values that are logged within the dlogger output file as the Alternate Name if one is specified. If the Alternate Name is not specified, the CyFlex Variable is referenced as the CyFlex Variable in the output file.

Double-click the ASAM Specs Path column to display the ASAM3 File Selection dialog as in Figure 34.

Figure 34: ASAM3 File Selection

In the ASAM3 File Selection dialog, select the Spec File drop-down to select the location and filename for the ECM parameters to be logged.
Select the ECM Instance drop-down to select the ECM name and index number.
Select OK to incorporate changes.

Removing an ECM List Row

Right-click a table row within the ECM List tab and select Remove Row from the pop-up menu as in Figure 35.

Figure 35: Remove ECM List User Row

Keywords that can be Added to the Spec File via the ECM List Tab

Table 5 lists the keyword that can be added via the Scan List Aux User tab.

Table 5: Keywords that can be Added via the ECM List Tab

Generated Keyword In Spec File	Definition
@ECM_LIST	Location and filename of an ECM spec file where ECM variables names will be read to add to the list of variables that are logged within the dlogger output file