Add InspectionEventsPlugin (022) - 26A Forms and Fusion API Integration
@btoron ya está trabajando en esto.
Desde el 25/3/2026.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
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
- Lenguaje dominante
- TypeScript
- Estrellas
- 6
- Forks
- 5
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de oracle-samples/ofs-sample-plugins
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
-
Become ColloboratorAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 10/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 70/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Todos los issues de oracle-samples/ofs-sample-plugins
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
vercel-labs/ui#999 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 73/100
melgarafael/DeskcommCRM#5109 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Doist/todoist-sdk-typescript#783 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 64/100
nicobailon/pi-subagents#3319 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
[Bug]: Sidebar project filter uses Shift-click instead of ⌘-click to add or remove a projectAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Los mantenedores suelen responder en 1 día