General Feature Release 10.0.13 – New features

Note

For known issues with this version, refer to Known issues.

Tip

For information on how to upgrade DataMiner, see Upgrading a DataMiner Agent.

DMS core functionality

SLSNMPAgent will now also use the SNMP++ library to forward SNMPv2 traps and inform messages [ID_27590]

From now on, SLSNMPAgent will also use the SNMP++ library to forward SNMPv2 traps and inform messages. This means that it will now use the same library to send SNMPv1 traps, SNMPv2 traps and inform messages and SNMPv3 traps and inform messages.

Note

• Because of limitations of the SNMP++ library, the inform message resend time cannot be set to a value less than 10ms. If you set it to a value less than 10ms, the default setting will be used instead (i.e. 30 ms).
• From now on, all SNMPv2 traps and inform messages will by default include the “1.3.6.1.2.1.1.3.0” (sysUpTime) and “1.3.6.1.6.3.1.1.4.1.0” (snmpTrapOID) bindings.

All client-server communication will now be encrypted by default [ID_27747]

From now on, all client-server communication will be encrypted by default.

DMS Protocols

Values displayed using scientific notation will now use a dot as separator [ID_27690]

Values set to be displayed using scientific notation will now use a dot instead of a comma as separator.

DMS Cube

DataMiner Cube - Alarm Console - Automatic incident tracking: Timeout and non-timeout alarms will now be grouped [ID_27299][ID_27877]

Up to now, when Automatic incident tracking was activated, timeout and non-timeout alarms would not be grouped. From now on, those alarms will be grouped with each other.

DataMiner Cube will now display more detailed information when you try to connect to a DataMiner Agent that is starting up [ID_27308][ID_27770]

When you try to connect to a DataMiner Agent that is starting up or that is being restarted, DataMiner Cube will now display more detailed information regarding the startup process.

Examples of messages that will be displayed:

• Offloaded files are currently being restored to Cassandra
• Starting element X

Correlation/Automation/Scheduler: Email report configuration [ID_27521][ID_27812][ID_27878] [ID_28032] [ID_28038][ID_28081]

In an Email action of a Correlation rule, an Automation script or a scheduled task, as well as in the Upload report to FTP and Upload report to shared folder actions in an Automation script, if you add a report based on a dashboard, you can now click a Configure button to open an embedded browser window where you can configure the necessary data feed selections as well as the following options:

• Add DMS info: Determines whether company details are displayed in the report.
• Add DMS logo: Determines whether the company logo is displayed in the report.
• Include feeds: Determines whether feed components are included in the report. By default, this option is not enabled.
• Stack components: Select this option if you want all components to be displayed below one another. This can be especially useful for dashboards containing large components (e.g. pivot tables) in order to make sure all data is displayed.
• Dashboard width: Allows you to select a custom width for the report.

Visual Overview: Conditional shape manipulation actions no longer require the shape to be linked to an element, service or view [ID_27569]

Up to now, the following conditional shape manipulation actions could only be configured on shapes linked to an element, service or view. From now on, these actions will no longer require the shape to be linked to an element, service or view.

• Show
• Hide
• FlipX
• FlipY
• Enabled

Note

In case of “Enabled”, the shape in question needs to be clickable.

Services and redundancy groups hosted by a disconnected DMA will now also be indicated as being disconnected [ID_27611][ID_27760]

Up to now, when a DataMiner Agent disconnected from the DataMiner System, the elements hosted by it were indicated as being disconnected by means of a special icon. From now on, also the services and redundancy groups hosted by it will be indicated as being disconnected by means of a special icon.

Visual Overview: Linking the view range of a trend graph component to session variables & specifying a custom view range [ID_27779]

A Visio shape showing a trend graph component can now be made to update session variables with its view range (i.e. start time and end time). To do so, add a shape data field of type SetVar, and set its value to “RangeStart:<VariableA>|RangeEnd:<VariableB>”

Example:

Shape data field	Value
SetVar	RangeStart:MyRangeVar1|RangeEnd:MyRangeVar1

Note

The values set in the session variables will be datetime text strings formatted according to the current culture.

Also, to have a trend graph component show a custom range, you can now add “Range:Start=<dateTimeTextA>,End=<dateTimeTextB>” to a shape data field of type ParametersOptions.

Example:

Shape data field	Value
ParametersOptions	Range:Start=<dateTimeTextA>,End=<dateTimeTextB>

Note

• You do not have to specify two time values. You can specify a start time, an end time or both (separated by a comma).
• The datetime text strings need to be formatted according to the current or invariant culture.

Cube launcher tool: Silent installation, modification and uninstallation of Cube [ID_27795]

