Add InspectionEventsPlugin (022) - 26A Forms and Fusion API Integration
@btoron đang làm issue này rồi.
Từ ngày 25/3/2026.
Đánh giá
Issue này chưa được đánh giá.
Mô tả
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
- Ngôn ngữ chính
- TypeScript
- Star
- 6
- Fork
- 5
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của oracle-samples/ofs-sample-plugins
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
-
Become ColloboratorĐang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 10/100
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 70/100
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 35/100
Tất cả issue của oracle-samples/ofs-sample-plugins
Issue tương tự
-
dream report: normalizeMutation discards ok/status, consumers can only string-match the summaryĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 66/100
thecodacus/understory#61 ·
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Termix-SSH/Plugin-Hosts-Config#14 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 4 ngày
-
ai-generated priority: p2 size: s type: bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
JonathanTSilva/jts-website#92 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
vercel-labs/ui#999 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
ehmpathy/rhachet-roles-ehmpathy#1443 ·
Maintainer thường phản hồi trong vòng 1 ngày