Skip to content

Scripting API / inspection/tests/TestApi / External

External

Classes

InputTestEntity

Properties

Property Type Description
id string | number Entity's unique identifier
name string Entity's name

SPCTestRTFChangedScriptEvent

Extends

Properties

Property Type Overrides
data SPCTestRTFChangedData TestRTFChangedScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

TestRTFChangedScriptEvent.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

TestRTFChangedScriptEvent.stopPropagation

TestFocusOutScriptEvent

Extends

Properties

Property Type Overrides
data TestFocusOutData TestScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

TestScriptEvent.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

TestScriptEvent.stopPropagation

TestOptionSelectedScriptEvent

Extends

Properties

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

TestPaginationRequestedScriptEvent

Extends

Properties

Property Modifier Type Inherited from
data public TestPaginationRequestedData ScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

ScriptEvent.isPropagationStopped

Methods

clearResponse()

clearResponse(): void

Clears any response.

Returns

void

getResponse()

getResponse(): TypedListApiResponse<InputTestEntity> | undefined

Gets the currently set response.

Returns

TypedListApiResponse<InputTestEntity> | undefined

setResponse()

setResponse(response): void

Sets the response for the request.

Parameters
Parameter Type
response TypedListApiResponse<InputTestEntity>
Returns

void

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

TestRTFChangedScriptEvent

Extends

Extended by

Properties

Property Type Overrides
data TestRTFChangedData TestScriptEvent.data

Accessors

isPropagationStopped
Get Signature

get isPropagationStopped(): boolean

Returns

boolean

Inherited from

TestScriptEvent.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

TestScriptEvent.stopPropagation

TestScriptEvent

Extends

Extended by

Properties

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

Interfaces

IInputTestListRequestOptions

Extends

Properties

Property Type Description Inherited from
ids? number[] A list of the ids of specific entities to return. IListRequestOptions.ids
locationIds? number[] Whether to search within specific locations IListRequestOptions.locationIds
order? "asc" | "desc" Whether the entities should be returned in ascending or descending order. IListRequestOptions.order
page? number The page of entities to return. Defaults to the first page if no value is provided. This value is one-based. IListRequestOptions.page
perPage? number The number of entities to return per page. The maximum value is 200. IListRequestOptions.perPage
search? string A search string to filter the returned entities by. IListRequestOptions.search
selectedValueId? string | number The value set by calling updateProperties({value: ...}) on an Input test. -
showHidden? boolean Whether or not hidden entities should be returned. Defaults to false. IListRequestOptions.showHidden

IRatingTestButton

Properties

Property Type
color? string
defectId? number
label string
selectedColor? string

IWorkerDefectListValue

Extends

Properties

Property Type Description Inherited from
count? number The total count of defects for this test. -
traceability? Record<number, string | number | boolean | Date | null | undefined> The traceability for the specific value. The key corresponds to the traceability id, and the value corresponds to the traceability value. Preset values will automatically be matched. IWorkerTestValueWithTrace.traceability

IWorkerSPCValue

Extends

Properties

Property Type Description Inherited from
notApplicable? boolean Whether this value applies or not. When marked not applicable, no value or traceability will be stored. -
traceability? Record<number, string | number | boolean | Date | null | undefined> The traceability for the specific value. The key corresponds to the traceability id, and the value corresponds to the traceability value. Preset values will automatically be matched. IWorkerTestValueWithTrace.traceability
value? number The value of the individual input. -

IWorkerTestValueWithTrace

Extended by

Properties

Property Type Description
traceability? Record<number, string | number | boolean | Date | null | undefined> The traceability for the specific value. The key corresponds to the traceability id, and the value corresponds to the traceability value. Preset values will automatically be matched.

Type Aliases

BaseWorkerTraceability

BaseWorkerTraceability = object

Properties

Property Type
description? string
id number
modifiedDate? Date
required TraceabilityRequiredType

ButtonTestWorkerGet

ButtonTestWorkerGet = object & TestWorkerGet

Type Declaration

Name Type Description
backgroundColor? string | null The background color of the button when it is not hovered. If set to undefined or null, it will use the default button color of the application.
fullWidth boolean Whether or not the button should be full width.
hoverColor? string | null The background color of the button when it is hovered. If set to undefined or null, it will use the default button hover color of the application.
minHeight number The minimum height of the button in pixels.
textColor? string | null The text color of the button. If set to undefined or null, it will use the default button text color of the application.