Using the following command-line arguments, it is now possible to use the Cube launcher tool to silently install, modify and uninstall DataMiner Cube without any user interface.

General syntax

PathToCubeExe.exe <arguments>

Note

All arguments and options are case insensitive.

Arguments to install DataMiner Cube

Argument	Description
/Install	Check whether DataMiner is installed, and if not, open the installation wizard.
/Install /Silent	Check whether DataMiner is installed, and if not, install DataMiner Cube and exit when done. If no options are specified using an /InstallOptions argument, the default installation options will be used.
/InstallOptions	Comma-separated list of additional installation options: - DesktopShortcut (add a desktop shortcut) - NoDesktopShortcut (do not add a desktop shortcut) - StartMenuShortcut (add a start menu shortcut) - NoStartMenuShortcut (do not add a start menu shortcut) - StartOnLogin (start Cube in the system tray after login) - NoStartOnLogin (do not start Cube in the system tray after login) - OpenAfterInstall (open Cube launcher tool after installation) - NoOpenAfterInstall* (do not open Cube launcher tool after installation) * Default option for silent installs

Example of a silent command to install DataMiner Cube when no installation could be found:

PathToCubeExe.exe /Install /Silent /InstallOptions:StartOnLogin

Arguments to modify DataMiner Cube after installation

Argument	Description
/Modify	Open the “Modify installation” window. If there is a /ModifyOptions argument, the options specified in that argument will be preselected.
/Modify /Silent	Silently modify the DataMiner Cube installation using the options specified in the /ModifyOptions argument.
/ModifyOptions	Comma-separated list of modification options: - ClearProtocolCache - ClearVisioCache - ClearVersionCache (remove all cached versions) - RemoveVersion:versionnumber (remove the specified version from the cache)

Example of a silent command that will clear the protocol cache, clear the Visio cache and remove two versions from the cache:

PathToCubeExe.exe /Modify /Silent /ModifyOptions:ClearProtocolCache,ClearVisioCache,RemoveVersion:9.5.1638.4080,RemoveVersion:10.0.2042.1636

Arguments to uninstall DataMiner Cube

Argument	Description
/Uninstall	Open the uninstall window.
/Uninstall/Silent	Silently uninstall DataMiner Cube.

Protocols & Templates: Information template editor now also allows you to configure parameters of type Button and ToggleButton [ID_27823]

As to button parameters, up to now, the information template editor only allowed you to configure parameters of type PageButton. From now, it will also be possible to configure parameters of type Button and ToggleButton.

DataMiner Cube: Buttons to join and leave cluster renamed [ID_27863]

On the Agents > Manage page in System Center, the Add cluster and Delete cluster buttons have been renamed to Join cluster and Leave cluster, respectively.

New EPM card settings [ID_27874]

In the DataMiner Cube user settings, you can now configure the following EPM card settings:

• Default EPM card page
• How to show EPM card Visual pages

Visual Overview: Info keywords can now be used as dynamic placeholders in other shape data fields [ID_27880]

All keywords that can be specified in shape data fields of type “Info” can now also be used as dynamic placeholders in shape data fields of other types.

When using one of those keywords in a shape data field of type other that “Info”, make sure to enclose it in square brackets similar to other placeholders.

Example: [var:[NAME]]

Visual Overview: Automation script session variables & OnClosing shape data field [ID_27895]

In Visual Overview, it is now possible to pass Automation script output to session variables. Also, you can now use the page-level shape data field OnClosing to configure whether a Visual Overview window should automatically be closed or not.

Passing Automation script output to session variables

When an Automation script executed in Visual Overview finishes successfully, it is now possible to pass the output values of that script to session variables in Visual Overview using the new CreateKey(string variablename) method (namespace: Skyline.DataMiner.Automation, class name: UIVariables.VisualOverview).

In the following example, a session variable named “MyOutput” will be created and will receive the value “MyValue”.

engine.AddScriptOutput(UIVariables.VisualOverview.CreateKey("MyOutput"), "MyValue");

• If you execute the same Automation script on different pages, then you can use the SessionVariablePrefix option to make sure the output is saved in separate session variables.

  If, for example, you use prefix “One_” on one page and prefix “Two_” on another page, and the Automation scripts pass their output to a session variable named “MyPage”, then the output will end up in two separate session variables named “One_MyPage” and “Two_MyPage” respectively.

• When you set the SetVarOnFail option to true (either on page level or shape level), then the session variables in question will always be created, regardless of whether the script finishes successfully or not.

New 'OnClosing' shape data field

From now on, you can use the page-level shape data field OnClosing to configure whether a Visual Overview window should automatically be closed or not.

In a shape data field of type OnClosing, specify a script (example: Script:MyScript), and make sure the script contains an instruction like the following one:

