Add InspectionEventsPlugin (022) - 26A Forms and Fusion API Integration

[miquelgall]

Description

Create a new plugin that demonstrates the OFS 26A functionality introduced in plugin-core v1.6.0. This plugin will showcase form management capabilities, environment-based token retrieval, and Fusion API integration for inspection events.

Base Template

Use ./010-TokenExample as the starting point for this plugin.

Requirements

1. Context Detection (Activity vs Inventory)

The plugin must identify whether it was opened from an activity or a piece of inventory:

From Inventory:

{
  "inventory": {
    "invid": "21259059"
  }
}

From Activity:
The message will contain the activity element with full activity data.

2. Form Workflow

1. Receive openParams containing the label of the form to be opened
2. Open the form using the new 26A methods, passing:
   • activityId (when opened from an activity)
   • inventoryId (when opened from an inventory)
   • formLabel (from openParams)
3. After form submission, retrieve the formsSubmitted list using getSubmittedForms()

3. Token Retrieval for Fusion APIs

If a form has been submitted:

1. Build the scope using the environment getter (new in v1.6.0)
   • Use OFSEnvironment properties: environmentName, fsUrl, faUrl
2. Retrieve token using getAccessTokenByScope() procedure
3. Use the token to invoke Fusion APIs

4. Fusion API Integration - Inspection Events

Step 1: Create Inspection Event

Endpoint: POST /fscmRestApi/resources/latest/inspectionEvents

Payload:

{
  "EventType": "AST",
  "Inline": "N",
  "InspectedBy": "user@example.com",
  "InspectionDate": "2025-10-18T16:48:03.777+00:00",
  "OrganizationCode": "11270",
  "AssetWorkOrderNumber": "OCO-10510",
  "AssetNumber": "OEW-SS001-PR003",
  "QuantityRequested": 1,
  "OperationSequenceNumber": "10",
  "AssetInspectionPlanName": "OMS305A.05Y.A.PR-CD_TEST_V2",
  "WoOperationCode": "OMS305A.05Y.A.PR-CD"
}

Step 2: Get Inspection Event Details

Endpoint: GET /fscmRestApi/resources/latest/inspectionEvents

Retrieves the created event with IpEventId, Sample, SampleDisposition, and SampleResult data including SampleResultId and CharacteristicName.

Step 3: Update Inspection Results

Endpoint: PATCH /fscmRestApi/resources/latest/inspectionEvents/{IpEventId}

Payload: Updates SampleResult entries with ResultValueChar or ResultValueNumber based on form data.

5. Form-to-Characteristic Mapping

Critical Requirement: The name of the property in the OFS form must match the name of the characteristic in Quality Management. This enables automatic mapping between form fields and inspection characteristics.

Example mapping:

Form Property	Quality Characteristic	Result Type
MT 01M MAIN TANK	MT 01M MAIN TANK	ResultValueChar
MT 01M OLTC COUNTER	MT 01M OLTC COUNTER	ResultValueNumber

Architecture Requirements

Separation of Concerns

The Fusion API integration logic must be completely separated from the main plugin logic. This allows:

• Easy adjustment to invoke different APIs
• Reusability across plugins
• Clean testing boundaries

Suggested structure:

assets/js/
├── main.ts           # Entry point
├── custom.ts         # Plugin logic (context detection, form handling)
└── services/
    └── fusionApi.ts  # Fusion API integration (isolated)

The fusionApi.ts module should expose:

• createInspectionEvent(token, payload)
• getInspectionEvent(token, eventId)
• updateInspectionResults(token, eventId, results)

New v1.6.0 Features to Demonstrate

• OFSEnvironment interface (environmentName, fsUrl, faUrl)
• environment getter on OFSPlugin class
• getAccessTokenByScope() procedure
• closeAndOpenForm() method
• getSubmittedForms() procedure
• BackScreen enum usage

Acceptance Criteria

• Plugin correctly identifies activity vs inventory context
• Form opens with correct parameters based on context
• Token retrieval works using environment-based scope
• Inspection event creation, retrieval, and update work correctly
• Form property names map to characteristic names
• Fusion API logic is in a separate, reusable module
• README.md documents all features and configuration
• Tests cover main functionality

Labels

• enhancement
• 26A
• fusion-api