systemlink-cli 1.3.1__py3-none-any.whl

slcli/examples/exercise-7-1-test-plans/README.md

@@ -0,0 +1,93 @@
+# Exercise 7-1: Create and Schedule Test Plans — Instructor Setup Guide
+
+Supporting training data for **Exercise 7-1: Create and Schedule Test Plans**.
+
+## Overview
+
+This example provisions the infrastructure needed for the guided and unguided
+scheduling exercise. Students create a test plan for a battery pack product,
+schedule it on an environmental chamber using the Scheduling Assistant, and
+review work across multiple calendar views.
+
+## Quick Start
+
+```bash
+# Preview what will be created (recommended before running)
+slcli example install exercise-7-1-test-plans -w <workspace> --dry-run
+
+# Install into the target workspace
+slcli example install exercise-7-1-test-plans -w <workspace>
+
+# Remove all provisioned resources when the session ends
+slcli example delete exercise-7-1-test-plans -w <workspace>
+```
+
+## Resources Provisioned
+
+| Type       | Count | Details                                                |
+| ---------- | ----- | ------------------------------------------------------ |
+| Location   | 1     | Battery Testing Lab (Austin, TX)                       |
+| Product    | 1     | Model ABC — Battery Packs family                       |
+| System     | 1     | Chamber B (thermal cycle test stand)                   |
+| Asset      | 1     | Slot_01 — Fixture on Chamber B                         |
+| DUT        | 1     | BAT-DUT-C01                                            |
+| Workflow   | 1     | Battery Test Plan Workflow (full state machine)        |
+| Template   | 1     | Blank Test Plan                                        |
+| Work Order | 1     | Battery Validation – Model ABC                         |
+| Work Item  | 1     | Thermal Cycle Test (pre-created test plan, state: NEW) |
+
+**Total: 9 resources**
+
+## Exercise Alignment
+
+### Guided Steps
+
+| Exercise section                      | Resource used                                     |
+| ------------------------------------- | ------------------------------------------------- |
+| Start from Work Orders                | Work Order: **Battery Validation – Model ABC**    |
+| Create test plan — product family     | Product: **Model ABC** (family: Battery Packs)    |
+| Create test plan — select template    | Template: **Blank Test Plan**                     |
+| Create test plan — select DUT         | DUT: **BAT-DUT-C01**                              |
+| Scheduling Assistant — select system  | System: **Chamber B**                             |
+| Scheduling Assistant — select fixture | Asset/Fixture: **Slot_01**                        |
+| Verify Fixture Allocation             | Fixture column shows **Slot_01** on the work item |
+| Adjust schedule from DUT              | Assets > **BAT-DUT-C01** > Work Items             |
+| View schedule for a specific system   | Systems > **Chamber B** > Schedule tab            |
+
+### Unguided / Assess Your Skills
+
+| Skill step                         | Resource used                                  |
+| ---------------------------------- | ---------------------------------------------- |
+| Create test plan from a work order | Work Order: **Battery Validation – Model ABC** |
+| Create test plan from a DUT        | DUT: **BAT-DUT-C01** > Work Items tab          |
+
+## Instructor Notes
+
+- The **Thermal Cycle Test** work item is pre-created (linked to the work order)
+  so students can practice the Scheduling Assistant steps immediately after
+  completing the Create test plan wizard.
+- **Slot_01** is an `asset` with `assetType: FIXTURE` on Chamber B.
+  It appears in the Scheduling Assistant's fixture picker and in the
+  Fixtures column of the Work Items table.
+- **BAT-DUT-C01** shares the same naming convention as the DUTs
+  in exercise-5-1-parametric-insights (e.g. `BAT-DUT-C01`).
+- All resources share the tag `exercise-7-1-test-plans`, which the cleanup
+  command uses to delete only exercise resources without touching other data.
+
+## Cleanup
+
+```bash
+slcli example delete exercise-7-1-test-plans -w <workspace>
+```
+
+Deletion order (respects dependencies):
+
+1. `work_item`
+2. `work_order`
+3. `testtemplate`
+4. `workflow`
+5. `dut`
+6. `asset` (fixture Slot_01)
+7. `system` (Chamber B)
+8. `product` (Model ABC)
+9. `location` (Battery Testing Lab)

slcli/examples/exercise-7-1-test-plans/config.yaml