engine.AddScriptOutput(UIVariables.VisualOverview.ClosingWindow_Result, ClosingMode.Continue.ToString());

The session variable named ClosingWindow_Result can be set to “Continue”, “Stop” or “Abort”. In the example above, it is set to “Continue”.

If ClosingWindow_Result is set to “Stop”, a message box of type “Yes/No” will appear. If the user then clicks “Yes”, the window will be closed.

Note that, in the session variable named ClosingWindow_Message, you can specify a custom message to be displayed. If you specify such a message, then it will be shown in a message box of type “OK”, regardless of the value of the ClosingWindow_Result variable. However, if ClosingWindow_Result is set to “Stop”, then this custom message will be displayed in the message box of type “Yes/No” mentioned above.

Note

• The OnClosing shape data field only works for windows. It does not work for popups or tooltips.
• The OnClosing and OnClose shape data fields do not influence each other. Both function independently from each other.
• If you want to combine OnClosing and OnClose, then in Visual Overview, you can pass session variable X to the OnClosing script and make it return session variable Y. That variable can then be passed to the OnClose script, which can optionally be made to return session variable Z.

Visual Overview: New AutoIgnoreExternalChanges option when embedding a Service Manager component [ID_27899]

Up to now, when embedding a Service Manager component in Visual Overview, you could specify the AutoLoadExternalChanges option if you wanted external changes to be loaded automatically when there were no local changes. From now on, you can also specify the AutoIgnoreExternalChanges option if you want external changes to be discarded automatically.

Both options will keep the information bar from being displayed at the bottom of the Visual Overview, asking the user to load or discard the external changes.

Note

If you specify both options, then AutoLoadExternalChanges will take precedence over AutoIgnoreExternalChanges:

• As long as there are no (unsaved) client-side changes, external changes will be loaded automatically.
• As soon as there are (unsaved) client-side changes, external changes will be discarded.

Trending - Pattern matching: New options when adding or editing a tag [ID_27954]

When adding or editing a tag, you can now select the following additional options:

Option	Description
'<instanceName>' only	Select this option if you want the tag to only match one specific display key and parameter.
Generate alarm when detected	Select this option if you want suggestion events to be generated when a match is detected in the trend data.

Note

When you save a tag after selecting the Generate alarm when detected option, a message box may appear, saying that suggestion events cannot be generated for that tag. This is due to the range of the tag being too large. The tag itself will be saved and detected.

Trending: Trend percentile will now be calculated using either average or real-time trend data [ID_27965]

Up to now, the trend percentile was calculated using the most detailed data set that was available. In cases where the trend window contained both real-time and average trend data, it would be calculated using both types of data.

From now on, from the moment the trend window contains average data points in its most detailed set, only average data will be used for the calculation. This is also be reflected in the percentile menu, where a warning icon will be shown. A tool tip on the warning icon will indicate when only average data will be used.

Cube launcher tool: Aliases [ID_27975][ID_27999]

When defining a DataMiner Agent in the Cube launcher tool, apart from the host name or IP address, you can now also specify an alias.

By default, the alias will be identical to the cluster name. If you specify a custom alias, it will replace the cluster name in the Cube header.

Command-line arguments: /Alias=Xyz /Host=hostname

Note

Always use the /Alias argument in conjunction with the /Host argument.

The alias will be used as long as the client is connected to the host specified in the Host argument.

System Center: Enhanced Database section [ID_27976]

The Database section of System Center now has three main tab pages.

• In the General tab page, you can select “Database per agent” or “Database per cluster”.

  • When you select “Database per agent”, you can configure the local databases per agent.
  • When you select “Database per cluster”, you can configure a Cassandra cluster acting as a shared local database.

• In the Offload tab page, you can configure the data offloads to a central database.

• In the Other tab page, you can configure an additional database.

Trending: Real-time pattern matching [ID_28054]

Up to now, pattern matching happened on the fly when a trend graph was opened. Now, apart from this so-called static pattern matching, DataMiner is also able to perform real-time pattern matching and generate an alarm as soon as a pattern is detected.

When you create a pattern in DataMiner Cube, you can now select the following new options:

• When you select the Generate an alarm when detected option, DataMiner will track the pattern in real time and trigger a suggestion event each time it detects the pattern.

  When you do not select this option, DataMiner will behave as before and use static pattern matching instead.

• When specifying the parameter, in case of a table parameter, you can now also add the display key.

Note

This option is not linked to the type of pattern matching that is being used (static or real-time).

Limitations

• If you tag a pattern for a parameter of which the polling time is specified in the protocol, then the pattern must have less than 5000 real-time points. If the polling time is not specified in the protocol, then the pattern must be shorter than 24 hours. When you select a longer pattern, DataMiner Cube will display a warning and revert to static pattern matching for that specific pattern.