ButtonTestWorkerUpdate

ButtonTestWorkerUpdate = object & TestWorkerUpdate

Type Declaration

Name Type Description
backgroundColor? string | null Change the background color of the button when it is not hovered. Set to null to revert to the default. This may be set to any valid HTML color.
fullWidth? boolean Change whether or not the button should be full width.
hoverColor? string | null Change the background color of the button when it is hovered. Set to null to revert to the default. This may be set to any valid HTML color.
minHeight? number Change the minimum height of the button in pixels.
textColor? string | null Change the text color of the button. Set to null to revert to the default. This may be set to any valid HTML color.

CharacteristicMatchMethodType

CharacteristicMatchMethodType = "static" | "partAndTag"

ChartTestWorkerGet

ChartTestWorkerGet = object & VisualTestWorkerGet

Type Declaration

Name Type Description
chartType DataEntryChartType The chart type to display in this test.
dataType DataRecordType The data type to display in this test.
linkedTests string[] The list of test script IDs linked to this test.

ChartTestWorkerUpdate

ChartTestWorkerUpdate = object & VisualTestWorkerUpdate

Type Declaration

Name Type Description
chartType? DataEntryChartType Change the chart type to display in this test.
dataType? DataRecordType Change the data type to display in this test.
linkedTests? string[] The list of test script IDs linked to this test. These tests' data types must match the chart test's data type.

DataCanvasItemGet

DataCanvasItemGet = object

Properties

Property Type Description
locations object[] The placement of items in this test. For most tests, this will only contain one item. However, for the SPC test it will contain one item for each subgroup value.
type InspectionTest The type of this test.

DataCanvasItemLocation

DataCanvasItemLocation = object

Properties

Property Type
width? number
x number
y number

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.

DataCanvasTestWorkerGet

DataCanvasTestWorkerGet = object & VisualTestWorkerGet

Type Declaration

Name Type Description
aspectRatio? number 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. If this is undefined, the image's aspect ratio is used.
image SingleFile The image used as the background of the data canvas.
items Record<string, DataCanvasItemGet> The location and size of items on the canvas. The keys of the object are scriptIds, the value contains a list of item locations, and the test type.
snapToGrid boolean Whether to snap the width and location of moved / added tests to a grid.

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.

DataEntryChartType

DataEntryChartType = "control" | "pareto" | "oee" | "spcData" | "dmsData" | "oeeData" | "taskData"

DataTestWorkerGet

DataTestWorkerGet = object & ValueTestWorkerGet

Type Declaration

Name Type Description
alert? GSBaseEntity The real-time alert for this test.
hasDefectOrRTF boolean Whether the test currently has a defect or RTF.
note? string The note to save with this test.
noteType NoteFunctionalityType Determines when a note is required on a test. This will override functionality set on the inspection.
partOverride? GSBaseEntity The part override set on this test.
processOverride? GSBaseEntity The process override set on this test.
rtfReport? RTFList The list of RTFs which are currently on this test.
storeData StoreDataFunctionalityType Whether or not data will be stored for this test.
testSpecificTrace object[] The trace which have been preset for this test.

DataTestWorkerUpdate

DataTestWorkerUpdate = object & ValueTestWorkerUpdate

Type Declaration

Name Type Description
alertId? number | null Change the real-time alert for this test.
note? string | null Change the note to save with this test.
noteType? NoteFunctionalityType Change when a note is required on a test.
partOverrideId? number | null Change the part to use for this test. Expects the ID of the part. null to unset the part override.
processOverrideId? number | null Change the process to use for this test. Expects the ID of the process. null to unset the process override.
storeData? StoreDataFunctionalityType Change whether or not data will be stored for this test.
testSpecificTrace? object[] Change the trace which have been preset for this test. This is expected to be the complete list of traceability specific to this test. Any test specific traceability not included in this list will be removed from this test.

DateTimeTestWorkerGet

DateTimeTestWorkerGet = object & ValueTestWorkerGet

Type Declaration

Name Type Description
defaultToNow boolean Whether the test should have a default value of the current date.
value Date | null The date of the test (or null if it is not set).

DateTimeTestWorkerUpdate

DateTimeTestWorkerUpdate = object & ValueTestWorkerUpdate

Type Declaration