@@ -0,0 +1,323 @@
+---
+# SLE Example Configuration: Exercise 7-1 - Create and Schedule Test Plans
+format_version: "1.0"
+name: "exercise-7-1-test-plans"
+title: "Exercise 7-1: Create and Schedule Test Plans"
+description: |
+  Training data for Exercise 7-1: Create and Schedule Test Plans.
+
+  Provisions the infrastructure required to complete the test plan scheduling
+  exercise using the SystemLink Scheduling Assistant. A battery pack product
+  (Model ABC), an environmental chamber system (Chamber B), a fixture slot
+  (Slot_01), and a DUT (BAT-DUT-C01) are created so students can:
+
+  1. Create a test plan (work item) named "Thermal Cycle Test" for Model ABC.
+  2. Use the Scheduling Assistant to assign Chamber B + Slot_01 + BAT-DUT-C01.
+  3. Drag the test plan onto the calendar timeline.
+  4. Review scheduled work across the Operations > Schedule view and
+     the Chamber B system Schedule tab.
+  5. Adjust the schedule from the DUT's Work Items tab.
+
+  A starter work order ("Battery Validation – Model ABC") and a blank test
+  plan work item are also included so the unguided / assess-your-skills steps
+  work without additional setup.
+
+author: "NI"
+created_date: "2026-02-25"
+updated_date: "2026-02-25"
+tags:
+  - "training"
+  - "exercise-7-1"
+  - "test-plans"
+  - "scheduling"
+  - "battery"
+
+estimated_setup_time_minutes: 3
+required_systemlink_version: "2024.1"
+target_workspace: null
+
+resources:
+
+  # ==========================================================================
+  # LOCATION
+  # ==========================================================================
+
+  - type: "location"
+    name: "Battery Testing Lab"
+    properties:
+      description: "Primary facility for battery pack qualification and thermal cycling"
+      address: "1000 Electrochemical Drive"
+      city: "Austin"
+      state: "TX"
+      country: "USA"
+      building: "Test Hall B"
+    id_reference: "loc_batlab"
+    tags: ["exercise-7-1-test-plans"]
+
+  # ==========================================================================
+  # PRODUCT
+  # ==========================================================================
+
+  - type: "product"
+    name: "Model ABC"
+    properties:
+      description: "48 V lithium-ion battery pack for industrial automation"
+      family: "Battery Packs"
+      category: "Energy Storage"
+      manufacturer: "DemoPower Systems"
+      part_number: "BAT-MODEL-ABC-001"
+    id_reference: "prod_abc"
+    tags: ["exercise-7-1-test-plans"]
+
+  # ==========================================================================
+  # TEST SYSTEM
+  # ==========================================================================
+
+  # Students select "Chamber B" in the Scheduling Assistant (step 3 of the
+  # "Schedule the Test Plan" section).
+  - type: "system"
+    name: "Chamber B"
+    properties:
+      description: "Environmental thermal chamber for battery pack cycling tests"
+      location_id: "${loc_batlab}"
+      serial_number: "CHB-SN-20240601-002"
+      status: "operational"
+    id_reference: "sys_chamber_b"
+    tags: ["exercise-7-1-test-plans"]
+
+  # ==========================================================================
+  # FIXTURE
+  # ==========================================================================
+
+  # Students select "Slot_01" as the fixture for Chamber B in the Scheduling
+  # Assistant and verify the Fixtures column shows Slot_01 afterwards
+  # (Verify Fixture Allocation section).
+  - type: "asset"
+    name: "Slot_01"
+    properties:
+      description: "Fixture slot 1 in Chamber B — primary DUT mounting position"
+      system_id: "${sys_chamber_b}"
+      location_id: "${loc_batlab}"
+      model_name: "Fixture Slot"
+      vendor_name: "DemoPower Systems"
+      serial_number: "SLOT-CHB-01"
+      assetType: "FIXTURE"
+    id_reference: "asset_slot01"
+    tags: ["exercise-7-1-test-plans"]
+
+  # ==========================================================================
+  # DUT — BAT-DUT-C01
+  # ==========================================================================
+
+  # Students select this DUT in the Scheduling Assistant (DUT section) and when
+  # browsing Systems Management > Assets > BAT-DUT-C01 > Work Items.
+  - type: "dut"
+    name: "BAT-DUT-C01"
+    properties:
+      description: "Model ABC battery pack under thermal validation in Chamber B"
+      system_id: "${sys_chamber_b}"
+      location_id: "${loc_batlab}"
+      part_number: "BAT-MODEL-ABC-001"
+      model_name: "Model ABC"
+      model_number: "BAT-MODEL-ABC-001"
+      vendor_name: "DemoPower Systems"
+      serial_number: "BAT-SN-C01-20250915"
+      bus_type: "CAN"
+    id_reference: "dut_c01"
+    tags: ["exercise-7-1-test-plans"]
+
+  # ==========================================================================
+  # WORKFLOW  (required by the test template / work item state machine)
+  # ==========================================================================
+
+  - type: "workflow"
+    name: "Battery Test Plan Workflow"
+    properties:
+      description: "Work item state machine for battery pack test plans"
+      actions:
+        - name: "START"
+          displayText: "Start Test"
+          executionAction:
+            type: "MANUAL"
+            action: "START"
+        - name: "END"
+          displayText: "End Test"
+          executionAction:
+            type: "MANUAL"
+            action: "END"
+      states:
+        - name: "NEW"
+          dashboardAvailable: false
+          defaultSubstate: "NEW"
+          substates:
+            - name: "NEW"
+              displayText: "New"
+              availableActions: []
+        - name: "DEFINED"
+          dashboardAvailable: false
+          defaultSubstate: "DEFINED"
+          substates:
+            - name: "DEFINED"
+              displayText: "Defined"
+              availableActions: []
+        - name: "REVIEWED"
+          dashboardAvailable: false
+          defaultSubstate: "REVIEWED"
+          substates:
+            - name: "REVIEWED"
+              displayText: "Reviewed"
+              availableActions: []
+        - name: "SCHEDULED"
+          dashboardAvailable: true
+          defaultSubstate: "SCHEDULED"
+          substates:
+            - name: "SCHEDULED"
+              displayText: "Scheduled"
+              availableActions:
+                - action: "START"
+                  nextState: "IN_PROGRESS"
+                  nextSubstate: "IN_PROGRESS"
+                  showInUI: true
+        - name: "IN_PROGRESS"
+          dashboardAvailable: true
+          defaultSubstate: "IN_PROGRESS"
+          substates:
+            - name: "IN_PROGRESS"
+              displayText: "In Progress"
+              availableActions:
+                - action: "END"
+                  nextState: "PENDING_APPROVAL"
+                  nextSubstate: "PENDING_APPROVAL"
+                  showInUI: true
+        - name: "PENDING_APPROVAL"
+          dashboardAvailable: true
+          defaultSubstate: "PENDING_APPROVAL"
+          substates:
+            - name: "PENDING_APPROVAL"
+              displayText: "Pending Approval"
+              availableActions: []
+        - name: "CLOSED"
+          dashboardAvailable: false
+          defaultSubstate: "CLOSED"
+          substates:
+            - name: "CLOSED"
+              displayText: "Closed"
+              availableActions: []
+        - name: "CANCELED"
+          dashboardAvailable: false
+          defaultSubstate: "CANCELED"
+          substates:
+            - name: "CANCELED"
+              displayText: "Canceled"
+              availableActions: []
+    id_reference: "wf_battery_testplan"
+    tags: ["exercise-7-1-test-plans"]
+
+  # ==========================================================================
+  # TEST TEMPLATE — "Blank Test Plan" base for the exercise
+  # ==========================================================================
+
+  # Students choose "Blank Test Plan" in the Create a Test Plan wizard (step 5
+  # of the Create a Test Plan section). This template is the selectable option.
+  - type: "testtemplate"
+    name: "Blank Test Plan"
+    properties:
+      description: "General-purpose blank test plan template for battery pack work items"
+      template_group: "Battery Packs"
+      type: "testplan"
+      workflow_id: "${wf_battery_testplan}"
+      product_families: ["Battery Packs"]
+      part_numbers: ["BAT-MODEL-ABC-001"]
+    id_reference: "tt_blank_testplan"
+    tags: ["exercise-7-1-test-plans"]
+
+  # ==========================================================================
+  # WORK ORDER — "Battery Validation – Model ABC"
+  # ==========================================================================
+
+  # The starting point for the guided exercise: Operations > Work Orders >
+  # "Battery Validation – Model ABC" > Work Items tab > Create test plan.
+  - type: "work_order"
+    name: "Battery Validation – Model ABC"
+    properties:
+      description: "R&D work order requesting thermal testing on new battery pack design"
+      work_order_type: "validation"
+      status: "new"
+      priority: "high"
+      scheduled_start: "2026-03-01T09:00:00Z"
+      scheduled_end: "2026-03-05T17:00:00Z"
+      reserved_systems:
+        - "${sys_chamber_b}"
+      reserved_assets:
+        - "${dut_c01}"
+    id_reference: "wo_battery_validation"
+    tags: ["exercise-7-1-test-plans"]
+
+  # ==========================================================================
+  # WORK ITEM — starter "Thermal Cycle Test" test plan
+  # ==========================================================================
+
+  # Students create this test plan from the work order's Work Items tab.
+  # After creation they open it in the Scheduling Assistant via the "..." menu.
+  - type: "work_item"
+    name: "Thermal Cycle Test"
+    properties:
+      description: "Temperature cycling sequence for battery pack validation"
+      work_item_type: "testplan"
+      test_template_id: "${tt_blank_testplan}"
+      work_order_id: "${wo_battery_validation}"
+      scheduled_dut: "${dut_c01}"
+      scheduled_system: "${sys_chamber_b}"
+      assigned_operator: ""
+      priority: "high"
+      expected_duration_minutes: 120
+      acceptance_criteria: "All thermal cycle measurements within specification limits"
+    id_reference: "wi_thermal_cycle"
+    tags: ["exercise-7-1-test-plans"]
+
+cleanup:
+  order:
+    - "work_item"
+    - "work_order"
+    - "testtemplate"
+    - "workflow"
+    - "dut"
+    - "asset"
+    - "system"
+    - "product"
+    - "location"
+  filter_tags: ["exercise-7-1-test-plans"]
+  require_confirmation: true
+
+validation:
+  require_workspace: true
+
+post_install:
+  instructions: |
+    ✓ Exercise 7-1 resources installed successfully!
+
+    Resources created:
+    - 1 location:      Battery Testing Lab
+    - 1 product:       Model ABC (Battery Packs)
+    - 1 system:        Chamber B
+    - 1 fixture:       Slot_01 (asset on Chamber B)
+    - 1 DUT:           BAT-DUT-C01
+    - 1 workflow:      Battery Test Plan Workflow
+    - 1 template:      Blank Test Plan
+    - 1 work order:    Battery Validation – Model ABC
+    - 1 work item:     Thermal Cycle Test
+
+    Ready for Exercise 7-1 — guided steps:
+    1. Navigate to Operations > Work Orders and open "Battery Validation – Model ABC".
+    2. In the Work Items tab, select Create test plan, select Blank Test Plan,
+       configure the name as "Thermal Cycle Test" and the DUT as "BAT-DUT-C01".
+    3. In the test plan details, open the "..." menu > Open in scheduling assistant.
+    4. Select "Chamber B" as the system and "Slot_01" as the fixture.
+    5. Select "BAT-DUT-C01" as the DUT.
+    6. Drag the test plan onto tomorrow morning at 9:00 AM and save.
+
+    Unguided / Assess Your Skills:
+    - Navigate to Operations > Work Orders, open "Battery Validation – Model ABC",
+      and create an additional test plan from it.
+    - Navigate to Assets, open "BAT-DUT-C01", and create a test plan
+      from the DUT's Work Items tab.