• For real-time pattern matching, DataMiner will only use a maximum of 2 GB of internal memory.

  • As soon as DataMiner uses more than 1.5 GB of internal memory for real-time pattern matching, the following notice will appear in the Alarm Console:

    Pattern matching memory high, adding more patterns or parameters might reduce matching accuracy.

    This notice will appear at most every 2 weeks or after a DataMiner restart.

    In order to reduce memory usage, users can either remove patterns that are being tracked in real time or restrict the number of parameters for which patterns are being tracked in real time (e.g. by specifying a display key in case of table parameters).

  • As soon as DataMiner uses more than 2 GB of internal memory for real-time pattern matching, the following notice will appear in the Alarm Console:

    Pattern matching memory critical, patterns with suggestion events enabled may not match properly.

    This notice will appear at most every 2 weeks or after a DataMiner restart.

    Also, when users create a pattern, DataMiner will now always revert to static pattern matching, even if they selected the Generate an alarm when detected option.

  • DataMiner checks all changes made to parameters for which patterns are being tracked in real time. If there are more than 6000 parameter changes per second, the following notice will appear in the Alarm Console:

    High load on pattern matching functionality: reduced pattern match accuracy.

Suggestion events

In case of real-time pattern matching, pattern occurrences are communicated to the user by means of suggestion events in the Alarm Console, i.e. alarms with severity “Information” and source “Suggestion Engine”. These events can be displayed in a separate Suggestion events alarm tab.

DMS Reports & Dashboards

Dashboards app: Generic Query Interface [ID_24048][ID_24548][ID_25898][ID_25921][ID_26050] [ID_26153][ID_26448][ID_26477][ID_26793][ID_27616][ID_27678][ID_27949][ID_27987][ID_28010] [ID_28071]

The Generic Query Interface allows you to efficiently tap into the wealth of data available in your DataMiner System. In this release, the interface is available via the Queries data input for Bar chart and State visualizations, as well as in the new Table and Pie Chart visualizations, which were especially created for this feature. In future releases, additional functionality using the Generic Query Interface will become available. Note that this feature is only available if DataMiner uses a Cassandra database. For some queries, an Elasticsearch database is also required.

Using the Queries data input

You can construct a query to use as data input for a component by following these steps:

1. In edit mode, select the dashboard component for which you want to use a query as a data input. At present, this is support for Bar chart, State and Table components.

2. In the data pane, select Queries and click the + icon to add a new query.

3. Specify a name for the query.

4. In the drop-down box below this, select the data source you want to use. At present, the following options are available:

   • Get elements: The elements in the DataMiner System.
   • Get parameter table by alias: The parameter table using the specified alias in the Elasticsearch database.
   • Get parameter table by ID: The selected parameter table from the element with the specified DataMiner ID and element ID.
   • Get parameters for element where: The selected parameters for the specified protocol or the parameters linked to the specified profile definition. Note that if parameters are displayed based on a specific protocol, it is not possible to combine a table parameter with other parameters, and only column parameters from the same table can be displayed in the same query.
   • Get services: The services in the DataMiner System.

5. Select an operator. This step is optional; if you do not select an operator, the entire data set will be used. The following operators are available:

   • Aggregate: Allows you to aggregate data from the data source. After you have selected this option, first select the aggregation column, and the method that should be used. Depending on the type of data available in the selected column, different methods are available, e.g. Average, Count, Distinct Count, Maximum, Median, Minimum, Percentile 90/95/98 or Standard deviation.

     You can then further filter the result by applying another operator. An additional Group by operator is available for this, which will display the result of the aggregation operation for each different item in the column selected in the Group by column box.

   • Column manipulations: Creates a new column based on existing columns. When you select this option, you also need to select a manipulation method.

     If you choose the Concatenate method, you will need to select several columns and then specify the format that should be used to concatenate the content of those columns, using placeholders in the format {0}, {1}, etc. to refer to those columns.

     If you choose the Regexmatch method, you will need to select a column and specify a regular expression, so that the new column will only contain the items from the selected column that match the regular expression.

     For both manipulation methods, you will also need to specify the name for the new column. When the column manipulation operation is fully configured, you can further fine-tune the result by applying another operator.

   • Filter: Filters the data set. When you select this option, select the column to filter, specify the filter method (e.g. equals, greater than, etc.) and the value to use as a filter. The available filter methods depend on the type of data in the selected column. Once the filter has been fully configured, you can refine the results by applying another operator, e.g. an additional filter.

   • Join: Joins two tables together. When you select this option, in the Type drop-down box, you will first need to select how the tables should be joined. Then you will need to select another data source (optionally refined with one or more operators) in order to specify the table you want the first table to be joined with. Optionally, you can also specify a condition to determine when rows should be joined. For instance, if one table contains elements with a custom property that details a booking ID and the other lists bookings, you could add the condition that the property in the first table must match the ID in the second table.

     The Inner type of join only includes rows if they match the condition. Left displays all rows from the first table (i.e. the table on the left) and only the matching rows from the other table. Right does the opposite. Outer displays first the non-matching rows from the left table, then the matching rows from both tables, then the non-matching rows from the right table.

   • Select: Displays the selected columns only. When you have selected the columns to display, you can apply another operator to refine the query.

   • Top X: Displays the top or bottom items of a specific column, with X being the number of items to display. When you select this option, you will need to specify the column from which items should be displayed and the number of items that should be displayed. By default, the top items are displayed. To display the bottom items instead, select the Ascending checkbox.

