systemlink-cli 1.11.0__tar.gz → 1.11.1__tar.gz

{systemlink_cli-1.11.0 → systemlink_cli-1.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: systemlink-cli
-Version: 1.11.0
+Version: 1.11.1
 Summary: SystemLink Integrator CLI - cross-platform CLI for SystemLink workflows and templates.
 License-File: LICENSE
 Author: Fred Visser

{systemlink_cli-1.11.0 → systemlink_cli-1.11.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "systemlink-cli"
-version = "1.11.0"
+version = "1.11.1"
 description = "SystemLink Integrator CLI - cross-platform CLI for SystemLink workflows and templates."
 authors = ["Fred Visser <fred.visser@emerson.com>"]
 packages = [{ include = "slcli" }]

{systemlink_cli-1.11.0 → systemlink_cli-1.11.1}/slcli/_version.py

@@ -1,4 +1,4 @@
 """Version information for slcli."""
 
 # This file is auto-generated. Do not edit manually.
-__version__ = "1.11.0"
+__version__ = "1.11.1"

{systemlink_cli-1.11.0 → systemlink_cli-1.11.1}/slcli/skills/systemlink-notebook/SKILL.md

@@ -71,7 +71,8 @@ in the cell's `.metadata` field for SystemLink to recognize the parameters and o
 
 - `papermill.parameters` keys **must** match the variable names in the code cell
 - `systemlink.parameters[].id` **must** match the variable names in the code cell
-- `systemlink.outputs[].id` **must** match the key used in the result dict passed to `sb.glue`
+- `systemlink.outputs[].id` **must** match the `id` field in each output object in the
+  `result` list passed to `sb.glue('result', result)`
 - `tags: ["parameters"]` is **required** — this is how papermill identifies the cell
 - `systemlink.version` must be `2` for most notebooks, or `1` for **Work Item Automations**
 - Supported parameter types: `string`, `integer`, `float`, `boolean`, `string[]`
@@ -140,6 +141,21 @@ result = [{
 sb.glue('result', result)
 ```
 
+### Output validation guardrails
+
+- Ensure `result` is a list of output objects, not a dict.
+- Ensure each output object has: `display_name`, `id`, `type`, and `data`.
+- Ensure `type` is one of the supported output types and matches metadata.
+- Ensure output `id` exactly matches `systemlink.outputs[].id`.
+- For `data_frame`, ensure `data.columns` and `data.values` are present and aligned.
+
+For Systems Grid notebooks, validate that:
+
+- The first column is exactly `minion id`.
+- The first value in each row is the system ID string.
+- For single-column grid reports, use exactly two columns: `minion id` and the report value column.
+- If the notebook is intended to populate one grid column, avoid extra columns unless explicitly required.
+
 ### Systems Grid reports
 
 When the notebook is used as a Systems Grid column, the `data_frame` output
@@ -152,6 +168,26 @@ df_dict = {
 }
 ```
 
+Common Systems Grid pattern for one metric per system:
+
+```python
+metric_by_system = {item['id']: item['metric_value'] for item in data.data}
+df = pd.DataFrame.from_dict(metric_by_system, orient='index', columns=['metric'])
+
+df_dict = {
+  'columns': ['minion id', 'metric'],
+  'values': df.reset_index().values.tolist()
+}
+
+result = [{
+  'display_name': 'Metric',
+  'id': 'metric_output',
+  'type': 'data_frame',
+  'data': df_dict
+}]
+sb.glue('result', result)
+```
+
 ## Common Imports
 
 ```python
@@ -172,7 +208,6 @@ from nisystemlink.clients.assetmanagement import AssetManagementClient
 
 # Direct HTTP (when no typed client exists)
 import requests
-from nisystemlink.clients.core import HttpConfigurationManager
 config = HttpConfigurationManager.get_configuration()
 base_url = config.server_uri.rstrip("/")
 headers = {"x-ni-api-key": config.api_keys[0]}
@@ -191,7 +226,6 @@ headers = {"x-ni-api-key": config.api_keys[0]}
 
 When using direct HTTP, prefer the OpenAPI docs first to confirm the service base
 path, request body shape, and response schema before writing notebook code.
-
 ## Systems Query Pattern
 
 The `SystemsApi` uses a projection/filter pattern for querying:
@@ -210,6 +244,22 @@ query_result = api.get_systems_by_query(query=query)
 data = await query_result
 ```
 
+### Async and response handling guardrails
+
+- In notebook cells, prefer top-level `await` over `asyncio.run(...)`.
+- Do not call `asyncio.run(...)` inside notebook execution cells; kernels may already have an active event loop.
+- `get_systems_by_query` can return typed response objects (for example `QuerySystemsResponse`). Prefer `data.data` (or `getattr(data, 'data', ...)`) over assuming a plain dict/list.
+
+Safe extraction pattern:
+
+```python
+query_result = api.get_systems_by_query(query=query)
+data = await query_result
+systems = getattr(data, 'data', None)
+if systems is None:
+    systems = data.get('data', data) if isinstance(data, dict) else data
+```
+
 ### Common filter expressions
 
 | Filter | Description |
@@ -318,6 +368,29 @@ the server rejects the update.
 reading the `Workspace` field from the active profile. Do not assume "Default" or
 prompt the user unless `slcli info` shows no workspace configured.
 
+## Execution Validation Checklist
+
+After create/update, always validate with a fresh (non-cached) execution before concluding success:
+
+```bash
+slcli notebook execute sync -n <NOTEBOOK_ID> -w "<WORKSPACE_NAME>" --no-cache -f json
+```
+
+Validation steps:
+
+1. Confirm `status` is `SUCCEEDED` and `errorCode` is `NO_ERROR`.
+2. Confirm output `id` and `type` match parameters-cell metadata.
+3. Confirm `data.columns` and `data.values` shape matches the target interface.
+4. If output still looks old, check `cachedResult`; rerun with `--no-cache`.
+
+## Known Failure Modes and Fixes
+
+- `ValueError: No kernel name found in notebook`: restore notebook-level `metadata.kernelspec`.
+- Notebook output not shown in SystemLink UI: restore parameters-cell `systemlink` metadata and `tags: ["parameters"]`.
+- Systems Grid format mismatch: ensure first column is `minion id` and output is a valid `data_frame` payload.
+- Runtime loop errors (`asyncio.run() cannot be called from a running event loop`): replace `asyncio.run(...)` with top-level `await`.
+- Result appears unchanged after update: rerun with `--no-cache` and re-check returned execution JSON.
+
 ## Example
 
 See [notebook-patterns.md](./references/notebook-patterns.md) for a complete

{systemlink_cli-1.11.0 → systemlink_cli-1.11.1}/slcli/skills/systemlink-notebook/references/notebook-patterns.md

@@ -22,6 +22,7 @@ Import Python modules for executing the notebook.
 
 **Cell 2 — Imports (code)**
 ```python
+import re
 import pandas as pd
 import scrapbook as sb
 
@@ -99,8 +100,32 @@ The cell metadata must include:
 ```python
 api = SystemsApi()
 
-projection = f'new(id, packages.data["{package}"].displayversion, packages.data["{package}"].version)'
-filter = (systems_filter or "!string.IsNullOrEmpty(id)") + f' && packages.data.keys.Contains("{package}")'
+def _escape_filter_value(value: str) -> str:
+    """Escape backslashes first, then quotes, for safe quoted filter literals."""
+    return value.replace("\\", "\\\\").replace('"', '\\"')
+
+def _validate_package_name(value: str) -> str:
+    normalized = value.strip()
+    if not re.fullmatch(r"[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?", normalized):
+        raise ValueError("package must only contain letters, numbers, dot, dash, or underscore")
+    return normalized
+
+def _validate_filter_fragment(value: str) -> str:
+    normalized = value.strip()
+    if not normalized:
+        return "!string.IsNullOrEmpty(id)"
+    if not re.fullmatch(r'[A-Za-z0-9_ ."\-()\[\],:&|=!<>]*', normalized):
+        raise ValueError("systems_filter contains unsupported characters")
+    return normalized
+
+safe_package = _escape_filter_value(_validate_package_name(package))
+base_filter = _validate_filter_fragment(systems_filter)
+
+projection = (
+    f'new(id, packages.data["{safe_package}"].displayversion, '
+    f'packages.data["{safe_package}"].version)'
+)
+filter = base_filter + f' && packages.data.keys.Contains("{safe_package}")'
 
 query_sys_request = QuerySystemsRequest(skip=0, projection=projection, filter=filter)
 query_result = api.get_systems_by_query(query=query_sys_request)