Context contributions

The Deviation Processor provides a variety of context contributions of different types for use within your module.

Views

NEXEED_SM_DEVIATION_PROCESSOR_SUSTAINABILITY_CHECK

Description: View showing details of the sustainability check
Parameters:

Parameter Required

Parameter	Required
`tenantId`	X
`id`	X

tenantId

id

NEXEED_SM_DEVIATION_PROCESSOR_DEVIATION_EDIT

Description: View to edit editable fields of a deviation
Parameters:

Parameter Required

Parameter	Required
`tenantId`	X
`id`	X

tenantId

id

NEXEED_SM_DEVIATION_PROCESSOR_QUICK_REACTIONS

Description: View to manage (view, edit, create, delete) quick reactions. Use the parameters to filter for specific quick reactions. If the contribution is called in dummy mode, the quick reactions are filtered by a virtual deviation created with the specified parameter values. If multiple values are specified for a single parameter in dummy mode, the value is set to the first element in the array. The affectedId of this dummy deviation is determined by the affectedGenericType parameter as follows:
- If affectedGenericType is "facility", affectedId is set to the first element in the affectedFacilities array
- If affectedGenericType is "device", affectedId is set to the first element in the affectedDevices array
- If affectedGenericType is "process", affectedId is set to the first element in the affectedProcesses array
- If affectedGenericType is "shift", affectedId is set to the first element in the affectedShifts array
- If affectedGenericType is "product", affectedId is set to the first element in the affectedProducts array
Parameters:

Parameter Required Allowed Values

tenantId

mode

dummy

contributionId

facilityId

affectedFacilities

affectedProcesses

affectedDevices

affectedShifts

affectedProducts

affectedGenericType

codes

firstDetectedAt

detectionCount

detector

lastDetectedAt

module

severity

affectedSpecificDeviceTypes

affectedDomains

NEXEED_SM_DEVIATION_PROCESSOR_DEVIATION_HISTORY_REPORT

Description: This chart displays the count of deviations with a shared composite key (Code, Module, Detector, AffectedId, AffectedGenericType, FacilityId) over time on the primary Y-axis. Optionally, another aggregated metric can be displayed on the secondary Y-axis using the parameter called additional. Select one of the following supported values for additional:
- deviation-duration: Displays the summed duration of the deviations over time.
- impact:<impact-title>: Displays the summed value of impacts associated to the deviations over time. Only impacts with the specified title are considered in the calculation. Replace <impact-title> with the exact title of the impact you wish to aggregate.
Parameters:

Parameter Required

Parameter	Required
`tenantId`	X
`deviation`	X
`start`	X
`end`	X
`additional`

tenantId

deviation

start

end

additional

Dialogs

NEXEED_SM_DEVIATION_PROCESSOR_CREATE_RISK

Description: Dialog to create a risk attached to a deviation
Parameters:

Parameter Required

Parameter	Required
`tenantId`	X
`deviation`	X

tenantId

deviation

NEXEED_SM_DEVIATION_PROCESSOR_MANUAL_REACTION

Description: Dialog to create a manual reaction based on a deviation. If the preferredActionId parameter is given, the specific action is preselected (if it’s available).
Parameters:

Parameter Required

Parameter	Required
`tenantId`	X
`deviation`	X
`preferredActionId`

tenantId

deviation

preferredActionId

NEXEED_SM_DEVIATION_PROCESSOR_CREATE_SUSTAINABILITY_CHECK

Description: Dialog to create a sustainability check with pre-filled properties based on the provided parameters
Parameters:

Parameter Required

Parameter	Required
`tenantId`	X
`facility`
`errorCode`
`sourceReferenceId`
`sourceReferenceType`

tenantId

facility

errorCode

sourceReferenceId

sourceReferenceType

NEXEED_SM_DEVIATION_PROCESSOR_CREATE_DEVIATION

Description: Dialog to create a deviation with some pre-filled properties based on parameters
Parameters:

Parameter Required

Parameter	Required
`tenantId`	X
`deviation`	X

tenantId

deviation

NEXEED_SM_DEVIATION_PROCESSOR_QUICK_REACTION

Description: Dialog to create or update a quick reaction. The quick reaction to update can be specified with the help of the id parameter. For new quick reactions, parameters like module can be used to prefill the dialog. If the contributionId parameter is given, the wizard shown in the dialog will start in step 2 (define actions), which prevents users from editing the conditions of the quick reaction. If the preferredActionId parameter is given, the specific action is preselected (if it’s available) in step 2 (define actions).
Parameters:

Parameter Required

Parameter	Required
`tenantId`	X
`id`
`contributionId`
`facilityId`
`affectedFacilities`
`affectedProcesses`
`affectedDevices`
`affectedShifts`
`affectedProducts`
`affectedGenericType`
`codes`
`firstDetectedAt`
`detectionCount`
`detector`
`lastDetectedAt`
`module`
`severity`
`affectedSpecificDeviceTypes`
`affectedDomains`
`preferredActionId`

tenantId

id

contributionId

facilityId

affectedFacilities

affectedProcesses

affectedDevices

affectedShifts

affectedProducts

affectedGenericType

codes

firstDetectedAt

detectionCount

detector

lastDetectedAt

module

severity

affectedSpecificDeviceTypes

affectedDomains

preferredActionId

Data

NEXEED_DEVIATION_PROCESSOR_DETECTOR_MODULES

Description: Provides a list of detector modules known to the Deviation Processor. This is usually used by other modules to offer filter selections for detector modules in their UI.
Parameters:

Parameter Required

Parameter	Required
`tenantId`	X

tenantId

NEXEED_DEVIATION_PROCESSOR_DYNAMIC_VARIABLES

Description: Provides a list of dynamic variables (placeholders of deviation properties) that can be used in the quick reaction dialog.
Parameters:

Parameter Required

Parameter	Required
`tenantId`	X

tenantId