6. Drag the configured query to the component in order to use it.

Note

• It is possible to refer to a query in the dashboard URL, using the following format: ?queries=[alias]\x1F[queryJsonString]
  In this format, [alias] is the name of the query and [queryJsonString] is the query in the format of a JSON string, for example:
  ?queries=Get Elements/{"ID": "Elements"}.
• When a query has been created, the columns from the table that results from the query are available as individual data items in the data pane, so that you can use them to filter or group a component.
• It is not possible to retrieve data from a stopped element.

Table visualization

This new visualization was especially designed to be able to display the results of queries in a table format. It only supports query data input. It displays the different data sources as follows:

• Elements are represented with a row for each element, with each column detailing different information for that element.
• Services are displayed in the same way as elements.
• Table parameters are displayed as they are, as determined by the applied operators.
• If parameters are retrieved by protocol or profile definition, each row will represent a matching element, and for each parameter a column will show the corresponding values.

You can resize the columns of the table by dragging the column edges. Clicking on a column header will sort the table by that column. To toggle between ascending and descending order, click the column header again. To sort by multiple columns, keep the Ctrl key pressed while clicking the column headers. The first column will then be used for the initial sorting, the next one to sort equal values of the first column, and so on.

In the Layout tab for this component, the Column filters option is available, which allows you to highlight cells based on a condition. To do so, select the parameter you want to use for highlighting, indicate a range to be highlighted, select the range and then click the color icon on the right to specify a highlight color. Multiple ranges can be indicated for one parameter, each with a color of its own.

Pie Chart visualization

This new visualization was designed to display the results of queries in a chart shaped like a pie or donut. It only supports query data input.

The following layout options are available for this visualization:

• Chart shape: Can be set to Pie or Donut.

• Legend: The legend can be hidden. If it is set to be displayed, you can select whether it should be displayed on the left, on the right, at the top or at the bottom of the visualization.

• Tooltips: Tooltips can be hidden. If they are set to be displayed, you can select whether these should include the label, dimension, value and/or percentage.

In addition, the following settings are available for this visualization:

• Label: Allows you to select which data should be used as a label.

• Segment size: Allows you to select which data should determine the size of segments in the chart.

Bar chart visualization changes

A number of changes have been implement to the bar chart visualization, in order to optimize this visualization to display queries.

If the visualization displays a query, in the Settings tab, the following options are available instead of the usual options for a bar chart:

• Label: Allows you to select which data should be used as a label.
• Bars: Allows you to select which data should determine the size of bars.

In addition, the following layout options can now be configured for this visualization:

• Chart layout: Can be set to Relative or Absolute. Relative means that the dimension of each bar is shown as a relative percentage. Absolute means that the dimension of each bar is shown as an absolute numeric value.
• Chart orientation: Determines how the chart is displayed, i.e. from left to right, from right to left, from top to bottom or from bottom to top.
• Legend: The legend can be hidden. If it is set to be displayed, you can select whether it should be displayed on the left, on the right, at the top or at the bottom of the visualization.
• Tooltips: Tooltips can be hidden. If they are set to be displayed, you can select whether these should include the label, dimension and/or value.

Dashboards app: Selecting an empty folder will now cause a 'Create dashboard' button and a 'Import dashboard' button to appear [ID_27579][ID_27844]

When, in the sidebar of the Dashboards app, you select an empty folder, two large buttons will now appear in the large pane on the right.

Click...	to...
Create dashboard	create a new dashboard from scratch in the folder you selected.
Import dashboard	import an example dashboard in the folder you selected.

Note

The two above-mentioned options will also be available in the context menu when you right-click a folder in the navigation pane.

Dashboards app: Default themes updated [ID_27636]

In the Dashboards app, the default themes have all been updated.

