Add InspectionEventsPlugin (022) - 26A Forms and Fusion API Integration
@btoron ci sta già lavorando.
Dal 25/3/2026.
Valutazione
Questa issue non è ancora stata valutata.
Descrizione
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
- Receive
openParamscontaining the label of the form to be opened - Open the form using the new 26A methods, passing:
activityId(when opened from an activity)inventoryId(when opened from an inventory)formLabel(from openParams)
- After form submission, retrieve the
formsSubmittedlist usinggetSubmittedForms()
3. Token Retrieval for Fusion APIs
If a form has been submitted:
- Build the scope using the
environmentgetter (new in v1.6.0)- Use
OFSEnvironmentproperties:environmentName,fsUrl,faUrl
- Use
- Retrieve token using
getAccessTokenByScope()procedure - 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": "[email protected]",
"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
-
OFSEnvironmentinterface (environmentName,fsUrl,faUrl) -
environmentgetter on OFSPlugin class -
getAccessTokenByScope()procedure -
closeAndOpenForm()method -
getSubmittedForms()procedure -
BackScreenenum 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
- Lingua principale
- TypeScript
- Stelle
- 6
- Fork
- 5
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di oracle-samples/ofs-sample-plugins
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
-
Become ColloboratorAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 10/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 70/100
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
Tutte le issue di oracle-samples/ofs-sample-plugins
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
vercel-labs/ui#999 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 73/100
melgarafael/DeskcommCRM#5109 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Doist/todoist-sdk-typescript#783 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
nicobailon/pi-subagents#3319 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
I maintainer di solito rispondono entro 1 giorno