Scripting API / inspection/subinspections/SubInspectionApi / External

External

Classes

SubInspectionAfterEndScriptEvent

Extends

ScriptEvent

Properties

Property	Modifier	Type	Description	Inherited from
`data`	`public`	`SubInspectionAfterEndEventData`	Data with information about the end of the sub-inspection	`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

ScriptEvent.stopPropagation

SubInspectionAfterStartScriptEvent

Extends

ScriptEvent

Properties

Property	Modifier	Type	Inherited from
`data`	`public`	`SubInspectionEventData`	`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

ScriptEvent.stopPropagation

SubInspectionBeforeEndScriptEvent

Extends

PreventDefaultScriptEvent

Properties

Property	Modifier	Type	Inherited from
`data`	`public`	`SubInspectionEndEventData`	`PreventDefaultScriptEvent`.`data`

Accessors

isDefaultPrevented

Get Signature

get isDefaultPrevented(): boolean

Returns

boolean

Inherited from

PreventDefaultScriptEvent.isDefaultPrevented

isPropagationStopped

Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

PreventDefaultScriptEvent.isPropagationStopped

Methods

preventDefault()

preventDefault(): void

Stop this event from taking the action that it normally would. This does not prevent future event handlers from executing on this event

Returns

void

Inherited from

PreventDefaultScriptEvent.preventDefault

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

PreventDefaultScriptEvent.stopPropagation

SubInspectionDataSubmitScriptEvent

Extends

ScriptEvent

Properties