Dashboards app - Line chart component: Value range [ID_27774]

When configuring a line chart component, you can now specify a value range for the trend graph by entering a minimum limit and/or a maximum limit.

The value range you specify will apply to all trend lines displayed on the graph.

Dashboards app - Line chart component: Show minimum, maximum and/or average trend lines [ID_27815]

When configuring a line chart component that does not show real-time trend data, you can now make the trend graph show a minimum, a maximum and/or an average trend line by switching on the following options:

• Show average (default setting: switched on)
• Show minimum (default setting: switched off)
• Show maximum (default setting: switched off)

Dashboards app - Parameter feed: 'Auto-select all' option [ID_27816][ID_28033]

When configuring the Parameter feed, up to now, it was possible to either have a specific number of indices selected automatically or have all indices selected automatically.

• Auto-select number of indices
• Auto-select all indices

Now, the above-mentioned options have been replaced by the “Auto-select all” option. When this option is selected, all items will be selected according to the "Select all behavior" settings below it:

• If you select the “Select all items” option, "Select all" will select all items. For a partial table, only the items from the first page will be selected.
• If you select the “Select specific number of items” option, a box is displayed below it. In this box, you should specify how many items "Select all" should select. For a partial table, these items will be selected across different pages.

Dashboards app - Line chart component: New 'Chart limit behavior' setting [ID_27841]

When configuring a line chart component, you can now use the Chart limit behavior setting to indicate what needs to happen when the number of parameters in the chart exceeds the defined chart limit:

Option	Behavior
Disable parameters in legend	The excess parameters are disabled in the chart but remain available in the chart legend, so that they can be enabled again manually. This option is selected by default.
Create additional charts	Additional charts are displayed that include the parameters that exceed the limit. If necessary, multiple additional charts will be displayed, each respecting the configured limit.

Dashboards app - Pivot table component: Sort ascending/descending [ID_27862]

When configuring a pivot table component, you can now find the following settings in the Sort section of the Settings tab:

Setting	Description
Sort	Allows you to select a protocol (if the pivot table contains multiple protocols) and a parameter by which the table should be sorted.
Sort ascending	Determines the order in which the pivot table is sorted. If you clear this checkbox, it is sorted in descending order.

Note

Using these sort settings in conjunction with the Limit setting in the Configure indices section, you can produce a top X or bottom X list.

DMS Automation

Interactive Automation scripts: Tree view items now have an IsCollapsed property [ID_27756]

When, in an interactive Automation script, you define a tree view control (i.e. a UIBlockDefinition of type TreeView), you can now use the TreeViewItem property IsCollapsed to indicate whether an item should be collapsed or expanded.

Note

This property will not be updated when you collapse or expand tree view items in the UI.

DMS Web Services

Web Service API v1: New GetDataMinerClusterName method [ID_27951]

The GetDataMinerClusterName method can now be used to retrieve the name of the DataMiner System a DMA is part of.

DMS Mobile apps

Ticketing app: Move to Elasticsearch database and other improvements [ID_24667][ID_25539] [ID_25713][ID_26644][ID_26676][ID_26677][ID_26911][ID_26982][ID_27974][ID_28016][ID_28043] [ID_28079][ID_28153]

Multiple changes and improvements have been implemented to the Ticketing app. The most important change is that the app will now use the Elasticsearch database instead of the Cassandra database.

When you install DataMiner 10.0.13 and you already use an Elasticsearch database, all ticketing data will be migrated automatically. If you do not have an Elasticsearch database and you have installed DataMiner 10.0.13, the ticketing data will be migrated automatically as soon as you add an Elasticsearch database to you DataMiner System. However, until you do so, you will no longer be able to use the Ticketing app. A run-time error in the Alarm Console will indicate that Ticketing Manager could not be initialized because there is no Elasticsearch database.

When you interact with the Ticketing Manager in scripts, keep the following changes in mind:

• A ticket now has a UID property of type GUID, which is always unique and which replaces the TicketID object. This object was used with the Cassandra database and consisted of a DataMiner ID and ticket ID. However, in Elasticsearch, the DataMiner ID is no longer needed. While tickets will still have a unique ticket ID, new implementations should make use of the UID instead.