Name Type Description
defaultToNow? boolean Change whether the test should have a default value of the current date.
value? Date | null Change the date of the test.

DefectListTestWorkerGet

DefectListTestWorkerGet = object & DataTestWorkerGet

Type Declaration

Name Type Description
defectSpecificTrace? WorkerTraceability[] The traceability which will apply to each defect.
enableSampleSize boolean Whether the sample size is adjustable by the operator at run time.
ncuBehavior NCUBehaviorType How to handle NCU behavior.
ncuCount? number The current non conforming unit count.
sampleSize? number The sample size of the defect list.
selectedDefectCategory? SingleDefectCategory The defect category selected by the user, or pre-selected during inspection setup. It must contain defects.
value Record<number, IWorkerDefectListValue[]> The value stored for this record. The key is the defect id, the value is the list of defect counts and traceability that apply to each defect. If defectSpecificTrace is not set, the list will only contain one item.

DefectListTestWorkerUpdate

DefectListTestWorkerUpdate = object & DataTestWorkerUpdate

Type Declaration

Name Type Description
defectSpecificTraceIds? number[] Change the traceability which will apply to each defect in the list
enableSampleSize? boolean Change whether the sample size is adjustable by the operator at run time.
ncuBehavior? NCUBehaviorType Change how to handle NCU behavior.
ncuCount? number Change the current non conforming unit count. If ncuBehavior is set to autoSum, this will be overwritten during save. If ncuBehavior is set to input, this maybe overwritten by the user.
sampleSize? number Change the sample size of the defect list.
selectedDefectCategoryId? number | null Change the defect category selected by the user, or pre-selected during inspection setup. It must contain defects. null may be used to unselect a defect category.
value? Record<number, IWorkerDefectListValue[]> Change the value stored for this record. The key is the defect id, the value is the list of defect counts and traceability that apply to each defect. This will only update the values passed in, and only defects that exist in the current defect category are valid.

FileOrientationType

FileOrientationType = "landscape" | "portrait"

FileTestWorkerGet

FileTestWorkerGet = object & VisualTestWorkerGet

Type Declaration

Name Type Description
file? SingleFile The file bound to this test. This contains metadata about the file, but does not contain the actual file contents. The user listed on the file will only contain the name and id. Only set when the type is set to 'file'
openInNewTab boolean Whether to open the file in a new tab or display it inline.
orientation FileOrientationType The orientation to use to layout files. Always set, but only applies to PDFs.
type FileType The type of the file. Determines whether to load an external web page or to embed an uploaded file.
url? string The URL of the embedded page to display. Only set if type is set to 'url'.

FileTestWorkerUpdate

FileTestWorkerUpdate = object & VisualTestWorkerUpdate

Type Declaration

Name Type Description
fileId? number Change the file bound to the test with a numeric ID. If type is set to 'url', setting this property won't result in visible changes.
openInNewTab? boolean Change whether the file opens in a new tab or displays inline. If the test has finished loading, modifying this property will not have any effect until the sub-inspection is loaded again.
orientation? FileOrientationType Change the orientation of a PDF.
type? FileType Change whether to load a web page or load a file from GS.
url? string Change the URL of the url to load. If type is set to 'file', setting this property won't result in visible changes.

FileType

FileType = "file" | "url"

GroupTestMode

GroupTestMode = "static" | "collapse" | "fill" | "collapseAndFill"

GroupTestWorkerGet

GroupTestWorkerGet = VisualTestWorkerGet & object

Type Declaration

Name Type Description
mode GroupTestMode How tests in this group should layout when they do not make up the full width.
tests TestsInInspectionWorkerGet[] The list of tests in the group.

GroupTestWorkerUpdate

GroupTestWorkerUpdate = VisualTestWorkerUpdate & object

Type Declaration

Name Type Description
mode? GroupTestMode How tests should layout in this group when they do not make up the full width. - static: Do not modify the location or size of the tests. - fill: Expand tests to fill space. Tests will be expanded evenly. - collapse: Pack tests together to eliminate as much empty space as possible. Does not modify the width of tests. - collapseAndFill: Pack tests together to eliminate as much space as possible, then expand tests to fill the remaining space.

IdNameEntity

IdNameEntity = object

Properties

Property Type Description
id any -
name string Doc Entity's name

InputTestWorkerGet

InputTestWorkerGet = object & ValueTestWorkerGet

