Scripting API / inspection/InspectionApi / External
External
Classes
DateTimeChangedScriptEvent
Extends
Properties
| Property | Modifier | Type | Inherited from |
|---|---|---|---|
data |
public |
DateTimeChangedEventData |
ScriptEvent.data |
Accessors
isPropagationStopped
Get Signature
get isPropagationStopped():
boolean
Returns
boolean
Inherited from
ScriptEvent.isPropagationStopped
Methods
stopPropagation()
stopPropagation():
void
Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring
Returns
void
Inherited from
PartChangedScriptEvent
Extends
Properties
| Property | Modifier | Type | Inherited from |
|---|---|---|---|
data |
public |
PartChangedEventData |
ScriptEvent.data |
Accessors
isPropagationStopped
Get Signature
get isPropagationStopped():
boolean
Returns
boolean
Inherited from
ScriptEvent.isPropagationStopped
Methods
stopPropagation()
stopPropagation():
void
Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring
Returns
void
Inherited from
ProcessChangedScriptEvent
Extends
Properties
| Property | Modifier | Type | Inherited from |
|---|---|---|---|
data |
public |
ProcessChangedEventData |
ScriptEvent.data |
Accessors
isPropagationStopped
Get Signature
get isPropagationStopped():
boolean
Returns
boolean
Inherited from
ScriptEvent.isPropagationStopped
Methods
stopPropagation()
stopPropagation():
void
Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring
Returns
void
Inherited from
TraceabilityChangedScriptEvent
Extends
Properties
| Property | Modifier | Type | Inherited from |
|---|---|---|---|
data |
public |
TraceabilityChangedEventData |
ScriptEvent.data |
Accessors
isPropagationStopped
Get Signature
get isPropagationStopped():
boolean
Returns
boolean
Inherited from
ScriptEvent.isPropagationStopped
Methods
stopPropagation()
stopPropagation():
void
Stop this event from continuing to the next event handler. This does not prevent any default behaviors from occurring
Returns
void
Inherited from
Type Aliases
DateTimeChangedEventData
DateTimeChangedEventData =
object
Properties
| Property | Type | Description |
|---|---|---|
newDateTime |
Date | undefined |
The new date/time |
oldDateTime |
Date | undefined |
The old date/time |
InspectionNoteFunctionalityType
InspectionNoteFunctionalityType =
"required"|"requiredOnRTF"|"optional"|"hidden"
InspectionWorkerGet
InspectionWorkerGet =
object
Properties
| Property | Type | Description |
|---|---|---|
accountabilityId? |
number |
The ID of the Accountability Schedule that was used to trigger this Inspection. |
autoLoadFirstSubInspection |
boolean |
Whether to show the list or immediately navigate to the first sub-inspection. All events (afterStart, beforeEnd) will be fired for the sub-inspection. |
completed |
boolean |
Whether this Inspection has been completed. Once an Inspection has been marked as completed, it will not fire the onComplete event again unless manually marked as incomplete with uncompleteInspection(). Marking individual sub-inspections as notStarted will not cause the Inspection to be incomplete. |
forceTagEntryFirst |
boolean |
Whether or not the operator must enter all required fields in the global tag area before proceeding. |
id |
number |
The internal ID of the inspection |
name |
string |
The name of the inspection. |
noteType |
InspectionNoteFunctionalityType |
Determines how notes will be handled for the inspection. This may be overridden on a per-test basis. |
part? |
GSBaseEntity |
The part assigned to the inspection. |
process? |
GSBaseEntity |
The process assigned to the inspection. |
traceability |
object[] |
The global Traceability currently set on this Inspection. |
uiMode |
UIModeType |
Change the layout spacing around each test. |
InspectionWorkerUpdate
InspectionWorkerUpdate =
object
Properties
| Property | Type | Description |
|---|---|---|
accountabilityId? |
number | null |
Change the ID of the Accountability Schedule used to trigger this Inspection. |
autoLoadFirstSubInspection? |
boolean |
Change Whether to show the list or immediately navigate to the first subInspection. Modifying this property will only have an effect if modified during the onReady event. |
forceTagEntryFirst? |
boolean |
Change whether or not the operator must enter all required fields in the global tag area before proceeding. |
noteType? |
InspectionNoteFunctionalityType |
Change how notes will be handled for the inspection. |
partId? |
number | null |
Change the part assigned to the inspection. |
processId? |
number | null |
Change the process assigned to the inspection. Expects the base standard ID of the process. |
traceability? |
object[] |
Update global Traceability currently set on this Inspection. This does not change the value of any Traceability tests. Only Traceability values which are provided will be modified. |
uiMode? |
UIModeType |
Change the layout spacing around each test. |
NoteFunctionalityType
NoteFunctionalityType =
"useInspectionSetting"|"required"|"requiredOnRTF"|"optional"|"hidden"
OptionalPrimitiveTraceValue
OptionalPrimitiveTraceValue =
OptionalTraceRecord["value"]
OptionalTraceRecord
OptionalTraceRecord =
OptionalTraceValue&object
Type Declaration
| Name | Type | Description |
|---|---|---|
id |
number |
Doc Internal ID of the traceability |
OptionalTraceValue
OptionalTraceValue =
object
Properties
| Property | Type |
|---|---|
value? |
number | number | string | boolean | Date | null |
PartChangedEventData
PartChangedEventData =
object
Properties
| Property | Type | Description |
|---|---|---|
newPartId |
number | undefined |
The new process id. |
oldPartId |
number | undefined |
The old process id. |
ProcessChangedEventData
ProcessChangedEventData =
object
Properties
| Property | Type | Description |
|---|---|---|
newProcessId |
number | undefined |
The new process id. |
oldProcessId |
number | undefined |
The old process id. |
SubInspectionStatusType
SubInspectionStatusType =
"complete"|"notStarted"
SubInspectionWorkerCreate
SubInspectionWorkerCreate =
object&SubInspectionWorkerUpdate
Type Declaration
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the sub-inspection. |
scriptId? |
string |
Unique id of the sub-inspection. |
SubInspectionWorkerUpdate
SubInspectionWorkerUpdate =
object
Properties
| Property | Type | Description |
|---|---|---|
cancelLabel? |
string | null |
The text which will appear in the 'Cancel' button on the sub-inspection. Setting this to null will revert it to the default value. This property will do nothing if showCancelButton is false. |
name? |
string |
Update the name of the sub-inspection. |
note? |
string | null |
Change the sub-inspection note. If set, this note will be appended to all of the test notes in the sub-inspection when it is submitted. |
noteType? |
NoteFunctionalityType |
Change when a note is required on the sub-inspection. |
showCancelButton? |
boolean |
Whether the cancel button will appear on the sub-inspection. |
showSubmitButton? |
boolean |
Whether the submit button will appear on the sub-inspection. |
status? |
SubInspectionStatusType |
Update the status of the sub-inspection. Setting this property on the currently running sub-inspection will have no effect. Setting completed sub-inspections to inProgress may cause the Inspection to never be considered complete, which will prevent the inspetion onComplete event from firing, and will not mark pany associated Inspection Schedule as completed. |
submitLabel? |
string | null |
The text which will appear in the 'Submit' button on the sub-inspection. Setting this to null will revert it to the default value. This property will do nothing if showSubmitButton is false. |
tabBehavior? |
TabBehaviorType |
Change the tab behavior of the sub-inspection. nextSPC will cause spc tests to tab between each other. |
visibleInList? |
boolean |
Whether the sub-inspection will show up in the list. |
TabBehaviorType
TabBehaviorType =
"default"|"nextSPC"
TraceabilityChangedEventData
TraceabilityChangedEventData =
object
Properties
| Property | Type | Description |
|---|---|---|
newValue |
OptionalPrimitiveTraceValue | undefined |
The new traceability value |
oldValue |
OptionalPrimitiveTraceValue | undefined |
The old traceability value |
traceabilityId |
number |
The changed traceability's ID |
UIModeType
UIModeType =
"default"|"compact"