• A new TicketingHelper is available that should be used to read, create, update and delete tickets, ticket field resolvers and ticket history in scripts. The existing TicketingGatewayHelper remains backwards compatible, but should not be used for new implementations or to update existing code. Below you can find an example of how to use this helper:

  public void Run(Engine engine)
  {
      // Create the helper
      var helper = new TicketingHelper(engine.SendSLNetMessages);
  
      // helper.[OBJECT TYPE].[ACTION]
      // helper.Tickets.Update();
      // helper.TicketFieldResolvers.Delete();
      // helper.TicketHistories.Read();
  
      // Create a TicketFieldResolver
      var ticketFieldResolver = TicketFieldResolver.Factory.CreateDefaultResolver();
      var createdResolver = helper.TicketFieldResolvers.Create(ticketFieldResolver);
  
      // Create a Ticket
      var newTicket = new Ticket()
      {
          CustomFieldResolverID =  createdResolver.ID
      };
      var createdTicket = helper.Tickets.Create(newTicket);
  
      // Read the TicketHistory
      var historyFilter = TicketHistoryExposers.UniqueID.Equal(createdTicket.UID);
      var history = helper.TicketHistories.Read(historyFilter);
  
      // Read all Tickets linked to a TicketFieldResolver
      var ticketFilter = TicketingExposers.ResolverID.Equal(createdTicket.CustomFieldResolverID);
      var tickets = helper.Tickets.Read(ticketFilter);
  
      // Delete Tickets
      foreach (var ticket in tickets)
      {
          helper.Tickets.Delete(ticket);
      }
  
      // Check if the last Ticket request failed
      var traceData = helper.Tickets.GetTraceDataLastCall();
      if (!traceData.HasSucceeded())
      {
          engine.GenerateInformation($"Previous action failed! {traceData}");
      }
  }
  