Type Declaration

Name Type Description
multiline boolean Whether or not to display the input area as a multiline text box. If options are set, this property will have no effect.
options? InputTestEntity[] The currently set options. If the options are set, the input will become a select.
useSearchableSelect boolean Whether the list will use a searchable select instead of displaying options normally. If true, this test will fire the onPaginate event, and will expect it to resolve to a ListApiResponse.
value string | number | undefined The entered or selected value of the test. When using .options, the value is the id of the option selected. The value will be undefined if no value is set.

InputTestWorkerUpdate

InputTestWorkerUpdate = object & ValueTestWorkerUpdate

Type Declaration

Name Type Description
multiline? boolean Change whether or not to display the input area as a multiline text box. If options are set, this property will have no effect.
options? InputTestEntity[] | null Change the currently set options. These should take the form of { id: uniqueIdentifier, name: humanReadableName } When the user selects an option, the value of the test will become the id of the option selected. Changing this property will clear the value of the test.
useSearchableSelect? boolean Whether to use a searchable select. It is advised to bind to the onPaginate event to populate the searchable select if this is true. If multiple events are bound to onPaginate, it will use the result of the last one. Changing this property will clear the value of the test.
value? string | number | null Set the value of the test. If options are set, this will attempt to look up the InputTestEntity based on the id.

LabelTestWorkerGet

LabelTestWorkerGet = object & Omit<VisualTestWorkerGet, "label">

Type Declaration

Name Type Description
content string The content of this test.

LabelTestWorkerUpdate

LabelTestWorkerUpdate = object & Omit<VisualTestWorkerUpdate, "label">

Type Declaration

Name Type Description
content? string Change the content of this test. Any valid safe HTML may be used.

NCUBehaviorType

NCUBehaviorType = "autoSum" | "input" | "scriptControlled"

OEEAvailabilityType

OEEAvailabilityType = "available" | "downtimeWithReasons" | "doNotTrack"

OEEQualityType

OEEQualityType = "goodParts" | "badPartsWithDefects" | "doNotTrack"

OEETestWorkerGet

OEETestWorkerGet = object & DataTestWorkerGet

Type Declaration

Name Type Description
availabilityDefectCategory? SingleDefectCategory The defect category to use to track the availability. This property is unused if trackAvailability is not set to downtimeWithReasons.
availabilityPartOverride? GSBaseEntity The part to use when tracking availability. This property will not be used if trackAvailability is not set to downtimeWithReasons.
availabilityProcessOverride? GSBaseEntity The process to use when tracking availability. This property will not be used if trackAvailability is not set to downtimeWithReasons.
availableTime? number The total available time. If trackAvailability is not set to 'availability', this value will not be used.
badParts? Record<number, number> The bad parts which have been recorded. This is presented as an object where the key is the defect and the value is the number of defects.
downtimeReasons? Record<number, number> The downtime reasons which have been recorded. This is presented as an object where the key is the defect and the value is the number of defects.
enableTotalParts boolean Whether or not the operator is allowed to enter total parts.
goodParts? number The good parts produced. If trackQuality is not set to 'goodParts', this value will not be used.
idealCycleTime? number The ideal cycle time.
qualityDefectCategory? SingleDefectCategory The defect category to use to track the quality. This property is unused if trackQuality is not set to badPartsWithDefects.
qualityPartOverride? GSBaseEntity The part to use when tracking quality. This property will not be used if trackQuality is not set to badPartsWithDefects.
qualityProcessOverride? GSBaseEntity The process to use when tracking quality. This property will not be used if trackQuality is not set to badPartsWithDefects.
scheduledTime? number The total scheduled time in minutes.
totalParts? number The total parts, including good parts and bad parts.
trackAvailability OEEAvailabilityType How to track availability. 'available': Have the operator record the available time. 'downtimeWithReasons': Have the operator record the downtime and the reasons for it. 'doNotTrack': Nothing will be tracked for availability.
trackPerformance boolean Whether or not to track performance data.
trackQuality OEEQualityType How to track quality. 'goodParts': Have the operator record the number of good parts. 'badPartsWithDefects': Have the operator record bad parts and the defects. 'noNotTrack': Nothing will be tracked for quality.

OEETestWorkerUpdate

OEETestWorkerUpdate = object & DataTestWorkerUpdate

Type Declaration

