System¶
The “System” entry in the burger menu adjusts global system settings.
User¶
Here a new or an existing user can be edited. Under User Information, the master data of the user can be maintained.
After information has been manipulated, it must be confirmed with “Save”.
Active¶
Specifies whether a user is allowed to log on. A user is set to inactive by the system if the user has entered the password incorrectly too many times.
User must change password¶
If this setting is active, the user must change the password the next time they log in. If the user has changed the password, this setting is automatically deactivated by the system.
Location¶
To give users a view of only specific branches, they can be assigned one or more locations. First, the type of location must be determined from the selection menu. The user can then be assigned one or more locations. If the user is assigned the locality type “Global”, the user gains access to all branches.
User groups¶
Finally, one or more user groups must be assigned to the user. With the assignment, the user receives the rights of the user groups
Deleting users¶
Users can also be deleted in the user view. if the user had created global profiles that still refer to him the following message appears:
By default, it is preselected that these profiles are transferred to another user. This user can be selected here or the transfer can be deactivated.
By clicking on “Delete” the references in the global profiles to the selected user are changed when the checkbox is activated and the profiles remain included. If the checkbox has been deactivated, the user’s global profiles will also be deleted.
If, on the other hand, the user does not have global profiles, a simple request for deletion appears and a message that no global profiles have been found:
By pressing the “Delete” button, the selected user is finally deleted, or with “Cancel” this dialog is terminated without changes.
Groups of userrights¶
The rights for users are managed by user groups (roles). Users can then be created and assigned to one or more rights groups. An example of a rights concept would be:
System administrator who is allowed to do everything
Engineer who is allowed to change new data points and the object tree
Power user who is allowed to create e.g. reports
Standard user who essentially uses existing things
Table of users¶
In the user table, already assigned users can be viewed, additional users can be added or users can be removed from the user group.
Rights¶
Finally, rights must be assigned to the user group. To do this, select the appropriate check boxes. Prohibiting a right is dominant over allowing a right when assigning multiple user groups conflicts with conflicting rights assignment.
Rights-Description¶
The rights that are available in the standard ResMa version are described here.
View Locations values¶
View measured values:
Allows the values and data of a branch to be viewed
View timers:
Enables the timers to be displayed (this is only available with certain connectors)
View faults:
Allows access to fault messages and their details
View comments:
Allows you to view the documentation and its number in the system statistics
View orders:
Enables the viewing of orders
Manipulate Locations¶
Manage Locations:
Allows you to edit & create a branch office
Manage connectors:
Allows the creation & editing of connectors in the connector view
Manage cost centers:
Allows you to create & edit cost centers in the cost center view
Manage consumer and resource nodes:
Enables the creation & editing of resource nodes and consumers, in the standard / resource view
Delete consumer:
Enables consumers and their underlying measuring points to be deleted
Manage measuring points:
Allows the creation & editing of measuring points
Delete measuring points:
Allows the deletion of measuring points
Manage manual input configurations:
Allows access and use of manual input
Enter or import values:
Enables the input & import of measuring point values
Edit target values:
Enables the creation / editing & deletion of setpoints
Correct values:
Allows measuring point values to be corrected / overwritten
Edit timers:
Allows the creation, editing & deletion of measuring points
View comments:
Allows the editing / creation & deletion of comments on stored documentation
Reset fault:
Enables faults to be reset in the fault window
Acknowledge fault:
Enables faults to be acknowledged in the fault window
Manage orders:
Allows the creation / editing & deletion of orders
Undo commissioning:
(Not available in standard version)
Edit peak load management:
(Not available in standard version)
Edit calendar entries:
Enables the creation / editing & deletion of calendar entries
Add value comment:
Allows the commenting of measuring point values
Manage value comment:
Allows you to edit and delete a comment after a measuring point value
Delete in time series:
Allows measurement points to be deleted from a time series view
Manipulate basic data¶
Edit value categories:
Allows you to view, create, edit & delete a value category in the value category page
Edit units:
Allows you to view, create, edit & delete units in the units window
Edit fault definition:
Allows you to view, create, edit & delete fault definitions in the fault definition window
Manage tariffs:
Allows you to view, create, edit & delete tariffs in the tariff window
Manage users¶
User administration - Edit settings:
Allows you to set the various users and their user groups as well as their rights (Attention! If this right is removed from an admin user, it cannot be added again without a second admin user and therefore no rights can be edited)
User administration - View settings:
Allows you to view the various user configurations
View input log:
Allows you to manage the input log via the input log page
Forced logout of users:
Allows you to log out another logged-in user
End user session:
Enables an explicit user to be kicked when logging in and there are too many active users to enable login
Manipulate system settings¶
Edit general settings:
Allows you to view and configure the general settings
Edit user-defined attributes:
Allows you to view and configure the user-defined attributes
Edit e-mail settings:
Allows you to view and configure the e-mail settings
Edit country settings:
Allows you to view and configure the country settings
Edit languages:
Allows you to view and configure the language settings
Edit fault forwarding settings:
Allows you to view and configure the fault forwarding settings
Edit derived values:
Allows you to view the “Derived values” page and enables you to edit derived values
Edit system reports:
Allows you to view and configure system reports (Telerik Reports)
Derived values Expert mode:
Enables the use of expert mode, a derived quantity formula
Edit order report:
Allows you to view and configure the report parameter page
Access to REST API:
Enables the use of the REST-API interface of ResMa
Edit additional information:
Allows you to view and configure the additional information page
Create database backup:
Allows triggering & configuring the database backup in the system statistics
Edit data deletion:
Allows you to view and configure the “Data deletion settings” page
Manage profiles¶
Create global profiles:
Allows the creation of profiles
Edit global profiles:
Allows profiles to be edited
Send private profiles to other users:
Enables private profiles to be sent to other users
Delete global profiles:
Allows the deletion of profiles
Manage fault forwarding¶
Interference forwarding - View:
Allows you to view the fault forwarding page
Fault forwarding - Edit settings:
Enables the configuration of fault forwarding
Energy monitor¶
Execute rules:
Allows the execution of created rules in the data analysis rules page
Manage rules:
Enables the creation, editing & deletion of rules
View PDCA cycles:
Allows you to view the active PDCA cycles in the system statistics and, in conjunction with the “Edit PDCA cycles” right, to display the PDCA cycles page
Process PDCA cycles:
Enables the creation, editing & deletion of PDCA cycles
Manage Shiftbooks¶
Edit Shiftbooks:
Allows access to the shift types page and the creation, editing & deletion of shift types
Show Shiftbooks:
Allows the shift books to be displayed
Edit shift models:
Enables the display and editing of shift models
Add shiftbooks:
Allows the addition of new shiftbooks
Edit shiftbooks:
Allows the editing & removal of existing shiftbooks
Transfer shifts to calendar:
Enables a shift to be transferred to the calendar
Add shiftbook entries:
Allows the addition of new shiftbook entries
Edit shiftbook entries:
Allows the editing & deletion of shift book entries
User management¶
In this view, user management settings can be manipulated.
After changing values, they must be confirmed with the “Save” button.
Maximum number of failed login attempts¶
Specifies the number of failed logon attempts to lock a user. After a user is locked, an administrator must set the user to active again.
Prohibit Right Enable Feature¶
If this function is activated, rights can not only be allowed in the user group settings, but also rights can be prohibited. If a right is prohibited in one user group, it is not possible for users of this group to obtain the right by membership of another group.
Length¶
The minimum number of characters required for a password.
Special character¶
Indicates whether at least one special character is required in the password.
Case sensitive¶
Specifies whether the password must be uppercase and lowercase.
Alphanumeric¶
Specifies whether the password must consist of letters and numbers.
Prohibit names in passwords¶
Specifies whether first name, last name or login name may be included in the password.
Input protocol¶
All critical inputs that result in changes to the system are stored in the input log. After selecting a time range, all inputs are displayed on the system.
Logged are:
Manipulation of the structure of the object tree (branches, consumers, measuring points)
Manipulation of values by means of a manual input function
Editing Custom Attributes
Changes in the user management such as allocating rights
Configuration forwarding malfunctions¶
ResMa® is able to forward any branch malfunctions to a maintenance provider. In this view, this functionality can be parameterized.
Confirm your entries with “Save”.
Alert recycling¶
If a alert occurs at short intervals and is reset again, ResMa® is added with an unnecessary number of alert entries. This can be prevented with alert recycling. If alert recycling is enabled, alerts that recur at a specified interval are reused. This means that no new entry is created, but the previous one is set back to active.
Mode¶
Disabled: ResMa® does not forward alerts to maintenance providers.
Semi-automatic: ResMa® creates forwarding orders for alerts, but does not send them off. All redirects must be shared by a user.
Automatic: Alerts occur are automatically forwarded by ResMa® to the maintenance provider.
Delay Forwarding (sec)¶
In this input field, it can be determined whether a certain time should be waited after receipt of a alert until it is automatically forwarded. If the alarm is reset during the waiting time or the forwarding order is deleted, no notification takes place. It is specified in seconds.
E-mail sender address¶
Enter here the sender address that should be displayed when forwarding via e-mail.
SMS sender address¶
Enter the sender address that should appear in the mobile phone display when forwarded via SMS.
Address for sending as SMS¶
In order for ResMa® to be able to forward alerts via SMS, it needs an e-mail address that receives the notifications and forwards them as SMS.
Acknowledgement¶
Receipts all arrive in a POP3 mailbox. Use the following fields to parameterize the settings for connecting to the POP3 mailbox. Continue to enter the interval in seconds where you want ResMa® to check for acknowledgements.
Units¶
In this view, units of the actual and target values can be created and changed. If you define a minimum and maximum value, the system ignores all values that do not fall within the value range. This serves to prevent implausible values from being transferred to the system in the event of alerty data acquisition or errors in sensors.
In addition, it is not possible to enter values outside the defined range via manual input. This limitation also applies if the minimum or maximum is not specified in the master data of the measuring point or has a different value.
Attention
Deleting units or changing their IDs may cause malfunctions within ResMa® when they are in use.
ID (The unique identification number of the unit)
Name [Power] (Power determines the amount of energy that a device consumes or generates in a moment. Example: A light bulb needs 100W to light up.)
Name [Work] (This indicates a total amount of energy consumed or generated over a period of time.
Example: 1 kilowatt hour corresponds to the energy consumed over 1 hour with an output of 1 kilowatt.)
Description (A description of the unit or possible additional information)
Minimum (Specifies the minimum value that a unit can have. For example, if you want all measuring points of this unit to have the same min value,
you can define it here and don’t have to define it separately at each measuring point. If you want to pursue this strategy, however, no min value may be stored in the measuring point itself)
Maximum (Specifies the maximum value that a unit can have. For example, if you want all measuring points of this unit to have the same max value,
you can define it here and don’t have to define it separately at each measuring point. If you want to pursue this strategy, however, no max value may be stored in the measuring point itself)
References (Indicates how many measurement points the unit has in use. Clicking on the number opens an overview dialog of all referenced measuring points.)
When using counters in a diagram, the Y-axis is automatically switched depending on which configuration of the measurement point is set.
Value Categories¶
Value categories create a way to display measurement points by default with a specific aggregation in the chart. To do this, a corresponding value category must first be created. This can then be stored in the master data of the desired measuring points. When using the measurement points in the chart, the aggregation of the assigned value category is now used by default. A switch to other aggregation is possible unchanged.
Attention
Deleting value categories or changing control IDs can cause the ResMa® to malfunction.
Derived values (calculation values/KPIs)¶
Derived values are calculation values with which virtual data points can be implemented. This allows KPIs to be generated or any value conversions (meter sums or CO² from energy, …). The quantities calculated in this way are arranged in the object tree like the ‘normal’ data points and can be used equally for all APPs.
When using class references, derived values can be defined to be created on all matching instances.
The historical data series resulting from derived values are only generated when the values are used and are not stored in the database. This takes some time, but has the advantage that if the formula or compression types are changed, the values are all corrected immediately.
Definition¶
A derived quantity is a calculation rule that can be composed of parameters (variables) and constants. Measuring points or other derived values can serve as parameters.
Values of derived values are not stored in the database, they are always carried out at runtime for the specific evaluation case on the basis of the calculation rule.
Usage¶
Derived values can be used as analogously as possible to simple measuring points and used in the various evaluation options of the system. For this purpose, they are displayed in the object tree like simple measuring points.
Edit derived value¶
In this view, derived values can be created and edited. First, enter a name and description. Then specify how the values for the representation should be aggregated, in which unit the value should be represented, and which category the value belongs to. You can then add measuring points to the derived size via drag & drop from the object tree.
Configuration¶
Derived values can be configured in a variety of ways. The most common configuration options are briefly described below.
Measuring point ID¶
Unique alphanumeric identifier for this derived quantity. This can be freely assigned and must be unique within a branch hierarchy in ResMa®.
Class¶
By assigning class names, it is possible to group several measuring points for evaluation purposes. For example, when adding a measurement point, the pivot evaluation queries whether only the individual value or all values of this class name should be added.
Description¶
Short description, which is also displayed in the tabular overview of the derived values. Editing the field is optional, but can be helpful to explain complex calculation steps or to explain the purpose of a calculation rule and thus increase the maintainability of the derived values.
Aggregate function¶
The aggregate function determines which function is used to aggregate, i.e. summarize, the values of a derived quantity. The value can be set to a fixed function such as sum or average to rigidly reproduce a single aggregate function.
In most cases, however, the Automatic aggregate function is appropriate. As a result, the aggregation is taken over from the evaluation environment, e.g. a report or diagram, and here can be flexibly switched during the viewing.
It is therefore advisable first of all to set the aggregate function predominantly to automatic and to change it to a rigid aggregate function only for those quantities whose change to another type of summary makes no sense in terms of content.
Outline level¶
The outline level defines where derived values are placed hierarchically in the object tree. Various options are available here.
Position¶
If the outline level is set to Manual: Set Position, the Input Field Position also appears*.* Here, a consumer can be selected in the object tree, under which the derived values should be classified.
Unit¶
Similar to measuring points, specify a unit for your derived quantity. You can also expand the units as desired via the System Units menu item à in ResMa®.
Value Category¶
Value categories are used to group measurement points and derived values into categories. For these categories, a specific compression can be set as the default value in the diagram. The entry point for this can be found in the menu under System Value -> Categories
Ressource¶
Inferred quantities can optionally be linked to a resource. This now makes it possible to calculate the price of derived quantities e.g. in the report or pivot. In addition, the calculated price also appears in the graph’s curve statistics. The Entry point for the resources can be found in the menu under Manage -> Resources
New calculation method for formulas¶
ResMa normally aggregates the raw data of the formula parameters according to the selected compression strength and then calculates the formula. In the past, this led to incomprehensible results. In order to make the calculation results more plausible without distorting older results, a new optional calculation logic has been introduced. This first calculates the formula with the raw data and then aggregates the results according to the selected compression level. Depending on the parameters, this new calculation method can lead to longer runtimes!
Expert mode for formulas¶
In expert mode, it is possible to specify SQL statements in the formula that can be used in SQL functions or stored procedures. Expert Mode has its own user right called “Derived Quantities Expert Mode”, which must be Active to unlock Expert Mode. It is important to note that these SQL statements follow the scheme of Microsoft SQL functions. If the formula does not adhere to the syntax of MS-SQL or is incorrect, the Derived Size will be created, but no associated stored procedure will be created and no data will be obtained. To validate the formula, it should be written in MS-SQL Studio if possible, checked and then copied into the formula field.
Examples of a possible formula in expert mode:
“SELECT TOP(1) [FirstName] from dbo.Namen”
“SELECT TOP(1) MyMeasurementPoint from dbo.Messpunkte”
“SELECT CASE WHEN (NumInput01 < 100) THEN 1 ELSE 0 END”
“SELECT CASE WHEN (NumInput02 = 10.0) THEN 1 ELSE 0 END”
This should only be applied by software-trained personnel and with knowledge of the data structures, as the operations are carried out directly on the database server! This is not useful to carry out without specific training measures.
Parameter¶
Parameters form the variable part of the calculation rule of a derived quantity. Due to the versatility of the derived size, there are also a variety of configuration options here.
Type of compression¶
Define the aggregate function at parameter level. The aggregate function defines which function is used to aggregate, i.e. summarize, the values of the parameter. The value can be set to a fixed function such as sum or average to rigidly reproduce a single aggregate function.
The Automatic option takes over the aggregation from the evaluation environment, e.B a report or diagram, and here can be flexibly switched during the viewing.
Depending on the use case, you need to decide whether automatic switching makes sense for a parameter or whether one of the rigid functions is the means of choice. In case of doubt, check the configuration of your calculation rule using a comprehensible data example in a report.
Acyclic parameters (parameter type)¶
Actual values can be switched between actual value and actual value (acyclic) in the Parameter Type field. Configuring it as an acyclic value has some peculiarities in determining the value for this parameter. These special features are explained in detail below.
Definition¶
If a parameter is defined as acyclic, it assumes the last single value before the start of the respective evaluation period. In an evaluation of the month of February 2020, the last value before 01.02.2020 00:00:00 is transferred to the parameter.
There is no aggregation of multiple values. In contrast to the cyclic values, only a single value is specifically adopted for acyclic parameters. Therefore, aggregations do not come into play, because a sum/average/min/max operation on a value always achieves the same result.
The value is included in the calculation until there is a change in value and thus the last available individual value is adopted again for the following periods.
Usage¶
A parameter should be configured as acyclic if …
… the derived quantity is evaluated at an interval (e.g. daily) that is more closely meshed than the recording of the value (e.g. monthly)
… its last value should also apply over intervals in which no value exists in the database
… only the last single value before the start of the respective evaluation interval should be included in the calculation
Not every measuring point that is filled as manual input is suitable for configuration as an acyclic parameter. Conversely, however, acyclic parameters are often measuring points that receive their values by manual input. For example, a counter value that is entered manually at the end of the month.
If derived values that contain acyclic parameters are also to be evaluated on an hourly or quarter-hour basis, the option should be set optionally for the acyclic parameters.
Example:
The following is a simply structured data example to illustrate how it works:
The values of the measuring point Manual Input Counter are recorded by manual input for the last of each month. The meter has only been in operation since 2021, before that no data is available. The following series of measurements is available for 2021:
31.01.2021 1001 kWh
28.02.2021 2120 kWh
31.03.2021 3334 kWh
30.04.2021 4120 kWh
31.05.2021 5650 kWh
30.06.2021 6979 kWh
14.08.2021 8234 kWh
31.08.2021 8755 kWh
30.09.2021 9356 kWh
From January to September, monthly values are available. In July, no value was recorded due to the summer holiday, this was added on 14.08.2021.
The following list uses the example of a monthly report over the year 2021 to show how acyclic parameters are included in the calculation. The value of the previous period is included as a basis for calculation in the following period. For January 2021, no value is included in the calculation, as there is no value in any previous period (in this case months). Since no value has been recorded for the month of July, the last available value of the previous periods (in this case June) is adopted in August. In August, two counter values are available. Here, too, the last available value of the previous period is adopted.
Options¶
Different options are available for each parameter, which can be activated using checkboxes and have an influence on the calculation of the individual parameters.
Global¶
If the parameter is marked as global, it is not referenced by its ID but by its name. Thus, the derived size can be placed anywhere where the parameter exists by name.
Optional¶
The value of a derived quantity can only be calculated if each parameter has values within an evaluation interval. If a parameter is optional, the derived quantity is calculated even if there are no values for that parameter.
This option must be set in particular for acyclic parameters whose derived values are also to be evaluated on an hourly or quarter-hour basis. Otherwise, no calculation can take place due to the cycle offset of the acyclic parameters.
Replace zero with 0¶
If no value exists for the parameter, it should be included in the calculation with the number 0.
Ignore 0 values¶
0 values are not included in the calculation. This comes into play, for example, if production-free times are not to be taken into account, because the sensors generate data during this period that is not conducive to a certain evaluation.
Important calculation rules¶
Operator Precedence¶
Aggregation before dot before dash applies. For example, if a parameter is declared as an average, the average value is first determined over the evaluation period before the value is further calculated.
Example:
The formula measuring point * 1.5 + 1 would be calculated step by step in a monthly evaluation of the average in January 2021 as follows:
Averaging as an arithmetic mean over all values of the measuring point available in January 2021
The monthly average is multiplied by 1.5
The product from the second step is added with 1
Another numerical example: There are two values for the measuring point in January 2021:
01.01.2020 08:00:00 10 31.01.2020 16:30:00 30
The calculation is therefore carried out step by step as follows:
Average: (10 + 30) / 2 = 20Multiplication: 10 * 1.5 = 30Addition: 30 + 1
Calculate with null values¶
If there is no value for a parameter, it is included in the calculation with a value of NULL. If an operant is NULL, the result is always NULL. Example: 1 + NULL = NULL
Divide by 0¶
When you create a formula in which a division is performed, a mathematical error can occur if the divisor is equal to 0. To prevent this, use the following notation: ValueA / NULLIF (ValueB, 0)
Temporal resolution of raw data of derived values¶
When calculating a derived value, a base interval is required to calculate values for these timestamps. This is for example specified by the report and chart by the compression.
If no compression is specified (for example Value APP), a minimum interval is calculated based on the taglog intervals of the parameters. If no parameter has a fixed tag log interval, one hour is assumed to be the interval.
To account for the taglog interval of a parameter, it does not need to be used in the formula. It is sufficient if it has been added to the derived value.
For the calculation of the hourly rates, the values of the previous interval are used.
If there are no values for the previous hour, then nothing is calculated. Exception: the parameter is marked as acyclic , then this value is valid until a successor value is available. For the special features, see chapter Acyclic parameter (parameter type).
Check derived values¶
Opens a tab with a list of all configured derived values and the ability to check them for errors.
Order Entry¶
In order to be able to enter orders automatically, appropriate configurations must be created. A configuration is required for each branch or consumer.
A configuration contains at least one text measurement point for the job name. If this value changes, a new order is automatically created. Specify a measurement point in the Parent Job field to assign the jobs to Another Job. You can also select a measuring point for each dynamic attribute.
Common Settings¶
Opens a view for setting general settings.
After changing values, they must be confirmed with the “Save” button.
Configure data fetch for Connectors¶
Here you define the interval in which ResMa requests the recorded data from the connectors.
Data fetch interval¶
This setting determines the time cycle in which ResMa requests the connectors to transmit their data.
Data fetch time of day¶
If the request interval is set to daily, a data request time can be configured. Otherwise the field is disabled.
Request data only if queue is empty¶
The requested data is processed successively by ResMa and held in a queue (Microsoft Message Queue) for this purpose.
If not all queue entries of the previous request interval could be processed, no further data should be requested. Otherwise ResMa would request data already placed in the queue again, as it has not yet gained knowledge of these data records. This leads to increased network load and a build-up of the queue. It is therefore strongly recommended to leave this option activated.
The threshold value at which ResMa should consider the queue empty can be configured in ResMaConfigs.xml via the property DataLoggerQueueSwell. The file is located in the ResMa installation directory.
The logic applies to both automatic and manual requests for data from the Connector. If the queue is longer than the threshold, the data is not requested.
The number of items currently in the queue is displayed in the system statistics.
System currency¶
This is where you specify the currency unit required for tariffs, for example. The default currency is the euro €.
Replacement text for empty orders¶
Specifies the default text that is inserted for orders without text.
Company logo¶
Enables the upload of an image (e.g., company logo) that is displayed in the upper right menu bar.
Default theme¶
Here you can change the standard layout (colors, icons, etc.) of ResMa
Data fetch interval¶
Specifies the refresh interval of the dashboard in minutes, during which the data is refreshed. The default setting is 5 minutes, and the possible value range is between 1 and 60 minutes.
Request configuration at connect¶
After a connection is terminated, the connectors request the configuration again. This is useful if data points were added/deleted or something was changed in the recording parameters during the connection loss. By transmitting the configuration, the connectors learn about this and can adjust their behaviour accordingly.
However, in networks with very frequent disconnections, constant transmission may overloa the network. Only in this case should this option be deactivated. A transmission of changed configuration must then be done manually via the connector view.
Settings data deletion¶
The aim of the data deletion function is to prevent the database from overflowing. The automatic deletion function can be used in two forms: data deletion by time or by database size.
Necessary right¶
Data deletion is secured by its own right. Only those who have this right can use the function or change the settings.
Configuration execution time¶
The execution time determines how often and at what time the function is executed. You can choose from:
Daily
Weekly
Monthly
It is important to know if and when other, data-intensive operations are performed on the server, e.g. a database backup. The execution of the deletion function should then not take place at this time.
Configuration to delete data after a time range¶
This is where the maximum age of the data in the database is determined. A distinction is made between meters and other data, such as
numerical, logical and string values
Alarms
Shiftbook entries
Configuration to delete data according to size¶
This is where the maximum size of the database is determined. To achieve this, the oldest value (timestamp) in the database is first determined, and then data is gradually deleted from this point until the database falls below the defined maximum size. In this case, the data is deleted in the same way as “Delete by time”.
Configuration testing¶
The “Test Configuration” button can be used to manually start the execution of data deletion with the specified configuration. However, the configuration must have been saved for this.
Clean up database¶
ResMa does not always delete elements sofot, but only marks them as deleted so that they are no longer displayed on the surface. These are, for example:
Measuring points, with associated historical data
Branches
A ‘Clean Database permanently’ and irrevocably deletes this data from the database, which is also supported by a corresponding message.
Display results¶
The results, or the protocol of the data deletion, can be found in the input log, or in abbreviated form at the bottom of the data deletion configuration page.
User-defined attributes¶
User-defined attributes are additional properties of a ResMa® element that can be created individually. These are displayed in the master data dialog below the standard attributes and have the group heading ‘User-defined attributes’.
The following elements can be equipped with user-defined attributes:
Branches
Consumer
Measuring
Orders
Shiftbooks
User-defined attributes can be edit via System –> Custom attributes.
The content is grouped into two parts. In the upper part is the title bar. Here the element can be selected via a selection menu, which is to be edited. There is a toolbar in the upper right corner.
The second part of the page is the table with the current content, either empty or with the already created custom attributes.
To add new elements, press the Add button (round icon with a plus sign) in the right corner of the table title bar.
For the editing and deleting of an existing attribute you use the buttons, which are automatically generated in the table row of the desired attribute.
Input parameters for custom attributes¶
Name: Unique identifier for storage in the database. Not visible to the later user.
Data type: Type of data to store in the field. The drop down option provides the ability to provide a predefined selection of strings. This makes the results easy to filter and evaluate later.
Column text: Display in the ResMa interface. Does not have to be unique, unlike the name.
E-Mail¶
In this view, the parameters for communication from the ResMa® to the e-mail server (SMTP) can be determined. The settings must then be confirmed with “Save”.
Test connection¶
Once the communication parameters have been defined, an e-mail can be sent from ResMa® for the test. To do this, specify a destination address. By clicking on “Test connection” an e-mail is sent. If the connection to the SMTP server cannot be established, an error message appears.
Countries¶
This table lists all countries.In addition to ID and name, ResMa® requires the time zone of the country and a graphic for the flag of the country. This list can be supplemented at any time.
Web-Links¶
Opens a tab with a list of all configured web links.
Web links can be added via the context menu in the object tree of a branch office, a consumer or a measuring point.
If web links are to point to resources outside of ResMa®, “http://” must be prefixed. The dialog for creating web links pre-populates the field accordingly. For internal links that refer to ResMa® pages, “http://” does not necessarily have to be preceded. However, it is recommended to precede “http://” uniformly.
Example internal link: [http://localhost:8080/Dashboard.aspx](localhost:8080/Dashboard.aspx) or dashboard.aspxexample external resource: [http://www.gti.de](www.gti.de)example IP: “http://192.168.0.1”
Languages¶
The user interface of the ResMa® is multilingual. The system texts are read from the database for display. In this table it is possible to edit existing languages or to add another language to the system. When creating or editing a language, one of the available default languages must be selected. Furthermore, a flag symbol can be added.
Translations¶
In this view, system texts can be translated. To do this, first select a translation direction from the drop-down list. It can be translated from any existing language into another. If a direction is selected, all system texts appear. In the second column, the reference text of the original language appears and in the third column, the translated text can be entered. The “Apply” button saves the texts. Newly registered users can then immediately use the changed texts.
Some texts contain placeholders that look like this: {0}. Each placeholder has a sequential number. These placeholders are required by the system to insert another text and must not be removed.
In some cases, it may be necessary to enter many translations at once. This can be simplified by importing translations. To do this, click on the import button in the toolbar. A dialog will then open to select the file to be imported. It should be noted that the file to be imported is an Excel 97 – 2003 workbook. These have the ending .xls. It should be noted that not every .xls file is an Excel workbook.
Therefore, it is recommended to export the language information, adjust it and then save it as shown in the following graphic. To do this, click file -> save as.
System Statistics¶
Opens a tab with system information. These serve to recognize to what extent the license has already been used and what amounts of data have been generated. When contacting the hotline, this information should be kept ready.
Addidtional informations¶
Here you can select all master data points of the various measurement points that are to be transmitted to an external broker via MQTT. Only the master data points that are available or filled in for the respective measuring point and that have been activated by the button are transmitted. In addition, there is the possibility to rename the names of the master data points for transmission. This offers purely optical or logistical advantages, such as easier identification in the MQTT message.