slcli/examples/spec-compliance-notebooks/README.md

@@ -0,0 +1,140 @@
+# Specification Compliance Analysis Notebooks
+
+Complete set of Jupyter notebooks for performing specification compliance analysis on test data within SystemLink.
+
+## Notebooks Included
+
+### 1. Spec Compliance Calculation
+
+- **Purpose**: Calculate compliance metrics (min, max, mean, median) for parametric specifications
+- **Inputs**: Specification data and measurement results
+- **Outputs**: Compliance report (uploaded to product)
+- **Interface**: File Analysis
+
+### 2. Spec Analysis & Compliance Calculation
+
+- **Purpose**: Combined workflow for specification analysis and compliance calculation
+- **Inputs**: Spec files and measurement data
+- **Outputs**: Detailed compliance analysis
+- **Interface**: File Analysis
+
+### 3. Specfile Extraction and Ingestion
+
+- **Purpose**: Extract specification data and ingest into SystemLink
+- **Inputs**: Excel specification files (see template below)
+- **Outputs**: Structured specification data ingested into SystemLink
+- **Interface**: File Analysis
+
+## Template File
+
+A sample specification template file (`spec_template.xlsx`) is included in this example directory. This file demonstrates the required Excel format for the **Specfile Extraction and Ingestion** notebook.
+
+### Template Structure
+
+The template includes two sheets:
+
+1. **SpecTemplate** (Documentation)
+
+   - Instructions for the spec file format
+   - Column type definitions
+   - Data structure requirements
+   - Condition format examples
+
+2. **Example Part** (Sample Data)
+   - Complete example with 5 sample specifications
+   - Demonstrates all column types (STD, COND, INF)
+   - Shows proper formatting and data types
+
+### Excel Format Requirements
+
+**Column Types:**
+
+- **STD (Standard)**: Core specification fields (Spec ID, Name, Min, Max, etc.)
+- **COND (Condition)**: Conditional specifications (temperature ranges, voltage conditions, etc.)
+- **INF (Information)**: Custom properties and metadata
+
+**File Structure:**
+
+```
+Row 1: Column type designation (STD, COND, or INF)
+Row 2: Category (column B) and Spec Type (column C) - e.g., "parametric" or "functional"
+Row 3: Column headers (mapped to spec fields)
+Row 4+: Specification data
+```
+
+**Standard Columns (STD):**
+
+- Spec ID (required, unique identifier)
+- Name (specification name)
+- Min, Typical, Max (limits for parametric specs)
+- Unit (measurement unit)
+- Category, Block, Symbol (organization fields)
+
+**Condition Format Examples:**
+
+- Discrete values: `[1,2,3]` or `[A,B,C]`
+- Numeric range: `[0..10]` (min to max)
+- Range with discrete: `[1..5,2.5]` (range plus intermediate values)
+
+## Usage
+
+After installation, notebooks are available in your workspace with the File Analysis interface configured.
+
+### Running via CLI
+
+```bash
+# List published notebooks
+slcli notebook list -w <workspace-id>
+
+# Execute a notebook
+slcli notebook execute run -i <notebook-id> -w <workspace-id>
+```
+
+### Running via SystemLink Web Interface
+
+1. Navigate to File Analysis in your workspace
+2. Select a specification compliance notebook
+3. Upload your specification file or measurement data
+4. Run the notebook
+
+## Requirements
+
+- SystemLink Enterprise 2024.1 or later
+- Python 3.9+ with required scientific packages
+- Access to measurement data and specification definitions
+- Excel files (.xlsx) for spec file ingestion
+
+## Key Features
+
+- **Condition Mapping**: Intelligent mapping between specification and measurement conditions
+- **Unit Conversion**: Automatic unit conversion for compatible measurements
+- **Compliance Calculation**: Min/Max/Mean/Median compliance across measurement sets
+- **Report Generation**: Excel report generation with compliance results
+- **Data Validation**: Comprehensive validation of input data formats
+- **Flexible Schema**: Support for parametric and functional specifications
+
+## Rules and Constraints
+
+### Condition Mapping
+
+- Spec and measurement conditions must have compatible units or both be unitless
+- Unit conversion only supported for compatible base units
+- Missing conditions handled gracefully
+
+### Measurement Data
+
+- Measurement data should be stored in base units
+- Non-numeric or empty values are filtered out
+- Unit compatibility checked before inclusion
+
+### Compliance Calculation
+
+- Only valid, unit-compatible measurements included
+- Statistical functions (min, max, mean, median) calculated per specification
+- Results formatted for Excel export
+
+## Notes
+
+- Each notebook includes detailed documentation about its operation
+- Examples and usage patterns are embedded in each notebook
+- Refer to SystemLink documentation for File Analysis interface details