Name Type Description
availabilityDefectCategoryId? number | null Change the defect category to use to track the availability. This property is unused if trackAvailability is not set to downtimeWithReasons.
availabilityPartOverrideId? number | null Change the part to use when tracking availability. This property will not be used if trackAvailability is not set to downtimeWithReasons.
availabilityProcessOverrideId? number | null Change the process to use when tracking availability. This property will not be used if trackAvailability is not set to downtimeWithReasons.
availableTime? number | null Change the total available time. If trackAvailability is not set to 'availability', this value will not be used.
badParts? Record<number, number> Change the bad parts which have been recorded. This must be an object where the key is the defect id and the number is the defect count. This property will be ignored if no quality defect category is set. This will throw an error if a defectId is used which is not present in the quality defect category. Only the defects included in badParts will be updated.
downtimeReasons? Record<number, number> Change the downtime reasons which have been recorded. This must be an object where the key is the defect id and the number is the defect count. This property will be ignored if no availability defect category is set. This will throw an error if a defectId is used which is not present in the availability defect category. Only the defects included in downtimeReasons will be updated.
enableTotalParts? boolean Change whether the operator is able to enter total parts.
goodParts? number | null Change the good parts produced. If trackQuality is not set to 'goodParts', this value will not be used.
idealCycleTime? number | null Change the ideal cycle time.
qualityDefectCategoryId? number | null Change the defect category to use to track the quality. This property is unused if trackQuality is not set to badPartsWithDefects.
qualityPartOverrideId? number | null Change the part to use when tracking quality. This property will not be used if trackQuality is not set to badPartsWithDefects.
qualityProcessOverrideId? number | null Change the process to use when tracking quality. This property will not be used if trackQuality is not set to badPartsWithDefects.
scheduledTime? number | null Change the total scheduled time in minutes.
totalParts? number | null Change the total parts, including good parts and bad parts.
trackAvailability? OEEAvailabilityType Change how availability is tracked. 'available': Have the operator record the available time. 'downtimeWithReasons': Have the operator record the downtime and the reasons for it. 'doNotTrack': Nothing will be tracked for availability.
trackPerformance? boolean Change whether or not to track performance data.
trackQuality? OEEQualityType Change how quality is tracked. 'goodParts': Have the operator record the number of good parts. 'badPartsWithDefects': Have the operator record bad parts and the defects. 'noNotTrack': Nothing will be tracked for quality.

PartTestWorkerCreate

PartTestWorkerCreate = PartTestWorkerUpdate & TestWorkerCreate

PartTestWorkerGet

PartTestWorkerGet = object & ValueTestWorkerGet

Type Declaration

Name Type Description
part? GSBaseEntity The part to use for this test.

PartTestWorkerUpdate

PartTestWorkerUpdate = object & ValueTestWorkerUpdate

Type Declaration

Name Type Description
partId? number | null Change the part to use for this test. Expects the ID of the part. Use null to unset the part.

PassFailTestWorkerGet

PassFailTestWorkerGet = object & DataTestWorkerGet

Type Declaration

Name Type Description
defect? SingleDefect The defect to record when this test is marked as 'fail'.
failLabel string The label for the fail button.
naLabel string The label for the N/A button.
ncuOnFailure number How many non-conforming units will be tracked on fail.
onlyShowIfMatchesPart boolean Whether this test should only be displayed if the part in the test's context contains the defect set on this test.
passLabel string The label for the pass button.
sampleSize number The sample size to track with this test.
selectedFailColor string The color of the fail button when it has been selected.
selectedNaColor string The color of the N/A button when it has been selected.
selectedPassColor string The color of the pass button when it has been selected.
showNA boolean Whether or not to show the N/A button.
unselectedFailColor string The color of the fail button when it has not been selected.
unselectedNaColor string The color of the N/A button when it has not been selected.
unselectedPassColor string The color of the pass button when it has not been selected.
value? PassFailType The currently selected option.

PassFailTestWorkerUpdate

PassFailTestWorkerUpdate = object & DataTestWorkerUpdate

Type Declaration

