Merge branch 'main' into logsettingsschema

Author: spetebroodt

develop/devguide/Automation/Howto/Implementing_OnRequestScriptInfo_Entry_Point.md

@@ -0,0 +1,107 @@
+---
+uid: Implementing_OnRequestScriptInfo_Entry_Point
+---
+
+# Implementing the OnRequestScriptInfo entry point
+
+From DataMiner 10.5.7/10.6.0 <!-- RN 42969 --> onwards, the [OnRequestScriptInfo](xref:Skyline.DataMiner.Automation.AutomationEntryPointType.Types.OnRequestScriptInfo) entry point can be implemented in an Automation script. This will allow other Automation scripts (or any other code) to request information about the script in question.
+
+The [example](#orchestration-script-example) below uses the entry point to find out which profile parameter values a script needs in order to orchestrate a device.
+
+## Using the entry point
+
+To use the entry point, add a method with the following signature to the script:
+
+```csharp
+[AutomationEntryPoint(AutomationEntryPointType.Types.OnRequestScriptInfo)]
+public RequestScriptInfoOutput OnRequestScriptInfoRequest(IEngine engine, RequestScriptInfoInput inputData)
+```
+
+Both [RequestScriptInfoInput](xref:Skyline.DataMiner.Net.Automation.RequestScriptInfoInput) and [RequestScriptInfoOutput](xref:Skyline.DataMiner.Net.Automation.RequestScriptInfoOutput) have a `Data` property of type `Dictionary<string, string>`, which can be used to exchange information between the script and other code. We strongly recommend keeping the passed data below 20 MB. If larger chunks need to be passed, a reference to that information should be passed instead.
+
+## Arguments
+
+If the script has any script parameters, dummies or memory files, then these are not required when executing the `OnRequestScriptInfo` entry point. However, they are required when executing the `Run` method of that same script.
+
+If the entry point would make use of them, we recommend providing all defined arguments in the code that is executing the entry point. In case that is not possible, the following should be taken into account when an argument is used in the entry point code:
+
+- When an omitted script parameter is used in the entry point logic, retrieving the script parameter is possible, but its value will be an empty string.
+- When an omitted dummy is used in the entry point logic, retrieving the dummy is possible, but it will refer to DMA ID -1 and element ID -1. Any actions that use the dummy will fail with an exception.
+- When an omitted memory file is used in the entry point logic, retrieving the memory file is possible, but it will refer to a linked file that is empty. Retrieving a value using the memory file will fail with an exception.
+
+## Starting the entry point
+
+To start the `OnRequestScriptInfo` entry point, you can use the below-mentioned methods. Within an Automation script, the entry point should be executed as a [subscript](#subscript).
+
+### Subscript
+
+To execute the `OnRequestScriptInfo` entry point within Automation, you have to use the [PrepareSubScript](xref:Skyline.DataMiner.Automation.Engine.PrepareSubScript(System.String,Skyline.DataMiner.Net.Automation.RequestScriptInfoInput)) method.
+
+In the following snippet, the entry point of the script "Script with entry point" will be started. The "Action" key with value "RequestValues" is used as input data. After the script's entry point has been executed synchronously (i.e. the default behavior), the returned output is checked for the value of the "ActionResult" key.
+
+```csharp
+var input = new RequestScriptInfoInput
+{
+    Data = new Dictionary<string, string>
+    {
+        { "Action", "RequestValues" },
+    },
+};
+
+var subscriptOptions = engine.PrepareSubScript("Script with entry point", input);
+subscriptOptions.StartScript();
+
+if (subscriptOptions.Output?.Data is null ||
+    !subscriptOptions.Output.Data.TryGetValue("ActionResult", out string resultKeyValue))
+{
+    engine.ExitFail("Expected an ActionResult in the output of the subscript.");
+}
+```
+
+The `input` passed when preparing the subscript can be used to sent the data to the script. The data can be updated using the `Input` property of the options. The script should be started synchronously. It will return a subscript options object with an `Output` property containing the information returned by the script.
+
+### ExecuteScriptMessage
+
+The `ExecuteScriptMessage` can be used to trigger the entry point using an SLNet connection. This message should **not** be used to request the information in an Automation script.
+
+In the following snippet, the entry point of the script "Script with entry point" will be started. The "Action" key with value "RequestValues" is used as input data. After the script's entry point has been executed synchronously, the returned output is checked for the value of the "ActionResult" key.
+
+```csharp
+var input = new RequestScriptInfoInput
+{
+    Data = new Dictionary<string, string>
+    {
+        { "Action", "RequestValues" },
+    },
+};
+
+var msg = new ExecuteScriptMessage
+{
+    ScriptName = "Script with entry point",
+    Options = new SA(new[] { "DEFER:FALSE" }),
+    CustomEntryPoint = new AutomationEntryPoint
+    {
+        EntryPointType = AutomationEntryPoint.Types.OnRequestScriptInfo,
+        Parameters = new List<object> { input },
+    },
+};
+
+var response = slnetConnection.HandleSingleResponseMessage(msg) as ExecuteScriptResponseMessage;
+var output = response?.EntryPointResult?.Result as RequestScriptInfoOutput;
+
+if (output?.Data is null ||
+    !output.Data.TryGetValue("ActionResult", out string resultKeyValue))
+{
+    throw new InvalidOperationException("Expected an ActionResult in the output of the subscript.");
+}
+```
+
+When an `ExecuteScriptMessage` is sent, an `ExecuteScriptResponseMessage` will be returned. The information is returned in an `EntryPointResult.Result` property of type `RequestScriptInfoOutput`.
+
+## Orchestration script example
+
+In this example, a library was created to implement Automation scripts that orchestrate a function of a device, resource or element. The `OnRequestScriptInfo` entry point is used to find out which values (defined as profile parameters) such a script needs in order to perform the orchestration.
+
+The [OrchestrationHelperExample repository](https://github.com/SkylineCommunications/SLC-S-OrchestrationHelperExample) is available on GitHub.
+
+A more detailed explanation, as well as the script flow, is available in [the project's README file](https://github.com/SkylineCommunications/SLC-S-OrchestrationHelperExample?tab=readme-ov-file#technical-documentation-for-the-orchestrationhelper-example).

develop/devguide/Automation/UIBlockTypesOverview.md

@@ -209,6 +209,9 @@ foreach (string dropDownOption in dropDownOptions)
 uiBuilder.AppendBlock(blockItem);
 ```
 
+> [!NOTE]
+> It is possible for dropdowns in interactive Automation scripts to become overloaded with data. Although a filter can be used to locate items in a dropdown list, retrieving and displaying all available options could be time-consuming. From DataMiner 10.5.8/10.6.0 onwards<!-- RN 42808 / RN 42845 -->, for Automation scripts launched from web apps where the [`useNewIASInputComponents=true` URL parameter](xref:Configuring_app_actions_and_behavior_via_URL#configuring-app-behavior-via-the-url) is used, you can use [WasOnFilter](xref:Skyline.DataMiner.Automation.UIResults.WasOnFilter(System.String)) to get the filter value that was entered. The options added to the selection box can be filtered by the script. Enable the [WantsOnFilter](xref:Skyline.DataMiner.Automation.UIBlockDefinition.WantsOnFilter) property when defining the selection box.
+
 ## Executable
 
 Allows you to run a program execution. To do this, you must fill in the property *Extra* with the name of the program you want to execute.

develop/schemadoc/Protocol/Protocol.Params.Param.Measurement.Type-options.md

@@ -37,7 +37,7 @@ Allows you to specify a deviation on the command to be verified using Command Ex
 > [!NOTE]
 > Command Execution Verification has to be enabled in MaintenanceSettings.xml.
 
-See also: [annalog](xref:Protocol.Params.Param.Measurement.Type#analog)
+See also: [analog](xref:Protocol.Params.Param.Measurement.Type#analog)
 
 ### Options for measurement type "discreet"
 

develop/schemadoc/Protocol/Protocol.Params.Param.Type-options.md

@@ -233,6 +233,9 @@ Only applicable for parameters of type read.
 
 This option specifies that this parameter holds the path to the private key for setting up SSH communication based on public key authentication. This is an alternative way to set up an SSH connection (instead of user credentials).
 
-The content of the "ssh options" parameter is as follows: ```key=C:\Users\User\.ssh\my_key_rsa;pass=passphrase```
+The content of the "ssh options" parameter is as follows: `key=C:\Users\User\.ssh\my_key_rsa;pass=passphrase`
 
 Only applicable for parameters of type read.
+
+> [!NOTE]
+> When you authenticate with a key through a private/public key pair, you must still specify the user. See also: [Defining an SSH connection in a protocol](xref:ConnectionsSerialSecureShell#defining-an-ssh-connection-in-a-protocol).

develop/schemadoc/Protocol/Protocol.PortSettings.SSH.Identity.md

@@ -9,7 +9,9 @@ Specifies the ID of the parameter that holds the path to the private key used fo
 It should be formatted like this: `key=C:\Users\User\.ssh\my_key_rsa`
 
 > [!NOTE]
-> If the private key is protected by a passphrase, it must be appended to the file path, separated by a semicolon. It should be formatted like this: `key=C:\Users\User\.ssh\my_key_rsa;pass=passphrase`
+>
+> - If the private key is protected by a passphrase, it must be appended to the file path, separated by a semicolon. It should be formatted like this: `key=C:\Users\User\.ssh\my_key_rsa;pass=passphrase`
+> - When you authenticate with a key through a private/public key pair, you must still specify the user. See also: [Defining an SSH connection in a protocol](xref:ConnectionsSerialSecureShell#defining-an-ssh-connection-in-a-protocol).
 
 ## Parent
 

develop/toc.yml

@@ -963,6 +963,8 @@ items:
         topicUid: BP_Implementing_IAS_in_Regression_Tests
       - name: Creating a Cypress test for an interactive Automation script
         topicUid: Creating_a_cypress_test_for_an_interactive_automation_script
+      - name: Implementing the OnRequestScriptInfo entry point
+        topicUid: Implementing_OnRequestScriptInfo_Entry_Point
   - name: Class Library
     items:
     - name: Class library introduction

release-notes/Code_Libraries/Skyline.DataMiner.DataSources.OpenConfig/Skyline.DataMiner.DataSources.OpenConfig.Gnmi_7.x.md

@@ -0,0 +1,11 @@
+---
+uid: Skyline.DataMiner.DataSources.OpenConfig.Gnmi_7.x
+---
+
+# Skyline.DataMiner.DataSources.OpenConfig.Gnmi Range 7.x
+
+## 7.0.0
+
+#### Fix - DataMapper unable to handle responses where type did not match actual value [ID 42762]
+
+In some cases, it could occur that a response was indicated to be of type *Json* or *JsonIetf*, but the actual value was JSON token instead of a JSON object. The DataMapper was unable to handle this, which caused issues. This has now been resolved.

release-notes/Code_Libraries/toc.yml

@@ -9,6 +9,8 @@ items:
       topicUid: Skyline_DataMiner_Core_InterAppCalls_Range_1.0
   - name: Skyline.DataMiner.DataSources.OpenConfig
     items:
+    - name: Skyline.DataMiner.DataSources.OpenConfig.Gnmi Range 7.x
+      topicUid: Skyline.DataMiner.DataSources.OpenConfig.Gnmi_7.x
     - name: Skyline.DataMiner.DataSources.OpenConfig.Gnmi Range 6.x
       topicUid: Skyline.DataMiner.DataSources.OpenConfig.Gnmi_6.x
     - name: Skyline.DataMiner.DataSources.OpenConfig.Gnmi Range 5.x

release-notes/Cube/Cube_Feature_Release_10.5/Cube_10.5.7.md

@@ -2,10 +2,10 @@
 uid: Cube_Feature_Release_10.5.7
 ---
 
-# DataMiner Cube Feature Release 10.5.7 – Preview
+# DataMiner Cube Feature Release 10.5.7
 
-> [!IMPORTANT]
-> We are still working on this release. Some release notes may still be modified or moved to a later release. Check back soon for updates!
+> [!NOTE]
+> For known issues with this version, refer to [Known issues](xref:Known_issues).
 
 > [!TIP]
 >
@@ -14,37 +14,7 @@ uid: Cube_Feature_Release_10.5.7
 
 ## Highlights
 
-- [Cube search box now supports fuzzy matching [ID 42911]](#cube-search-box-now-supports-fuzzy-matching-id-42911)
-- [System Center: New Automation tab in Logging section [ID 42737]](#system-center-new-automation-tab-in-logging-section-id-42737)
-
-## New features
-
-#### System Center: New Automation tab in Logging section [ID 42737]
-
-<!-- MR 10.4.0 [CU16] / 10.5.0 [CU4] - FR 10.5.7 -->
-
-In DataMiner feature version 10.5.6, Automation script log files were introduced. These log files can now be consulted in DataMiner Cube. To do so, in Cube, open *System Center*, and go to *Logging > Automation*.
-
-On the left, you will find a list of all Automation scripts available on the system, grouped per DataMiner Agent.
-
-- Right-clicking a script in the list will open a shortcut menu with two options: *Open* and *Open previous*. If there is no previous log file, the latter option will not be available.
-- To set the log levels for one or more Automation scripts on a particular DataMiner Agent, open the *Log settings* pane at the top of the *Automation* tab, select the files\*, set the log levels, and click *Apply levels*.
-
-\**To select more than one script, click one, and then click another while holding down the Ctrl key, etc. To select a list of consecutive scripts, click the first one in the list and then click the last one while holding down the Shift key.*
-
-> [!NOTE]
-> When you open an Automation script in the *Automation* module, you can access the script's log file by clicking the *View Log* button or by right-clicking inside the script's contents and selecting *View log* from the shortcut menu. Note that this will only be possible if you have permission to view log files.
-
-#### Cube search box now supports fuzzy matching [ID 42911]
-
-<!-- MR 10.4.0 [CU16] / 10.5.0 [CU4] - FR 10.5.7 -->
-
-The search box in the middle of the Cube header bar now supports fuzzy matching.
-
-Search results will now account for diacritic similarities within the same alphabet (e.g. "é" with will match "e"). However, transliteration is not supported. Typos or substitutions with the closest corresponding letters (e.g. "ø" vs. "o" or "graphic" vs. "grafic") will not yield any results.
-
-> [!NOTE]
-> For Japanese characters to be processed properly, your Windows system needs to support Japanese text rendering.
+- [Improved search [ID 42911]](#improved-search-id-42911)
 
 ## Changes
 
@@ -64,6 +34,15 @@ From now on, users will get more feedback when a DataMiner version mismatch is d
 
 - The error message displayed on the screen will now explicitly say that a version mismatch was detected and that an update is required. Also, users will be referred to the [DataMiner Cube deployment methods](xref:DataMiner_Cube_deployment_methods) documentation page for more details.
 
+#### Improved search [ID 42911]
+
+<!-- MR 10.4.0 [CU16] / 10.5.0 [CU4] - FR 10.5.7 -->
+
+An improvement has been implemented to the search engine in DataMiner Cube, so that diacritic similarities within the same alphabet will now be taken into account when text is entered in the search box (e.g. "é" with will match "e"). However, transliteration is not supported. Typos or substitutions with the closest corresponding letters (e.g. "ø" vs. "o" or "graphic" vs. "grafic") will not yield any results.
+
+> [!NOTE]
+> For Japanese characters to be processed properly, your Windows system needs to support Japanese text rendering.
+
 #### DataMiner Cube desktop app: Clicking 'Check for updates' will now always let users download the latest app version of the chosen update track [ID 42939]
 
 <!-- MR 10.4.0 [CU16] / 10.5.0 [CU4] - FR 10.5.7 -->

release-notes/Cube/Cube_Feature_Release_10.5/Cube_10.5.8.md

@@ -24,6 +24,12 @@ uid: Cube_Feature_Release_10.5.8
 
 ### Enhancements
 
+#### Current host of an element or service is now shown in Properties window [ID 42807]
+
+<!-- MR 10.4.0 [CU17] / 10.5.0 [CU5] - FR 10.5.8 -->
+
+When you right-click an element or a service, and select *Properties*, the *General* tab of the *Properties* window will now also display the current host, i.e. the DataMiner Agent that is currently hosting that element or service.
+
 #### Alarm Console: Enhanced performance when processing alarm focus information [ID 42938]
 
 <!-- MR 10.4.0 [CU17] / 10.5.0 [CU5] - FR 10.5.8 -->