• To check if a request was successful, you can now retrieve the TraceData using the GetTraceDataLastCall() method on the CrudComponentHelper type used for the request. This returns the TraceData object, which can contain TicketingManagerError objects, each containing a reason for the error and extra data on what caused it. These are the possible errors:

  • TicketFieldResolverInUseByTickets: The ticket field resolver still has tickets linked to it. (The property RelatedTickets contains the IDs of the tickets.)

  • NotInitialized: The Ticketing Manager is not initialized.

  • LegacyError: A legacy error has occurred. (The property LegacyErrorMessage contains the error message.)

  • TicketLinkedToNonExistingTicketFieldResolver: The created/updated ticket has a link to a ticket field resolver that does not exist. (The property TicketFieldResolverId contains the ID of that ticket field resolver.)

  • TicketFieldResolverIsUnknownOrNotMasked: The ticket field resolver is unknown or not masked.

  • UnexpectedException: An unexpected exception occurred. (The property Exception contains the exception.)

  • TicketLinkedToMaskedTicketFieldResolver: The created/updated ticket has a link to a ticket field resolver that is masked. (The property TicketFieldResolverId contains the ID of that ticket field resolver.

  Calling ToString() on the TraceData object will return a formatted string that shows all errors and associated data.

• When paging is started using TicketingGatewayHelper.NewPagingRequest(), the out parameter will no longer return the total number of tickets.

• When an invalid page size or page number is used in a request, an empty list will now be returned, while previously the ticketing helper returned all tickets matching the filter.

• Subscribing to TicketingGatewayEventMessage will no longer return an initial bulk. Instead tickets and ticket field resolvers should be retrieved via paging with the new TicketingHelper.

• Previously, when the Cassandra database was used, all open tickets were stored in the cache as well as the database. It was therefore possible to use the CacheOnly boolean in requests to retrieve only open tickets. This cache is no longer used, so using the CacheOnly boolean will no longer work when you use NewPagedTicketsWithFilterMessage. To resolve this, concatenate the filter with an open tickets filter, which you can retrieve using the new method GetTicketStateFilter(TicketState ticketState). An exception was made for the GetTickets method of the existing TicketingGatewayHelper, which will still only return the open tickets.

• "Null" values of ticket fields will no longer be saved or returned.

• The open state of a ticket can no longer be linked to the state of an alarm.

• If GenericEnumEntry<int> is used in VisualData on a TicketFieldResolver, this will now always be returned as a long integer instead of an integer.

• If the ticket field resolver defines a state TicketFieldDescriptor, tickets must now always contain a field indicating their state. When tickets are initially migrated to Elasticsearch, a state will automatically be defined for any tickets where this was not yet the case.

The following changes have been implemented in the web services API v1:

• The DMATicket, DMATicketSelection and DMATicketUpdate objects have a new UID property which contains the new GUID identifier of a ticket.

• The PageSessionID and TotalTicketsCount properties of the DMATicketsPage object are now obsolete.

• The DMATicketsPage object now has a new HasNextPage property, which indicates if there is another page after the currently requested page.

• The new methods GetTicketV2, RemoveTicketV2, GetActiveTicketsV2 and GetHistoryTicketsV2 are now available, to be used instead of GetTicket, RemoveTicket, GetActiveTickets and GetHistoryTickets.

Finally, the following changes have also been implemented:

• To include tickets in a custom backup, the backup option Create a backup of the database > Include Ticketing in backup must be selected.

• When you embed the Ticketing app in another page, you can now add embed=true to its URL in order to hide the side bar and header bar of the app.

• You can now add a filter in the Ticketing URL to only show tickets affecting a specific element, service, view or redundancy groups. To do so, add a filter in the following format: affecting=[type]/[DataMiner ID]/**[object ID], where [type] can be element, service, view or redundancy group. For example: affecting=element/299/31

• When you view or edit a ticket in the app, the URL has now changed; while previously, it contained the DMA ID and ticket ID, it now contains the ticket UID. If you use an old URL, the Ticketing app will automatically try to adjust this to the new URL.

• The default page size for the ticket list in the Ticketing app has been increased to 50.

• Instead of AngularJS, the Ticketing app now uses Angular.

• The log file SLTicketingGateway.txt has now been replaced by SLTicketingManager.txt.

Note

The Ticketing Gateway entry in the Cube Logging app now refers to the new file.

HTML5 apps: Loading indicator of selection boxes will now be displayed on the right [ID_27871]

When values are being loaded into a selection box, from now on, the loading indicator will be displayed on the right instead of on the left.

DMS Service & Resource Management

Binding between a VirtualFunctionResource and a physical device element will now automatically be updated when the protocol of the device element changes [ID_27466]

When a virtual function resource is bound to a physical device element, that binding will now automatically be updated when the protocol of the physical device element changes.

• When the updated protocol of the physical device element is no longer supported by the VirtualFunctionDefinition of the resource, the resource will automatically become unbound and a notice will be generated for all such resources, stating that the new protocol no longer supports the binding.

• When the updated protocol of the physical device element is still supported by the VirtualFunctionDefinition but now uses an entry point table, the resource will be unbound as the row in the entry point table that needs to be bound to is unknown.

• When the updated protocol of the physical device element is still supported but no longer uses an entry point table, the resource will be unbound as the protocol used to support multiple resources binding and now only supports one resource binding.

• When the protocol of the physical device element is changed to a different protocol, which is also supported by the VirtualFunctionDefinition used by the resource and which uses the same binding method (entry point table or not), the resource binding will automatically be updated.

DMS tools

StandaloneElasticBackup tool [ID_27683]

The StandaloneElasticBackup.exe tool allows you to back up and restore Elasticsearch database clusters.

General syntax

StandaloneElasticBackup.exe <action> <arguments>

Actions

This tool allows you to perform the following actions:

Action	Description
init	Initialize a repository.
backup	Take a backup/snapshot.
restore	Restore a backup/snapshot.

Example:

StandaloneElasticBackup.exe backup --host 127.0.0.1 -u elastic --pw mypw123 -r reponame

General arguments

• --host or -h: The host on which the command has to be run. Default: 127.0.0.1.
• --port or -p: The port on which Elasticsearch will be contacted. Default: 9200.
• --username or -u: The username that has to used to connect to Elasticsearch. Only use this option when credentials have to be used.
• --pw: The password that has to used to connect to Elasticsearch. Only use this option when credentials have to be used.

Arguments to add when you want to initialize the repository

Run StandaloneElasticBackup.exe with the following two (mandatory) arguments to initialize the repository that should be made to take a snapshot.

• --repo or -r: The name of the repository to be created.
• --path: The path of the repository as defined in the yaml.xml file of the Elasticsearch cluster, enclosed by “”. This is the location where the snapshot will be placed.

Note

• Snapshots are incremental. Do not delete any of them.
• See also: https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshots-register-repository.html

Arguments to add when you want to take a backup/snapshot

Run StandaloneElasticBackup.exe with the following two (mandatory) arguments to take a backup/snapshot.

• --repo or -r: The repository in which to take the backup.

  • If none is defined and only one repository is found in the Elasticsearch cluster, then that one will be used.
  • If none is defined and none can be found, then no backup will be taken.

• --snapshotname or -n: The (lowercase) name of the snapshot to be taken. Default: DateTime.Now.ToString("yyyy-MM-dd-HH-mm-ss"); |

Arguments to add when you want to restore a backup/snapshot

Run StandaloneElasticBackup.exe with the following two (mandatory) arguments to restore a backup/snapshot.

• --repo or -r: The repository containing the backup to be restored.

  • If none is defined and only one repository is found in the Elasticsearch cluster, then that one will be used.
  • If none is defined and none can be found, then an error will be thrown.

• --snapshotname or -n: The name of the snapshot to be restored.

Note

• If, before restoring a backup, you notice that all data was deleted from the database, then re-initialize the repository.
• It is advised to disable security when restoring a backup with security enabled. To do so, comment the security setting in the yaml file.