Name Type Description
defectId? number | null Change the defect to record when this test is marked as 'fail'. Expects the ID of the defect. Use null to unset the defect.
failLabel? string Change the label for the fail button.
naLabel? string Change the label for the N/A button.
ncuOnFailure? number Change how many non-conforming units will be tracked on fail.
onlyShowIfMatchesPart? boolean Change whether this test should only be displayed if the part in the test's context contains the defect set on this test.
passLabel? string Change the label for the pass button.
sampleSize? number Change the sample size to track with this test.
selectedFailColor? string Change color of the fail button when it has been selected.
selectedNaColor? string Change color of the N/A button when it has been selected.
selectedPassColor? string Change the color of the pass button when it has been selected.
showNA? boolean Change whether or not to show the N/A button.
unselectedFailColor? string Change the color of the fail button when it has not been selected.
unselectedNaColor? string Change the color of the N/A button when it has not been selected.
unselectedPassColor? string Change The color of the pass button when it has not been selected.
value? PassFailType | null Change the currently selected option.

PassFailType

PassFailType = "pass" | "fail" | "na"

ProcessTestWorkerGet

ProcessTestWorkerGet = object & ValueTestWorkerGet

Type Declaration

Name Type Description
process? GSBaseEntity The process to use for this test.

ProcessTestWorkerUpdate

ProcessTestWorkerUpdate = object & ValueTestWorkerUpdate

Type Declaration

Name Type Description
processId? number | null Change the process to use for this test. Expects the base standard ID of the process. Use null to unset the process.

RatingTestWorkerGet

RatingTestWorkerGet = object & DataTestWorkerGet

Type Declaration

Name Type Description
buttons IRatingTestButton[] The list of buttons to display for the test.
ncuOnFailure number The count of non-conforming units when an option with a defect is selected.
sampleSize number The sample size to use for this test.
value IdNameEntity | undefined The selected option. This will be formatted as: { id: defectId, name: buttonLabel } If no defect was selected, the id will be undefined.

RatingTestWorkerUpdate

RatingTestWorkerUpdate = object & DataTestWorkerUpdate

Type Declaration

Name Type Description
buttons? IRatingTestButton[] Change the list of buttons to display for the test.
ncuOnFailure? number Change the count of non-conforming units when an option with a defect is selected.
sampleSize? number Change the sample size to use for this test.
value? string | null Select a new option. This should be the label of the selected button. An error will be thrown if the value supplied is not in the list of buttons.

SendAlertOptions

SendAlertOptions = object

Options which can be used to customize manually sending Alerts.

Properties

Property Type Description
unsetAlertAfterSending? boolean When true, unsets the alert on the test after it has been sent. When not provided, the alert will not be changed.

SPCTestRTFChangedData

SPCTestRTFChangedData = object & TestEventData

Type Declaration

Name Type Description
rtfReport SPCRTFList The list of Real-Time failures on this test.

SPCTestWorkerGet

SPCTestWorkerGet = object & DataTestWorkerGet

Type Declaration

Name Type Description
autoFocusNext? number When set, will automatically focus the next input or test after have not recevied input for the defined number of milliseconds.
cellLabel? string The label that will be shown for each cell if showCellLabel is true. If not set, the default will be used.
isAnchorPoint? boolean Whether to use this point as an anchor point with submitted data.
matchMethod CharacteristicMatchMethodType The match method that is set on this test.
rtfReport? SPCRTFList The real time failure report for this spc test.
serialDevice? GSBaseEntity The id and name of the Serial Device assigned to this spc test
showCellLabel boolean Whether to display a label for each input cell.
showDescription boolean Whether or not to display the characteristic's description.
showNAToggles boolean Whether to display buttons that allow individual values to be marked "N/A"
spcCharacteristic? GSBaseEntity The id and name of the SPC Characteristic assigned to this spc test.
subgroupSize number The subgroup size for this test. Defaults to 0 if no characteristic has been set and it has not been set via scripting.
subgroupSpecificTrace WorkerTraceability[] The traceability assigned to the specific subgroup elements.
tag? GSBaseEntity The id and name of the tag that is set on this test.
value IWorkerSPCValue[] The list of values for this spc test.

SPCTestWorkerUpdate

SPCTestWorkerUpdate = object & DataTestWorkerUpdate

Type Declaration