Property	Modifier	Type	Inherited from
`data`	`public`	`SubInspectionDataSubmitEventData`	`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

ScriptEvent.stopPropagation

Type Aliases

AccountabilityDataPointToInsert

AccountabilityDataPointToInsert = object

Properties

Property	Type	Description
`completedDate?`	`Date`	-
`lateDate`	`Date`	-
`ownerId`	`number`	-
`scheduledDate`	`Date`	-
`scheduleId`	`number`	Doc ID of the schedule related to this record
`startedDate?`	`Date`	-
`status`	`AccountabilityDataRecordStatusType`	-

AvailabilityDataToInsert

AvailabilityDataToInsert = object

Properties

Property	Type	Description
`availableTime`	`number`	Doc Available time, usually in minutes.
`defects?`	`DMSDataValueToInsert`[]	-
`partId?`	`number`	-
`processStandardId?`	`number`	Doc Override the process base standard ID for the availability defect record. If not set, the process standard ID from the test data record is used.
`scheduledTime`	`number`	Doc Scheduled time, usually in minutes.

CopyableTestWorkerCreate

CopyableTestWorkerCreate = TestWorkerCreate & object

Type Declaration

Name	Type	Description
`copyFrom?`	`string`	If set, all properties not explicitly set in this object will be copied from the test with this script ID. Note that the existing test's column and row will not be copied (specify where the test should be created with the `location` property). The existing test with this script ID must be of the same type and in the same sub-inspection (or global tag area) where the new test will be created. If the existing test contains other tests, those tests will be copied and given auto-generated script IDs. Use `getProperties()` on the new test to retrieve these auto-generated IDs.

DataCanvasItemLocationSet

DataCanvasItemLocationSet = object

Properties

Property	Type	Description
`width?`	`number` \| `null`	Change the width of the test as a percentage, relative to the size of the canvas. This cannot be less than 0 or greater than 100. If this percentage would cause the test to drop below its minimum width, the test will be displayed at the minimum width.
`x?`	`number`	Change the x position, as a percentage relative to the size of the canvas. Can not be less than 0 or greater than 100.
`y?`	`number`	Change the y position, as a percentage relative to the size of the canvas. Can not be less than 0 or greater than 100.

DataCanvasTestWorkerCreate

DataCanvasTestWorkerCreate = Omit<DataCanvasTestWorkerUpdate, "items"> & CopyableTestWorkerCreate

DataCanvasTestWorkerUpdate

DataCanvasTestWorkerUpdate = object & VisualTestWorkerUpdate

Type Declaration

Name	Type	Description
`aspectRatio?`	`number` \| `null`	Change the aspect ratio to display the image with. If the aspect ratio is not the same as the background image, the image will stretch to fit. Use null to unset this value.
`imageId?`	`number`	Change the image used as the background of the data canvas.
`items?`	`Record`<`string`, `DataCanvasItemLocationSet` \| `DataCanvasItemLocationSet` & `object`[]>	Change the location and size of items on the canvas. Only tests where the key was provided will be updated. The key of the object corresponds to the scriptId of the test to update. The value of the object is either a single DataCanvasItemLocation or an array of DataCanvasItemLocation objects. If an array is provided, the index property must be included to indicate which index in the array of items to update.
`snapToGrid?`	`boolean`	Change whether to snap the width and location of moved / added tests to a grid.

DefectCostOverride

DefectCostOverride = object

Properties

Property	Type
`cost`	`number`
`defectId`	`number`

DMSDataPointToInsert

DMSDataPointToInsert = object

Properties

Property	Type	Description
`alertId?`	`number`	Doc ID of the alert to send if there were any real-time failures in this data point.
`defectCostOverrides?`	`DefectCostOverride`[]	Doc Specified costs for defects in the `defects` array. This overrides the cost set on the defect entity.
`defects`	`DMSDataValueToInsert`[]	-
`label?`	`string`	Doc Rating label of the data point, usually set by an inspection.
`ncu`	`number`	-
`ncuCostOverride?`	`number`	-
`rtfReport?`	`RTFList`	-
`sampleSize?`	`number`	-

DMSDataValueToInsert

DMSDataValueToInsert = object

Properties

Property	Type	Description
`count?`	`number`	-
`defectId`	`number`	-
`traceability?`	`RequiredTraceRecord`[]	Doc Traceability values.

IndividualRealTimeFailures

IndividualRealTimeFailures = object

Properties

Property	Type
`failures`	`string`[]
`index`	`number`

InspectionLocation

InspectionLocation = object

Properties

Property	Type	Description
`location`	`InspectionLocationType`	The type of location that the object represents.
`subInspectionId?`	`string`	The Id of the sub-inspection, only if the location is 'subInspection'

InspectionLocationType

InspectionLocationType = "subInspectionList" | "inspectionList" | "subInspection"

InspectionTest

InspectionTest = "dateTime" | "trace" | "spc" | "passFail" | "task" | "defectList" | "process" | "button" | "rating" | "oee" | "file" | "label" | "input" | "chart" | "dataCanvas" | "group" | "part"

OEEDataPointToInsert

OEEDataPointToInsert = object

Properties

Property	Type	Description
`alertId?`	`number`	Doc ID of the alert to send if there were any real-time failures in this data point.
`availability?`	`AvailabilityDataToInsert`	-
`defectCostOverrides?`	`DefectCostOverride`[]	-
`performance?`	`PerformanceDataToInsert`	-
`quality?`	`QualityDataToInsert`	-
`rtfReport?`	`RTFList`	-

PerformanceDataToInsert

PerformanceDataToInsert = object

Properties

Property	Type	Description
`availableTime`	`number`	-
`idealCycleTime`	`number`	Doc Ideal time to create a single part, usually in minutes.
`totalParts`	`number`	-

QualityDataToInsert

QualityDataToInsert = object

Properties

Property	Type	Description
`defects?`	`DMSDataValueToInsert`[]	-
`goodParts`	`number`	-
`partId?`	`number`	-
`processStandardId?`	`number`	Doc Override the process base standard ID for the quality defect record. If not set, the process standard ID from the test data record is used.
`totalParts`	`number`	-

RTFList

RTFList = object

Properties

Property	Type	Description
`failures?`	`string`[]	Doc The RTFs for the entire data record

SPCDataPointToInsert

SPCDataPointToInsert = object

Properties

Property	Type	Description
`alertId?`	`number`	Doc ID of the alert to send if there were any real-time failures in this data point.
`anchorPoint`	`boolean`	-
`characteristicStandardId`	`number`	Doc Base standard ID of the characteristic
`lclR?`	`number`	Doc Calculated lower control limit of the range when real-time failures were calculated. This is used to display historical control limits in control charts.
`lclX?`	`number`	Doc Calculated lower control limit of the data point when real-time failures were calculated. This is used to display historical control limits in control charts.
`rtfReport?`	`SPCRTFList`	-
`uclR?`	`number`	Doc Calculated upper control limit of the range when real-time failures were calculated. This is used to display historical control limits in control charts.
`uclX?`	`number`	Doc Calculated upper control limit of the data point when real-time failures were calculated. This is used to display historical control limits in control charts.
`values`	`SPCDataValueToInsert`[]	-

SPCDataValueToInsert

SPCDataValueToInsert = object

Properties

Property	Type	Description
`traceability?`	`RequiredTraceRecord`[]	Doc Traceability values.
`value`	`number` \| `null`	Doc Use null to specify that the value could not be set (e.g. Not Applicable, a measurement device was malfunctioning, etc.)

SPCRTFList

SPCRTFList = RTFList & object

The RTFs for each data point in the subgroup

Type Declaration

Name	Type
`individualRealTimeFailures`	`IndividualRealTimeFailures`[]

SubInspectionAfterEndEventData

SubInspectionAfterEndEventData = SubInspectionEndEventData & object

Type Declaration

Name	Type	Description
`dataSet?`	`SubInspectionDataSet`	The data set which was submitted.
`nextLocation`	`InspectionLocation`	The location that the inspection will navigate to next, unless another navigation event is called.

SubInspectionDataSet

SubInspectionDataSet = object

Properties

Property	Type	Description
`accountabilityId?`	`number`	Doc The ID of the accountability record to be associated with all other data records in the data set.
`addContextualTraceability?`	`boolean`	Doc Flag to add contextual trace. If omitted, contextual Traceability will be included in the request.
`data`	`TestDataRecord`[]	Doc List of test data records
`dateTime`	`Date`	Doc Date and time of the sub-inspection
`devMode?`	`boolean`	Doc Development mode flag
`inspectionId?`	`number`	Doc ID of the inspection
`inspectionName?`	`string`	Doc Name of the inspection
`locationId?`	`number`	Doc ID of the location
`note?`	`string`	Doc A note to apply to every data record in this data set.
`partId?`	`number`	Doc ID of the part
`processStandardId?`	`number`	Doc Base standard ID of the process
`subInspectionName?`	`string`	Doc Name of the sub-inspection
`suppressRTFAlerts?`	`boolean`	Doc Flag to suppress RTF alerts
`traceability`	`RequiredTraceRecord`[]	Doc Traceability values.
`workstationId?`	`number`	Doc ID of the workstation

SubInspectionDataSubmitEventData

SubInspectionDataSubmitEventData = SubInspectionEventData & object

Type Declaration

Name	Type	Description
`dataSet`	`SubInspectionDataSet`	The data set which is about to be submitted. Modifying this data set will change the data to be submitted.

SubInspectionEndActionType

SubInspectionEndActionType = "cancel" | "submit"

SubInspectionEndEventData

SubInspectionEndEventData = SubInspectionEventData & object

Type Declaration

Name	Type	Description
`actionType`	`SubInspectionEndActionType`	The action that triggered the sub-inspection end

SubInspectionEventData

SubInspectionEventData = object

Properties

Property	Type	Description
`subInspectionId`	`string`	The scriptId of the sub-inspection.

SubInspectionWorkerGet

SubInspectionWorkerGet = object

Properties

Property	Type	Description
`cancelLabel`	`string`	The text which will appear in the 'Cancel' button on the sub-inspection.
`index`	`number`	The index of the sub-inspection in the list. The first sub-inspection will have an index of 0.
`name`	`string`	The name of the sub-inspection.
`note?`	`string`	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`	Determines 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.
`submitLabel`	`string`	The text which will appear in the 'Submit' button on the sub-inspection.
`tabBehavior`	`TabBehaviorType`	The behavior for the tab key for the sub-inspection. nextSPC will cause spc tests to tab between each other.
`tests`	`TestsInInspectionWorkerGet`[]	The list of tests in this sub-inspection. This functions as an alias for `getTests()`.
`visibleInList`	`boolean`	Whether or not the sub-inspection will show up in the list.

