Naming Conventions for Files, Channel Groups, Channels, and Custom Properties

Naming Conventions for Files, Channel Groups, Channels, and Custom Properties

DIAdem uses the following name conventions to assign names to data sets, channel groups, channels, and custom properties.

Data Set Names

If you use one of the following characters in a data set name, DIAdem replaces this character with an underscore when it stores the data set. After the data set is saved, DIAdem changes the data set name in the Data Portal.

Channel Group Names

When you create a new channel group, DIAdem replaces the invalid characters of the group name by valid characters. If a group name generated by the replacement already exists, DIAdem generates a new, unique group name within the associated file. Avoid wordwraps in the channel group name, as this can cause problems in several places.

If you use one of the following characters in the channel group name, DIAdem replaces this character with the character in the right column of the table. The text Name stands for the entire channel name:

If you assign the name of an existing channel group to a channel group, DIAdem specifies the base name, which is the beginning of the name without the separator and the number. DIAdem then adds a separator and a number to the base name and thus creates a unique name. You use the UniqueNameSep variable to specify the separator. A quotation mark (") in a channel group name is valid and is not replaced by DIAdem. However, if you use a name with quotation marks in scripts, you must replace the quotation marks with double quotation marks.

Channel Names

When you create a new channel, DIAdem replaces the invalid characters of the channel name by valid characters. If a channel name generated through the replacement already exists, DIAdem generates a new, unique channel name within the associated channel group. Avoid wordwraps in the channel name, as this can cause problems in several places.

If you use one of the following characters in the channel name, DIAdem replaces this character with the character in the right column of the table. The text Name stands for the entire channel name:

If you assign the name of an existing channel to a channel in the group, DIAdem specifies the base name, which is the beginning of the name without the separator and the number. DIAdem then adds a separator and a number to the base name and thus creates a unique name. You use the UniqueNameSep variable to specify the separator. A quotation mark (") in a channel name is valid and is not replaced by DIAdem. However, if you use a name with quotation marks in scripts, you must replace the quotation marks with double quotation marks.

Note  When naming channels, do not use numbers only and avoid single or double quotation marks. Although such a name is not prohibited, it may cause issues in several places.

Custom properties

If you use one of the following characters in a custom property name, DIAdem replaces this character with an underscore:

DIAdem also replaces the space character and the non-printable characters for "backspace", "newline", "form feed", "carriage return", "horizontal tabulator", "vertical tabulator", "alert", and "white space” Char(12288) with an underscore. DIAdem also replaces a leading number in the property name with an underscore.

Note  The names of properties at the respective element (root, channel group, and channel) must be unique.

The following property names for data sets are reserved for DIAdem and cannot be used:

 author, channelgroups, children, datestring, datetime, description, environment, external_references, id, instance_attributes, mime_type, name, objecttype, parent, parent_test, registercomments, registertxt1, registertxt2, registertxt3, sourceoriginalname, timestring, title, version, version_date, wf_create_time.

The following property names for channel groups are reserved for DIAdem and cannot be used:

channels, children, description, equipments, external_references, id, index, instance_attributes, measurement_begin, measurement_end, measurement_quantities, mime_type, name, objecttype, parent, registertxt1, registertxt2, registertxt3, root, sequences, sourceoriginalname, submatrices, test, units_under_test, version, version_date

The following property names for channels are reserved for DIAdem and cannot be used:

average, channel, children, datatype, deletebehaviour, description, dimension, displaytype, empty, external_references, flagkey, group, groupindex, id, implicit_increment, implicit_start, instance_attributes, internal_params, internal_res1, internal_res2, interpolation, is_scaled_by, length, lengthmax, local_columns, maximum, measurement, mime_type, minimum, monotony, name, NI_AssignmentDefaultValue, NI_AssignmentDefinitions, NI_CalculationReference, NI_XChnRelationName, novaluekey, number, objecttype, parent, quantity, rank, registerint1, registerint2, registerint3, registerint4, registerint5, registerint6, registertxt1, registertxt2, registertxt3, registerval1, registerval2, registerval3, registerval4, registerval5, registerval6, representation, scales, sourcedatafilename, sourcedatafilepath, sourcegenparam1, sourcegenparam2, sourcehandle, sourceinstancekey, sourcename, sourceparentname, sourceoriginalname, sourcerepresentation, sourcetype, sourcevalue, standard_deviation, status, type_size, unit, unit_string, valuetype, version, version_date, waveform, wf_increment, wf_samples, wf_start_offset, wf_start_time, wf_xnametype, wf_xunit_string, writeprotection

Note  Do not use NoValue as root, group, or channel name. Although this name is not forbidden, it may cause issues in various places.

Related Topics

Data Portal - List | Data Portal - Properties Display | Data Portal - Structure | Data Portal

Procedures

Changing the Channel References | Creating a Template for Custom Properties with a Script | Creating a Template for Custom Properties | Deleting Channels from the Data Portal | Drag and Drop Channels on Subaxes in 2D Axis Systems | Editing a Formula Channel in the Data Portal | Expanding Registered Channels | Filtering Channel Groups and Channels in the Data Portal with a Script | Filtering the Display of Channel Groups and Channels in the Data Portal | Generating a Formula Channel in the Data Portal | Generating Data Set, Group, and Channel Custom Properties in the Data Portal | Generating New Channels in the Data Portal | Generating New Groups in the Data Portal | Pinning Elements in the Data Portal with a Script | Playing Waveform Channels | Saving a Data Store | Specifying the Default Group in the Data Portal