Name Type Description
autoFocusNext? number | null When set, will automatically focus the next input or test after have not recevied input for the defined number of milliseconds.
cellLabel? string | null The label that will be shown for each cell if showCellLabel is true. Any instances of {{index}} in the value will be replaced by the subgroup index. Setting this to null will use the default value.
isAnchorPoint? boolean Whether to use this point as an anchor point with submitted data.
matchMethod? CharacteristicMatchMethodType Change the match method that is set on this test.
serialDeviceId? number | null Change the Serial Device of this spc test Use null to unset the Serial Device.
showCellLabel? boolean Whether to display a label for each input cell.
showDescription? boolean Change whether to show the characteristic's description
showNAToggles? boolean Change whether to display buttons that allow individual values to be marked "N/A"
spcCharacteristicId? number | null Change the SPC Characteristic of this spc test. Use null to unset the SPC Characteristic. This will reset any values which have been entered. This cannot be set directly when the matchMethod is set to partAndTag. Use partOverrideId to change the Characteristic instead.
subgroupSize? number | null Change the subgroup size for this test. Setting this to null will reset the subgroup size to the value set on the SPC Characteristic, or 0 if no SPC Characteristic has been set.
subgroupSpecificTraceIds? number[] Change the traceability assigned to this spc test.
tagId? number Change the Tag of this spc test Use null to unset the Tag.
value? IWorkerSPCValue[] Change the values set on this spc test. The values are reset when the sub-inspection is loaded. For this value to have any effect, it must be triggered while the sub-inspection is running. The number of elements in this list must match the subgroup size of the test, either set by scripting or the SPC Characteristic.

StoreDataFunctionalityType

StoreDataFunctionalityType = "storeData" | "doNotStoreData" | "bypassValidityAndDoNotStore"

TaskTestWorkerGet

TaskTestWorkerGet = object & DataTestWorkerGet

Type Declaration

Name Type Description
requireSignOff boolean Whether or not the user must get sign-off from another user.
roleIds number[] The roles which are allowed to sign-off on this task.
showNote boolean Whether or not the note button should be shown for this test.
signedOffBy? GSBaseEntity The user who signed off on the task.
textToStore string The text to store along with the data record.
value boolean Whether or not the checkbox is currently checked.

TaskTestWorkerUpdate

TaskTestWorkerUpdate = object & DataTestWorkerUpdate

Type Declaration

Name Type Description
requireSignOff? boolean Change whether or not the user must get sign-off from another user.
roleIds? number[] Change the roles which are allowed to sign-off on this task.
showNote? boolean Change whether or not the note button should be shown for this test.
textToStore? string Change the text to store along with the data record.
value? boolean Change whether or not the checkbox is currently checked.

TestEventData

TestEventData = object

Properties

Property Type Description
scriptId string The scriptId of the test.
subInspectionId? string The scriptId of the sub-inspection.
testType InspectionTest The type of the test

TestFocusOutData

TestFocusOutData = object & TestEventData

Type Declaration

Name Type
hasChanged boolean

TestInsertMode

TestInsertMode = "insertIntoNewRow" | "appendToExistingRow"

TestOptionSelectedData

TestOptionSelectedData = object & TestEventData

Type Declaration

Name Type Description
newValue any The newly-selected value

TestPaginationRequestedData

TestPaginationRequestedData = object & TestEventData

Type Declaration

Name Type Description
request IInputTestListRequestOptions Description of the requested page, search, order, and other options that should be used to build the ListApiResponse

TestRTFChangedData

TestRTFChangedData = object & TestEventData

Type Declaration

Name Type Description
rtfReport RTFList The list of Real-Time failures on this test.

TestWorkerCreate

TestWorkerCreate = TestWorkerUpdate & object

Type Declaration

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

TestWorkerGet

TestWorkerGet = object

Properties

Property Type Description
borderBottom boolean Whether or not there is a bottom border.
borderLeft boolean Whether or not there is a left border.
borderRight boolean Whether or not there is a right border.
borderTop boolean Whether or not there is a top border.
frozen boolean Frozen tests scroll alongside taller tests they are next to.
label string The text that accompanies the test.
location object Contains the row and column of the test.
location.column number The column a test is in, between 0 and 11.
location.row number The row a test is in.
minWidth number The minimum number of columns a test is allowed to occupy.
userDefinedVisible boolean Determines whether the user has checked the 'visible' box when setting up the UI. It is possible for other factors to cause a test to render or not.
visible boolean Determines whether a test is actually rendered. Tests which are not visible are treated the same as tests which are visible.
width number The number of columns the test occupies. The minimum width for a test is defined by minWidth, and the max width is 12.

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.

TraceabilityTestWorkerGet