TaskDataPointToInsert

TaskDataPointToInsert = object

Properties

Property	Type	Description
`guid?`	`string`	Doc Sign-off GUID
`textToStore`	`string`	-

TestDataRecord

TestDataRecord = object

Properties

Property	Type	Description
`charts?`	`string`[]	Doc List of chart images to include in real-time failure alerts
`data`	`OEEDataPointToInsert` \| `DMSDataPointToInsert` \| `SPCDataPointToInsert` \| `TaskDataPointToInsert` \| `AccountabilityDataPointToInsert`	Doc Data point to insert
`note?`	`string`	Doc Note for the test
`partId?`	`number`	Doc ID of the part
`processStandardId?`	`number`	Doc Base standard ID of the process
`recheckRTFs?`	`boolean`	Doc Whether GS should recalculate real-time failures before storing the data point
`testLabel?`	`string`	Doc Label for the test
`traceability`	`RequiredTraceRecord`[]	Doc Traceability values.
`type`	`DataRecordType`	Doc The type of data

TestInsertMode

TestInsertMode = "insertIntoNewRow" | "appendToExistingRow"

TestsInInspectionWorkerGet

TestsInInspectionWorkerGet = object

Properties

Property	Type	Description
`scriptId`	`string`	The id used to select this test in scripts.
`type`	`InspectionTest`	The type of this test.

TestWorkerCreate

TestWorkerCreate = TestWorkerUpdate & object

Type Declaration

Name	Type	Description
`scriptId?`	`string`	The id used to select this test in scripts.

TestWorkerUpdate

TestWorkerUpdate = object

Properties

Property	Type	Description
`borderBottom?`	`boolean`	Change whether or not there is a bottom border.
`borderLeft?`	`boolean`	Change whether or not there is a left border.
`borderRight?`	`boolean`	Change whether or not there is a right border.
`borderTop?`	`boolean`	Change whether or not there is a top border.
`frozen?`	`boolean`	Change whether a test is frozen in place.
`label?`	`string`	Change the text that accompanies the test.
`location?`	`object`	Contains properties to change the location of the test.
`location.column?`	`"default"` \| `number`	Change the column a test is in, between 0 and 11.
`location.insertMode?`	`TestInsertMode`	If set to 'insertIntoNewRow', the test will be inserted in a new row at the given row index. If set to 'appendToExistingRow' the test will be appended to the existing row at the given row index. Defaults to 'insertIntoNewRow'.
`location.row?`	`number`	Change the row a test is in. If not specified, the last row index will be used.
`userDefinedVisible?`	`boolean`	Change whether a test can be seen. Invisible tests are treated the same as visible tests.
`width?`	`number`	Change the number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12.

VisualTestWorkerUpdate

VisualTestWorkerUpdate = TestWorkerUpdate