slcli/examples/spec-compliance-notebooks/config.yaml

@@ -0,0 +1,112 @@
+---
+# SLE Example Configuration: Spec Compliance Analysis Notebooks
+format_version: "1.0"
+name: "spec-compliance-notebooks"
+title: "Specification Compliance Analysis Notebooks"
+description: |
+  A complete example providing Jupyter notebooks for performing specification
+  compliance analysis on test data. Includes notebooks for BDC extraction,
+  spec compliance calculation, and compliance analysis workflows.
+
+  Notebooks are published to SystemLink with the File Analysis interface,
+  enabling seamless integration with test data and measurement workflows.
+
+author: "NI"
+created_date: "2025-12-30"
+updated_date: "2025-12-30"
+tags:
+  - "analysis"
+  - "compliance"
+  - "notebooks"
+  - "file-analysis"
+
+estimated_setup_time_minutes: 5
+required_systemlink_version: "2024.1"
+target_workspace: null
+
+resources:
+  # Specification Template File (created first so product can reference it)
+  - type: "file"
+    name: "spec_template.xlsx"
+    properties:
+      file_path: "spec_template.xlsx"
+      description: "Example Excel template for specification ingestion. Upload this file and run the SpecfileExtractionAndIngestion.ipynb notebook to see how specifications are extracted and ingested into SystemLink."
+      tags: ["template", "specification"]
+    id_reference: "file_spec_template"
+    tags: ["example"]
+
+  # Product for Spec Compliance (created after file so it can reference file ID)
+  - type: "product"
+    name: "Spec Compliance Example Product"
+    properties:
+      description: "Example product for specification compliance analysis demonstration"
+      tags: ["example", "spec-compliance"]
+      file_id_references: ["file_spec_template"]
+    id_reference: "prod_spec_example"
+    tags: ["example"]
+
+  # Spec Compliance Calculation Notebook
+  - type: "notebook"
+    name: "Spec Compliance Calculation.ipynb"
+    properties:
+      # File path relative to example directory
+      file_path: "notebooks/SpecComplianceCalculation.ipynb"
+      # Notebook interface for File Analysis
+      notebook_interface: "File Analysis"
+      description: "Calculate compliance and generate reports for parametric specifications"
+      tags: ["spec-compliance", "analysis"]
+    id_reference: "nb_spec_calc"
+    tags: ["example"]
+
+  # Spec Analysis & Compliance Calculation Notebook
+  - type: "notebook"
+    name: "Spec Analysis Compliance Calculation.ipynb"
+    properties:
+      file_path: "notebooks/SpecAnalysis_ComplianceCalculation.ipynb"
+      notebook_interface: "File Analysis"
+      description: "Combined spec analysis and compliance calculation workflow"
+      tags: ["spec-analysis", "compliance"]
+    id_reference: "nb_spec_analysis_calc"
+    tags: ["example"]
+
+  # Specfile Extraction and Ingestion Notebook
+  - type: "notebook"
+    name: "SpecfileExtractionAndIngestion.ipynb"
+    properties:
+      file_path: "notebooks/SpecfileExtractionAndIngestion.ipynb"
+      notebook_interface: "File Analysis"
+      description: "Extract and ingest specification data from specfiles"
+      tags: ["spec-extraction", "data-ingestion"]
+    id_reference: "nb_spec_extraction"
+    tags: ["example"]
+
+cleanup:
+  order: ["notebook", "file", "product"]
+  filter_tags: ["example"]
+  require_confirmation: true
+
+post_install:
+  instructions: |
+    All specification compliance analysis resources have been published to your workspace.
+    
+    Created Resources:
+    - Product: Spec Compliance Example Product (for organizing spec data)
+    - Notebooks:
+      * Spec Compliance Calculation.ipynb: Run compliance calculations on measurement data
+      * Spec Analysis Compliance Calculation.ipynb: Combined analysis and compliance workflow
+      * SpecfileExtractionAndIngestion.ipynb: Extract and ingest specification data
+    - Files:
+      * spec_template.xlsx: Example Excel template for specification ingestion
+    
+    All notebooks are configured with the File Analysis interface and can be run directly
+    from the SystemLink file explorer or invoked programmatically.
+    
+    GETTING STARTED:
+    1. The "spec_template.xlsx" file is a ready-to-use example that demonstrates the
+       Excel format required for spec files.
+    2. Use this template as a reference when preparing your own specification files.
+    3. Upload your spec file to the File service and associate it with the product.
+    4. Run the "SpecfileExtractionAndIngestion.ipynb" notebook to extract and ingest
+       specs into your product.
+    
+    For detailed usage and format documentation, refer to the example README.