TraceabilityTestWorkerGet = object & ValueTestWorkerGet

Type Declaration

Name Type Description
options? string[] | number[] If set, the available options for a user to select from for this traceability.
This can only be set on text or number traceabiilty. When set on text traceability, the options will be strings.
When used on a number field (int, decimal, or currency), the options will be numbers.
required boolean Whether or not the user is forced to enter data. If this has not been overridden via script, it will be the Traceability setting.
restricted WorkerTraceRestrictionType Whether this traceability is restricted to certain options. If the traceability does not have any preset options and this is true, an empty list will be displayed.
trace? WorkerTraceability The traceability to use. This must be set during setup, and cannot be changed at runtime.
value OptionalPrimitiveTraceValue The current traceability value.

TraceabilityTestWorkerUpdate

TraceabilityTestWorkerUpdate = object & Omit<ValueTestWorkerUpdate, "required">

Type Declaration

Name Type Description
options? string[] | number[] | null Change the available options for a user to select from for this traceability.
This may only be used on text or number traceabiilty. When used on text traceability, the provided options must be strings.
When used on a number field (int, decimal, or currency), the provided options must be numbers.
required? boolean | null Change whether or not the user is forced to enter data. Unsetting this using null will fall back to the required setting on the Traceability.
restricted? WorkerTraceRestrictionType Change whether this traceability test is restricted to certain options. If the traceability does not have any preset options and this is true, an empty list will be displayed.
value? OptionalPrimitiveTraceValue Change the current traceability value for the test. If the traceability test is restricted, the value must match one of the preset options.

TypedListApiResponse

TypedListApiResponse<T> = ListApiResponse & object

Type Declaration

Name Type
data T[]

Type Parameters

Type Parameter
T

ValueTestWorkerGet

ValueTestWorkerGet = object & TestWorkerGet

Type Declaration

Name Type Description
enabled boolean Whether the user is allowed to interact with the test in the UI.
required boolean Whether or not the user is forced to enter data.

ValueTestWorkerUpdate

ValueTestWorkerUpdate = object & TestWorkerUpdate

Type Declaration

Name Type Description
enabled? boolean Change whether the user is allowed to interact with the test in the UI.
required? boolean Change whether or not the user is forced to enter data.

VisualTestWorkerGet

VisualTestWorkerGet = TestWorkerGet

VisualTestWorkerUpdate

VisualTestWorkerUpdate = TestWorkerUpdate

WorkerNumberTraceability

WorkerNumberTraceability = BaseWorkerTraceability & object

Type Declaration

Name Type
settings WorkerTraceabilityNumberSettings
type "int" | "decimal" | "currency"

WorkerTextTraceability

WorkerTextTraceability = BaseWorkerTraceability & object

Type Declaration

Name Type
settings WorkerTraceabilityTextSettings
type "text"

WorkerTraceability

WorkerTraceability = BaseWorkerTraceability & WorkerTraceabilityType | WorkerTextTraceability | WorkerNumberTraceability

WorkerTraceability

WorkerTraceability = object

Properties

Property Type
description? string
id number
isValueSpecific boolean
modifiedDate? Date
name string
numberOptions? object
numberOptions.max? number
numberOptions.min? number
numberOptions.options? WorkerTraceabilityOption[]
numberOptions.restricted boolean
required string
textOptions? object
textOptions.options? WorkerTraceabilityOption[]
textOptions.restricted boolean
textOptions.textMatchOperation? string
textOptions.textMatchValue? string
textOptions.tryRegex? string
type string

WorkerTraceabilityNumberSettings

WorkerTraceabilityNumberSettings = object

Properties

Property Type
max? number
min? number
options? number[]
restricted boolean

WorkerTraceabilityOption

WorkerTraceabilityOption = object

Properties

Property Type
hidden? boolean
id number
name string | number

WorkerTraceabilityTextSettings

WorkerTraceabilityTextSettings = object

Properties

Property Type
options? string[]
restricted boolean
textMatchOperation? TraceabilityTextOperationType
textMatchValue? string
tryRegex? string

WorkerTraceabilityType

WorkerTraceabilityType = object

Properties

Property Type
type Exclude<TraceabilityType, "text" | "int" | "decimal" | "currency">

WorkerTraceRestrictionType

WorkerTraceRestrictionType = "restricted" | "notRestricted" | "useTraceabilitySetting"