Class PinpointServiceClient

Namespace: Acuit.Pinpoint.Services.Client

Assembly: Acuit.Pinpoint.Services.Client.dll

A client for the Acuit Pinpoint TCP SOAP core service.

public class PinpointServiceClient : PinpointClientBase<IPinpointService, PinpointServiceClientOptions>, IPinpointServiceClient, IPinpointService, IPinpointClient, IDisposable

Inheritance: object

PinpointClientBase<IPinpointService, PinpointServiceClientOptions>

PinpointServiceClient

Implements: IPinpointServiceClient

IPinpointService

IPinpointClient

IDisposable

Inherited Members: PinpointClientBase<IPinpointService, PinpointServiceClientOptions>.CreateNetTcpBinding(PinpointClientOptions)

Constructors

PinpointServiceClient(PinpointServiceClientOptions)

Initializes a new instance of the PinpointServiceClient class.

public PinpointServiceClient(PinpointServiceClientOptions options)

Parameters

options PinpointServiceClientOptions: The client connection options.

Remarks

The client will be configured according to options, as well as:

TCP for message delivery.
Binary message encoding.
100MB buffer and message size limits.

Service methods invoked by the client will automatically specify an international locale based on the current thread's CurrentUICulture value.

Exceptions

ArgumentNullException: options is null.
InvalidOperationException: The options are invalid.

Methods

AddDatabase(string, bool)

Adds a database to Acuit Pinpoint, optionally creating it.

public void AddDatabase(string name, bool createNew)

Parameters

name string: The name of the database.
createNew bool: If false, assumes the database already exists. If true, attempts to create a new database.

Exceptions

FaultException<TDetail>: name is null.
FaultException<TDetail>: An error while attempting to add the database.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AddDatabaseAsync(string, bool)

Adds a database to Acuit Pinpoint, optionally creating it.

public Task AddDatabaseAsync(string name, bool createNew)

Parameters

name string: The name of the database.
createNew bool: If false, assumes the database already exists. If true, attempts to create a new database.

Returns

Task: The task object representing the asynchronous operation.

Exceptions

FaultException<TDetail>: name is null.
FaultException<TDetail>: An error while attempting to add the database.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AddDefect3(string, int, string, string?)

Adds a defect for a unit.

public AddDefectStatus AddDefect3(string lineName, int unitStationId, string fullDefectName, string? notes)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
fullDefectName string: The full defect name, with the path parts delimited by backslashes.
notes string: Optional additional notes about the defect. This can be null or empty.

Returns

AddDefectStatus: An AddDefectStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: fullDefectName is null.
FaultException<TDetail>: A communication error occurred. A communication timeout error occurred. fullDefectName does not contain any name parts or one or more name parts are empty.
FaultException<TDetail>: A business logic error occurred.

AddDefect3Async(string, int, string, string?)

Adds a defect for a unit.

public Task<AddDefectStatus> AddDefect3Async(string lineName, int unitStationId, string fullDefectName, string? notes)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
fullDefectName string: The full defect name, with the path parts delimited by backslashes.
notes string: Optional additional notes about the defect. This can be null or empty.

Returns

Task<AddDefectStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains an AddDefectStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: fullDefectName is null.
FaultException<TDetail>: fullDefectName does not contain any name parts or one or more name parts are empty.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AddRepair(string, int, int, string, string?)

Adds a repair to a defect for a unit.

public AddRepairStatus AddRepair(string lineName, int unitStationId, int unitDefectId, string fullRepairName, string? notes)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
unitDefectId int: The unit defect identifier for the defect that is being repaired.
fullRepairName string: The full repair name, with the path parts delimited by backslashes.
notes string: Optional additional notes about the repair. This can be null or empty.

Returns

AddRepairStatus: An AddRepairStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: fullRepairName is null.
FaultException<TDetail>: fullRepairName does not contain any name parts or one or more name parts are empty.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AddRepairAsync(string, int, int, string, string?)

Adds a repair to a defect for a unit.

public Task<AddRepairStatus> AddRepairAsync(string lineName, int unitStationId, int unitDefectId, string fullRepairName, string? notes)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
unitDefectId int: The unit defect identifier for the defect that is being repaired.
fullRepairName string: The full repair name, with the path parts delimited by backslashes.
notes string: Optional additional notes about the repair. This can be null or empty.

Returns

Task<AddRepairStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains an AddRepairStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: fullRepairName is null.
FaultException<TDetail>: fullRepairName does not contain any name parts or one or more name parts are empty.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AddTestResult(string, int, string, bool, string?, string?, IDictionary<string, string?>?)

Adds a test result for a unit.

public AddTestResultStatus AddTestResult(string lineName, int unitStationId, string testName, bool passed, string? reason, string? notes, IDictionary<string, string?>? extendedData)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
testName string: The name of the test.
passed bool: Whether the test passed.
reason string: The reason for a failed test. This can be null if the test passed.
notes string: Optional additional notes about the test. This can be null or empty.
extendedData IDictionary<string, string>: Optional extended data associated with the test result. This should be null when not used. This data is for use by plug-ins. Note that Acuit Pinpoint will not save this data with the unit record; plug-ins must handle saving and retrieving this data if needed.

Returns

AddTestResultStatus: An AddTestResultStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: testName is null.
FaultException<TDetail>: testName does not refer to a configured test name.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AddTestResult2(string, int, string, bool, string?, string?, string?)

Adds a test result for a unit.

public AddTestResultStatus AddTestResult2(string lineName, int unitStationId, string testName, bool passed, string? reason, string? notes, string? dataXml)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
testName string: The name of the test.
passed bool: Whether the test passed.
reason string: The reason for a failed test. This can be null if the test passed.
notes string: Optional additional notes about the test. This can be null or empty.
dataXml string: Test-specific data, formatted as XML. This can be null. The XML should be structured according to the remarks for ParseXmlTestData(string?) so that Acuit Pinpoint can interpret and nicely display the data.

Returns

AddTestResultStatus: An AddTestResultStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: testName is null.
FaultException<TDetail>: testName does not refer to a configured test name.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AddTestResult2Async(string, int, string, bool, string?, string?, string?)

Adds a test result for a unit.

public Task<AddTestResultStatus> AddTestResult2Async(string lineName, int unitStationId, string testName, bool passed, string? reason, string? notes, string? dataXml)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
testName string: The name of the test.
passed bool: Whether the test passed.
reason string: The reason for a failed test. This can be null if the test passed.
notes string: Optional additional notes about the test. This can be null or empty.
dataXml string: Test-specific data, formatted as XML. This can be null. The XML should be structured according to the remarks for ParseXmlTestData(string?) so that Acuit Pinpoint can interpret and nicely display the data.

Returns

Task<AddTestResultStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains an AddTestResultStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: testName is null.
FaultException<TDetail>: testName does not refer to a configured test name.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AddTestResultAsync(string, int, string, bool, string?, string?, IDictionary<string, string?>?)

Adds a test result for a unit.

public Task<AddTestResultStatus> AddTestResultAsync(string lineName, int unitStationId, string testName, bool passed, string? reason, string? notes, IDictionary<string, string?>? extendedData)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
testName string: The name of the test.
passed bool: Whether the test passed.
reason string: The reason for a failed test. This can be null if the test passed.
notes string: Optional additional notes about the test. This can be null or empty.
extendedData IDictionary<string, string>: Optional extended data associated with the test result. This should be null when not used. This data is for use by plug-ins. Note that Acuit Pinpoint will not save this data with the unit record; plug-ins must handle saving and retrieving this data if needed.

Returns

Task<AddTestResultStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains an AddTestResultStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: testName is null.
FaultException<TDetail>: testName does not refer to a configured test name.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AuthenticateWorker(string, string?, string?)

Authenticates a worker.

public AuthenticateWorkerStatusOld AuthenticateWorker(string lineName, string? badgeNumber, string? password)

Parameters

lineName string: The name of the line with which to work.
badgeNumber string: The worker's badge number, or null to validate using password only.
password string: The worker's password, or null to validate using badgeNumber only.

Returns

AuthenticateWorkerStatusOld: An AuthenticateWorkerStatusOld object representing the status.

Remarks

Either badgeNumber or password can be null or empty to only validate using the other parameter, but both cannot be null or empty.

This must be used instead of AuthenticateWorker2(string, string?, string?) with Acuit Pinpoint versions earlier than 6.200.0.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: Neither badgeNumber nor password were specified.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AuthenticateWorker2(string, string?, string?)

Authenticates a worker.

public AuthenticateWorkerStatus AuthenticateWorker2(string lineName, string? badgeNumber, string? password)

Parameters

lineName string: The name of the line with which to work.
badgeNumber string: The worker's badge number, or null to validate using password only.
password string: The worker's password, or null to validate using badgeNumber only.

Returns

AuthenticateWorkerStatus: An AuthenticateWorkerStatus object representing the status.

Remarks

Either badgeNumber or password can be null or empty to only validate using the other parameter, but both cannot be null or empty.

This is supported by Acuit Pinpoint versions 6.200.0 and later; for earlier versions, use AuthenticateWorker(string, string?, string?).

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: Neither badgeNumber nor password were specified.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AuthenticateWorker2Async(string, string?, string?)

Authenticates a worker.

public Task<AuthenticateWorkerStatus> AuthenticateWorker2Async(string lineName, string? badgeNumber, string? password)

Parameters

lineName string: The name of the line with which to work.
badgeNumber string: The worker's badge number, or null to validate using password only.
password string: The worker's password, or null to validate using badgeNumber only.

Returns

Task<AuthenticateWorkerStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains an AuthenticateWorkerStatus object representing the status.

Either badgeNumber or password can be null or empty to only validate using the other parameter, but both cannot be null or empty.

This is supported by Acuit Pinpoint versions 6.200.0 and later; for earlier versions, use AuthenticateWorkerAsync(string, string?, string?).

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: Neither badgeNumber nor password were specified.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

AuthenticateWorkerAsync(string, string?, string?)

Authenticates a worker.

public Task<AuthenticateWorkerStatusOld> AuthenticateWorkerAsync(string lineName, string? badgeNumber, string? password)

Parameters

lineName string: The name of the line with which to work.
badgeNumber string: The worker's badge number, or null to validate using password only.
password string: The worker's password, or null to validate using badgeNumber only.

Returns

Task<AuthenticateWorkerStatusOld>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains an AuthenticateWorkerStatusOld object representing the status.

Either badgeNumber or password can be null or empty to only validate using the other parameter, but both cannot be null or empty.

This must be used instead of AuthenticateWorker2Async(string, string?, string?) with Acuit Pinpoint versions earlier than 6.200.0.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: Neither badgeNumber nor password were specified.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

ChangeUnitNumbers(string, int, string?, string?, string?)

Changes a unit's serial and/or model numbers.

public ChangeUnitNumbersResult ChangeUnitNumbers(string lineName, int unitStationId, string? newSerialNumber, string? newModelNumber, string? newModelNumberAlias)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
newSerialNumber string: The new serial number for the unit, or null or empty to leave it unchanged.
newModelNumber string: The new model number for the unit, or null or empty to leave it unchanged.
newModelNumberAlias string: The new model number alias for the unit, or null or empty to leave it unchanged.

Returns

ChangeUnitNumbersResult: A ChangeUnitNumbersResult with the result.

Remarks

This method changes the unit's serial number, model number, and/or model number alias and then reapplies the unit checks logic according to the current line configuration, recording changes to the unit record as necessary. For example, all installed components will be verified against the updated unit, and any that result in a different verification outcome will cause a new component scan to be recorded.

Any installed components that become invalid due to the change will be rescanned as "invalid", even if the line component verification "IsInvalidAllowed" setting specifies that invalid components should not be allowed. This will never throw a FaultException<TDetail> for reason ComponentScanFailed.

Any installed components that applied to the original unit when they were scanned but that no longer apply to the unit after the change will be left unchanged. This includes components for component types that are no longer configured in the line configuration.

This was added in Acuit Pinpoint version 8.0.0-preview.65.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: newSerialNumber contains one or more invalid characters.
FaultException<TDetail>: newModelNumber contains one or more invalid characters.
FaultException<TDetail>: newModelNumberAlias contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

ChangeUnitNumbersAsync(string, int, string?, string?, string?)

Changes a unit's serial and/or model numbers.

public Task<ChangeUnitNumbersResult> ChangeUnitNumbersAsync(string lineName, int unitStationId, string? newSerialNumber, string? newModelNumber, string? newModelNumberAlias)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
newSerialNumber string: The new serial number for the unit, or null or empty to leave it unchanged.
newModelNumber string: The new model number for the unit, or null or empty to leave it unchanged.
newModelNumberAlias string: The new model number alias for the unit, or null or empty to leave it unchanged.

Returns

Task<ChangeUnitNumbersResult>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a ChangeUnitNumbersResult with the result.

This was added in Acuit Pinpoint version 8.0.0-preview.65.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: newSerialNumber contains one or more invalid characters.
FaultException<TDetail>: newModelNumber contains one or more invalid characters.
FaultException<TDetail>: newModelNumberAlias contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

ClearBuyoff2(string, int, string)

Clears a buyoff for a unit.

public BuyoffStatus ClearBuyoff2(string lineName, int unitStationId, string buyoffName)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
buyoffName string: The buyoff name.

Returns

BuyoffStatus: A BuyoffStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: buyoffName is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

ClearBuyoff2Async(string, int, string)

Clears a buyoff for a unit.

public Task<BuyoffStatus> ClearBuyoff2Async(string lineName, int unitStationId, string buyoffName)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
buyoffName string: The buyoff name.

Returns

Task<BuyoffStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a BuyoffStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: buyoffName is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

ComponentScanTest(string, string, string, string, string?, string?)

Performs a test component scan verification, returning the results with logic details but without actually recording a component scan for a unit.

public ComponentScanTestStatus ComponentScanTest(string lineName, string unitSerialNumber, string unitModelNumber, string componentTypeName, string? componentSerialNumber, string? componentModelNumber)

Parameters

lineName string: The name of the line with which to work.
unitSerialNumber string: The serial number of the unit.
unitModelNumber string: The model number of the unit.
componentTypeName string: The component type name.
componentSerialNumber string: The component serial number to verify. This can be null or empty if no serial number was scanned for the component.
componentModelNumber string: The component model number to verify. This can be null or empty if no model number was scanned for the component. See remarks for "checkInstalledOnly" components.

Returns

ComponentScanTestStatus: A ComponentScanTestStatus object representing the results.

Remarks

For component types marked "checkInstalledOnly", componentModelNumber indicates whether the component is installed or not. Any non-null, non-empty value means that the component is installed; a null or empty value means that the component is not installed.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: unitSerialNumber is null.
FaultException<TDetail>: unitSerialNumber contains one or more invalid characters.
FaultException<TDetail>: unitModelNumber is null.
FaultException<TDetail>: unitModelNumber contains one or more invalid characters.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentSerialNumber contains one or more invalid characters.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

ComponentScanTestAsync(string, string, string, string, string?, string?)

Performs a test component scan verification, returning the results with logic details but without actually recording a component scan for a unit.

public Task<ComponentScanTestStatus> ComponentScanTestAsync(string lineName, string unitSerialNumber, string unitModelNumber, string componentTypeName, string? componentSerialNumber, string? componentModelNumber)

Parameters

lineName string: The name of the line with which to work.
unitSerialNumber string: The serial number of the unit.
unitModelNumber string: The model number of the unit.
componentTypeName string: The component type name.
componentSerialNumber string: The component serial number to verify. This can be null or empty if no serial number was scanned for the component.
componentModelNumber string: The component model number to verify. This can be null or empty if no model number was scanned for the component. See remarks for "checkInstalledOnly" components.

Returns

Task<ComponentScanTestStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a ComponentScanTestStatus object representing the results.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: unitSerialNumber is null.
FaultException<TDetail>: unitSerialNumber contains one or more invalid characters.
FaultException<TDetail>: unitModelNumber is null.
FaultException<TDetail>: unitModelNumber contains one or more invalid characters.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentSerialNumber contains one or more invalid characters.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

ComponentScanned3(string, int, string, string?, string?)

Indicates that a unit component was scanned at a station, and checks whether the component is acceptable.

public ComponentStatus ComponentScanned3(string lineName, int unitStationId, string componentTypeName, string? componentSerialNumber, string? componentModelNumber)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
componentTypeName string: The component type name.
componentSerialNumber string: The component serial number to verify. This can be null or empty if no serial number was scanned for the component.
componentModelNumber string: The component model number to verify. This can be null or empty if no model number was scanned for the component. See remarks for "checkInstalledOnly" components.

Returns

ComponentStatus: A ComponentStatus object representing the results.

Remarks

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentSerialNumber contains one or more invalid characters.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

ComponentScanned3Async(string, int, string, string?, string?)

Indicates that a unit component was scanned at a station, and checks whether the component is acceptable.

public Task<ComponentStatus> ComponentScanned3Async(string lineName, int unitStationId, string componentTypeName, string? componentSerialNumber, string? componentModelNumber)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
componentTypeName string: The component type name.
componentSerialNumber string: The component serial number to verify. This can be null or empty if no serial number was scanned for the component.
componentModelNumber string: The component model number to verify. This can be null or empty if no model number was scanned for the component. See remarks for "checkInstalledOnly" components.

Returns

Task<ComponentStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a ComponentStatus object representing the results.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentSerialNumber contains one or more invalid characters.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

CreateLine(Line)

Creates a new line.

public Line CreateLine(Line line)

Parameters

line Line: The line to create. LineId should be 0, Name should be a new unique name, and DatabaseId and/or Name in Database should specify the database.

Returns

Line: The newly-created line.

Exceptions

FaultException<TDetail>: line is null.
FaultException<TDetail>: Database in line is null.
FaultException<TDetail>: DatabaseId and/or Name in Database in line does not specify one database.
FaultException<TDetail>: Name in line is null or empty.
FaultException<TDetail>: LineId in line is not 0.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

CreateLineAsync(Line)

Creates a new line.

public Task<Line> CreateLineAsync(Line line)

Parameters

line Line: The line to create. LineId should be 0, Name should be a new unique name, and DatabaseId and/or Name in Database should specify the database.

Returns

Task<Line>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the newly-created line.

Exceptions

FaultException<TDetail>: line is null.
FaultException<TDetail>: Database in line is null.
FaultException<TDetail>: DatabaseId and/or Name in Database in line does not specify one database.
FaultException<TDetail>: Name in line is null or empty.
FaultException<TDetail>: LineId in line is not 0.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

CreateUnitRecord(string, string?, string, string, string?)

Creates a blank unit record.

public void CreateUnitRecord(string lineName, string? scheduleName, string serialNumber, string modelNumber, string? modelNumberAlias)

Parameters

lineName string: The name of the line with which to work.
scheduleName string: The production schedule name. If this is null or empty, the unit will not be assigned to a production schedule; otherwise, the schedule will be created if it doesn't already exist.
serialNumber string: The unit serial number.
modelNumber string: The unit model number.
modelNumberAlias string: The unit model number alias. If this is null or empty, the ModelAliases table will be used to look up the model alias, and if a matching entry is not found, modelNumber will be used.

Remarks

If modelNumberAlias is specified, then the ModelAliases table will be updated to include the mapping from modelNumber to modelNumberAlias.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: serialNumber is not a valid number.
FaultException<TDetail>: modelNumber is null.
FaultException<TDetail>: modelNumber is not a valid number.
FaultException<TDetail>: A unit record already exists for the specified serial number (Reason will be UnitSerialNumberAlreadyUsed).
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

CreateUnitRecordAsync(string, string?, string, string, string?)

Creates a blank unit record.

public Task CreateUnitRecordAsync(string lineName, string? scheduleName, string serialNumber, string modelNumber, string? modelNumberAlias)

Parameters

lineName string: The name of the line with which to work.
scheduleName string: The production schedule name. If this is null or empty, the unit will not be assigned to a production schedule; otherwise, the schedule will be created if it doesn't already exist.
serialNumber string: The unit serial number.
modelNumber string: The unit model number.
modelNumberAlias string: The unit model number alias. If this is null or empty, the ModelAliases table will be used to look up the model alias, and if a matching entry is not found, modelNumber will be used.

Returns

Task: The task object representing the asynchronous operation.

Remarks

If modelNumberAlias is specified, then the ModelAliases table will be updated to include the mapping from modelNumber to modelNumberAlias.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: serialNumber is not a valid number.
FaultException<TDetail>: modelNumber is null.
FaultException<TDetail>: modelNumber is not a valid number.
FaultException<TDetail>: A unit record already exists for the specified serial number (Reason will be UnitSerialNumberAlreadyUsed).
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

DeleteLine(Line)

Deletes a line.

public void DeleteLine(Line line)

Parameters

line Line: The line to delete. DatabaseId and/or Name in Database indicates the database, and LineId indicates the line.

Exceptions

FaultException<TDetail>: line is null.
FaultException<TDetail>: Database in line is null.
FaultException<TDetail>: DatabaseId and/or Name in Database in line does not specify one database.
FaultException<TDetail>: LineId in line does not correspond to an existing line.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

DeleteLineAsync(Line)

Deletes a line.

public Task DeleteLineAsync(Line line)

Parameters

line Line: The line to delete. DatabaseId and/or Name in Database indicates the database, and LineId indicates the line.

Returns

Task: The task object representing the asynchronous operation.

Exceptions

FaultException<TDetail>: line is null.
FaultException<TDetail>: Database in line is null.
FaultException<TDetail>: DatabaseId and/or Name in Database in line does not specify one database.
FaultException<TDetail>: LineId in line does not correspond to an existing line.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

DeleteUnit(string, string)

Deletes a unit.

public void DeleteUnit(string lineName, string serialNumber)

Parameters

lineName string: The name of the line with which to work.
serialNumber string: The unit serial number.

Remarks

All history for the unit will be deleted. Note that when multiple lines exist within one database, it is possible for a single unit to have activity that spans multiple lines. For such units, all history will be deleted, even scans that occurred on other lines (within the same database).

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: serialNumber does not refer to an existing unit.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

DeleteUnitAsync(string, string)

Deletes a unit.

public Task DeleteUnitAsync(string lineName, string serialNumber)

Parameters

lineName string: The name of the line with which to work.
serialNumber string: The unit serial number.

Returns

Task: The task object representing the asynchronous operation.

Remarks

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: serialNumber does not refer to an existing unit.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetActiveSettingsXml(string)

Gets the active configuration for a line.

public string GetActiveSettingsXml(string lineName)

Parameters

lineName string: The name of the line with which to work.

Returns

string: The settings XML.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetActiveSettingsXmlAsync(string)

Gets the active configuration for a line.

public Task<string> GetActiveSettingsXmlAsync(string lineName)

Parameters

lineName string: The name of the line with which to work.

Returns

Task<string>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the settings XML.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetBasicUnitInformation(string, string)

Gets the basic information for a unit.

public Unit GetBasicUnitInformation(string lineName, string serialNumber)

Parameters

lineName string: The name of a line that is within the database from which to retrieve the unit.
serialNumber string: The unit serial number.

Returns

Unit: A Unit object.

Remarks

The returned Unit will only have these properties initialized:

UnitId
SerialNumber
ModelNumber
ModelNumberAlias
IsPreassembly
ProductionSchedule (with all of its properties initialized)

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: serialNumber does not refer to an existing unit.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetBasicUnitInformationAsync(string, string)

Gets the basic information for a unit.

public Task<Unit> GetBasicUnitInformationAsync(string lineName, string serialNumber)

Parameters

lineName string: The name of a line that is within the database from which to retrieve the unit.
serialNumber string: The unit serial number.

Returns

Task<Unit>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a Unit object.

The returned Unit will only have these properties initialized:

UnitId
SerialNumber
ModelNumber
ModelNumberAlias
IsPreassembly
ProductionSchedule (with all of its properties initialized)

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: serialNumber does not refer to an existing unit.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetComponentPartsList(string, string)

Gets the parts list configured for a component type.

public IList<Part> GetComponentPartsList(string lineName, string componentTypeName)

Parameters

lineName string: The name of the line with which to work.
componentTypeName string: The component type name.

Returns

IList<Part>: The list of parts.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentTypeName does not refer to a component type configured for the line.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetComponentPartsListAsync(string, string)

Gets the parts list configured for a component type.

public Task<IList<Part>> GetComponentPartsListAsync(string lineName, string componentTypeName)

Parameters

lineName string: The name of the line with which to work.
componentTypeName string: The component type name.

Returns

Task<IList<Part>>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the list of parts.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentTypeName does not refer to a component type configured for the line.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetConnectionString(string)

Gets the database connection string for a line.

public string GetConnectionString(string lineName)

Parameters

lineName string: The line name.

Returns

string: The database connection string.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetConnectionStringAsync(string)

Gets the database connection string for a line.

public Task<string> GetConnectionStringAsync(string lineName)

Parameters

lineName string: The line name.

Returns

Task<string>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the database connection string.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetCurrentShiftProductionCounts2(string)

Gets the current shift production counts for a line.

public ProductionCounts GetCurrentShiftProductionCounts2(string lineName)

Parameters

lineName string: The name of the line with which to work.

Returns

ProductionCounts: A ProductionCounts object.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetCurrentShiftProductionCounts2Async(string)

Gets the current shift production counts for a line.

public Task<ProductionCounts> GetCurrentShiftProductionCounts2Async(string lineName)

Parameters

lineName string: The name of the line with which to work.

Returns

Task<ProductionCounts>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a ProductionCounts object.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetDatabaseConfigurationXml(int)

Gets the configuration settings for a database.

public string GetDatabaseConfigurationXml(int databaseId)

Parameters

databaseId int: The identifier of the database.

Returns

string: The database configuration settings, as XML.

Exceptions

FaultException<TDetail>: databaseId is not a valid database identifier.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetDatabaseConfigurationXmlAsync(int)

Gets the configuration settings for a database.

public Task<string> GetDatabaseConfigurationXmlAsync(int databaseId)

Parameters

databaseId int: The identifier of the database.

Returns

Task<string>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the database configuration settings, as XML.

Exceptions

FaultException<TDetail>: databaseId is not a valid database identifier.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetDatabases()

Gets the list of databases configured for Acuit Pinpoint.

public IList<Database> GetDatabases()

Returns

IList<Database>: A list of Database objects representing the databases.

Remarks

This is similar to the GetLines2() method, except that it returns a list of databases, each with its list of lines; also, this method works even when there are multiple lines with the same name, while GetLines2() will throw an exception.

Exceptions

CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetDatabasesAsync()

Gets the list of databases configured for Acuit Pinpoint.

public Task<IList<Database>> GetDatabasesAsync()

Returns

Task<IList<Database>>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a list of Database objects representing the databases.

Exceptions

CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetLatestHealthReport()

Gets the latest Acuit Pinpoint health report, as a JSON object.

public string GetLatestHealthReport()

Returns

string: The latest Acuit Pinpoint health report, as a JSON object.

Remarks

The returned JSON object will be structured like this:

{
  "Entries": {
    "Database/lines manager": {
      "Status": 2,
      "Duration": "00:00:00.0008277"
    },
    "HighJump Integration Feeder": {
      "Status": 2,
      "Duration": "00:00:00.0085598"
    }
  },
  "Status": 2,
  "TotalDuration": "00:00:00.0106906"
}

Exceptions

CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetLatestHealthReportAsync()

Gets the latest Acuit Pinpoint health report, as a JSON object.

public Task<string> GetLatestHealthReportAsync()

Returns

Task<string>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the latest Acuit Pinpoint health report, as a JSON object.

The returned JSON object will be structured like this:

{
  "Entries": {
    "Database/lines manager": {
      "Status": 2,
      "Duration": "00:00:00.0008277"
    },
    "HighJump Integration Feeder": {
      "Status": 2,
      "Duration": "00:00:00.0085598"
    }
  },
  "Status": 2,
  "TotalDuration": "00:00:00.0106906"
}

Exceptions

CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetLineStatus(string)

Gets the current status for a line.

public LineStatus GetLineStatus(string lineName)

Parameters

lineName string: The name of the line with which to work.

Returns

LineStatus: A LineStatus object.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetLineStatusAsync(string)

Gets the current status for a line.

public Task<LineStatus> GetLineStatusAsync(string lineName)

Parameters

lineName string: The name of the line with which to work.

Returns

Task<LineStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a LineStatus object.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetLines2()

Gets the list of all available lines configured for Acuit Pinpoint.

public IList<Line> GetLines2()

Returns

IList<Line>: A list of Line objects representing the lines.

Remarks

Any problems with any databases (e.g., a database connection error or a database schema version mismatch) are ignored; lines are gathered from all databases that can succesfully be read.

This is similar to the GetDatabases() method, except that it returns a list of lines, each with a reference to its database; also, this method will thrown an exception if there are multiple lines with the same name, while GetDatabases() will not.

Exceptions

FaultException<TDetail>: The same line name occurs in multiple databases.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetLines2Async()

Gets the list of all available lines configured for Acuit Pinpoint.

public Task<IList<Line>> GetLines2Async()

Returns

Task<IList<Line>>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a list of Line objects representing the lines.

Any problems with any databases (e.g., a database connection error or a database schema version mismatch) are ignored; lines are gathered from all databases that can succesfully be read.

Exceptions

FaultException<TDetail>: The same line name occurs in multiple databases.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetNextComponentSerialNumber(string, string)

Gets the next automatically-generated component serial number.

public string GetNextComponentSerialNumber(string lineName, string componentTypeName)

Parameters

lineName string: The name of the line with which to work.
componentTypeName string: The component type name.

Returns

string: The next automatically-generated serial number.

Remarks

The returned serial number will be for a unit record that does not yet exist.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentTypeName does not refer to a component type configured for the line.
FaultException<TDetail>: There is no available automatically-generated serial number, either because automatically-generated serial numbers are not configured, or because all available serial numbers have been exhausted. The business logic fault reason will be SerialNumberUnavailable.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetNextComponentSerialNumberAsync(string, string)

Gets the next automatically-generated component serial number.

public Task<string> GetNextComponentSerialNumberAsync(string lineName, string componentTypeName)

Parameters

lineName string: The name of the line with which to work.
componentTypeName string: The component type name.

Returns

Task<string>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the next automatically-generated serial number.

The returned serial number will be for a unit record that does not yet exist.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentTypeName does not refer to a component type configured for the line.
FaultException<TDetail>: There is no available automatically-generated serial number, either because automatically-generated serial numbers are not configured, or because all available serial numbers have been exhausted. The business logic fault reason will be SerialNumberUnavailable.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetNextUnitSerialNumber(string)

Gets the next automatically-generated unit serial number.

public string GetNextUnitSerialNumber(string lineName)

Parameters

lineName string: The name of the line with which to work.

Returns

string: The next automatically-generated serial number.

Remarks

The returned serial number will be for a unit record that does not yet exist.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: There is no available automatically-generated serial number, either because automatically-generated serial numbers are not configured, or because all available serial numbers have been exhausted. The business logic fault reason will be SerialNumberUnavailable.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetNextUnitSerialNumberAsync(string)

Gets the next automatically-generated unit serial number.

public Task<string> GetNextUnitSerialNumberAsync(string lineName)

Parameters

lineName string: The name of the line with which to work.

Returns

Task<string>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the next automatically-generated serial number.

The returned serial number will be for a unit record that does not yet exist.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: There is no available automatically-generated serial number, either because automatically-generated serial numbers are not configured, or because all available serial numbers have been exhausted. The business logic fault reason will be SerialNumberUnavailable.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetServerSettings()

Gets the Acuit Pinpoint email settings.

public ServerSettings GetServerSettings()

Returns

ServerSettings: The Acuit Pinpoint email settings.

Exceptions

CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetServerSettingsAsync()

Gets the Acuit Pinpoint email settings.

public Task<ServerSettings> GetServerSettingsAsync()

Returns

Task<ServerSettings>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the Acuit Pinpoint email settings.

Exceptions

CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetStationSettings3(string, string, string, string)

Gets the configuration settings for a particular station.

public StationSettings GetStationSettings3(string lineName, string stationType, string stationName, string workstationVersion)

Parameters

lineName string: The name of the line with which to work.
stationType string: The station type.
stationName string: The station name.
workstationVersion string: The client software version.

Returns

StationSettings: The configuration settings for the station.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: stationType is null.
FaultException<TDetail>: stationType does not refer to an existing station type.
FaultException<TDetail>: stationName is null.
FaultException<TDetail>: workstationVersion is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetStationSettings3Async(string, string, string, string)

Gets the configuration settings for a particular station.

public Task<StationSettings> GetStationSettings3Async(string lineName, string stationType, string stationName, string workstationVersion)

Parameters

lineName string: The name of the line with which to work.
stationType string: The station type.
stationName string: The station name.
workstationVersion string: The client software version.

Returns

Task<StationSettings>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the configuration settings for the station.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: stationType is null.
FaultException<TDetail>: stationType does not refer to an existing station type.
FaultException<TDetail>: stationName is null.
FaultException<TDetail>: workstationVersion is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetStationTypes(string)

Gets the list of all station types for a line.

public IList<string> GetStationTypes(string lineName)

Parameters

lineName string: The name of the line with which to work.

Returns

IList<string>: A list of station type names.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetStationTypesAsync(string)

Gets the list of all station types for a line.

public Task<IList<string>> GetStationTypesAsync(string lineName)

Parameters

lineName string: The name of the line with which to work.

Returns

Task<IList<string>>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a list of station type names.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetTableData(string, string)

Retrieves an Acuit Pinpoint table from the Acuit Pinpoint database.

public string GetTableData(string lineName, string tableName)

Parameters

lineName string: The name of the line with which to work. This is used to determine which database from which to retrieve the table.
tableName string: The name of the table.

Returns

string: The table data, in CSV format.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: tableName is null.
FaultException<TDetail>: tableName does not refer to an existing table.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetTableDataAsync(string, string)

Retrieves an Acuit Pinpoint table from the Acuit Pinpoint database.

public Task<string> GetTableDataAsync(string lineName, string tableName)

Parameters

lineName string: The name of the line with which to work. This is used to determine which database from which to retrieve the table.
tableName string: The name of the table.

Returns

Task<string>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the table data, in CSV format.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: tableName is null.
FaultException<TDetail>: tableName does not refer to an existing table.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetUnitHistory(int, string)

Gets the complete history for a unit.

public Unit GetUnitHistory(int databaseId, string serialNumber)

Parameters

databaseId int: The identifier of the database from which to retrieve the unit.
serialNumber string: The unit serial number.

Returns

Unit: A Unit object.

Exceptions

FaultException<TDetail>: databaseId does not refer to an existing database.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: serialNumber does not refer to an existing unit.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetUnitHistoryAsync(int, string)

Gets the complete history for a unit.

public Task<Unit> GetUnitHistoryAsync(int databaseId, string serialNumber)

Parameters

databaseId int: The identifier of the database from which to retrieve the unit.
serialNumber string: The unit serial number.

Returns

Task<Unit>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a Unit object.

Exceptions

FaultException<TDetail>: databaseId does not refer to an existing database.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: serialNumber does not refer to an existing unit.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetVersion()

Gets the Acuit Pinpoint version.

public string GetVersion()

Returns

string: The Acuit Pinpoint version.

Exceptions

CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

GetVersionAsync()

Gets the Acuit Pinpoint version.

public Task<string> GetVersionAsync()

Returns

Task<string>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the Acuit Pinpoint version.

Exceptions

CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

InvokePlugIn(string, string, string, string?)

Invokes a server plug-in for any custom purpose.

public string? InvokePlugIn(string lineName, string plugInName, string methodName, string? parameter)

Parameters

lineName string: The name of the line with which to work.
plugInName string: The name of the server plug-in.
methodName string: A name that specifies a method to invoke.
parameter string: A parameter for the method.

Returns

string: Returned data from the method.

Remarks

This is available to allow a workstation plug-in to interact with the server plug-in.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: plugInName is null.
FaultException<TDetail>: plugInName does not refer to the name of a plug-in configured for the line.
FaultException<TDetail>: methodName is null.
FaultException<TDetail>: methodName is invalid.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

InvokePlugInAsync(string, string, string, string?)

Invokes a server plug-in for any custom purpose.

public Task<string?> InvokePlugInAsync(string lineName, string plugInName, string methodName, string? parameter)

Parameters

lineName string: The name of the line with which to work.
plugInName string: The name of the server plug-in.
methodName string: A name that specifies a method to invoke.
parameter string: A parameter for the method.

Returns

Task<string>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains returned data from the method.

This is available to allow a workstation plug-in to interact with the server plug-in.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: plugInName is null.
FaultException<TDetail>: plugInName does not refer to the name of a plug-in configured for the line.
FaultException<TDetail>: methodName is null.
FaultException<TDetail>: methodName is invalid.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

IsAcknowledgeAlertAuthorized(string, string, int, int)

Checks whether a worker is authorized to acknowledge an alert.

public bool IsAcknowledgeAlertAuthorized(string lineName, string stationType, int workerId, int alertId)

Parameters

lineName string: The name of the line with which to work.
stationType string: The station type.
workerId int: The id of the worker.
alertId int: The alert id.

Returns

bool: Whether the worker is authorized to override the test result.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: stationType is null.
FaultException<TDetail>: stationType does not refer to an existing station type.
FaultException<TDetail>: alertId does not refer to an existing alert.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

IsAcknowledgeAlertAuthorizedAsync(string, string, int, int)

Checks whether a worker is authorized to acknowledge an alert.

public Task<bool> IsAcknowledgeAlertAuthorizedAsync(string lineName, string stationType, int workerId, int alertId)

Parameters

lineName string: The name of the line with which to work.
stationType string: The station type.
workerId int: The id of the worker.
alertId int: The alert id.

Returns

Task<bool>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains whether the worker is authorized to override the test result.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: stationType is null.
FaultException<TDetail>: stationType does not refer to an existing station type.
FaultException<TDetail>: alertId does not refer to an existing alert.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

IsAuthorizedForComponentType(string, string, int, string)

Checks whether a worker is authorized for a component type permission.

public bool IsAuthorizedForComponentType(string lineName, string componentTypeName, int workerId, string permission)

Parameters

lineName string: The name of the line with which to work.
componentTypeName string: The component type name.
workerId int: The id of the worker.
permission string: The permission to check.

Returns

bool: Whether the worker is authorized.

Remarks

This is supported by Acuit Pinpoint versions 6.227.204 and later.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentTypeName does not refer to an existing component type.
FaultException<TDetail>: permission is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

IsAuthorizedForComponentTypeAsync(string, string, int, string)

Checks whether a worker is authorized for a component type permission.

public Task<bool> IsAuthorizedForComponentTypeAsync(string lineName, string componentTypeName, int workerId, string permission)

Parameters

lineName string: The name of the line with which to work.
componentTypeName string: The component type name.
workerId int: The id of the worker.
permission string: The permission to check.

Returns

Task<bool>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains whether the worker is authorized.

This is supported by Acuit Pinpoint versions 6.227.204 and later.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentTypeName does not refer to an existing component type.
FaultException<TDetail>: permission is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

IsAuthorizedForStation(string, string, int, string)

Checks whether a worker is authorized for a station permission.

public bool IsAuthorizedForStation(string lineName, string stationType, int workerId, string permission)

Parameters

lineName string: The name of the line with which to work.
stationType string: The station type.
workerId int: The id of the worker.
permission string: The permission to check.

Returns

bool: Whether the worker is authorized for the station permission.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: stationType is null.
FaultException<TDetail>: stationType does not refer to an existing station type.
FaultException<TDetail>: permission is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

IsAuthorizedForStationAsync(string, string, int, string)

Checks whether a worker is authorized for a station permission.

public Task<bool> IsAuthorizedForStationAsync(string lineName, string stationType, int workerId, string permission)

Parameters

lineName string: The name of the line with which to work.
stationType string: The station type.
workerId int: The id of the worker.
permission string: The permission to check.

Returns

Task<bool>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains whether the worker is authorized for the station permission.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: stationType is null.
FaultException<TDetail>: stationType does not refer to an existing station type.
FaultException<TDetail>: permission is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

IsOverrideTestAuthorized(string, int, int)

Checks whether a worker is authorized to override a failed test result.

public bool IsOverrideTestAuthorized(string lineName, int unitTestId, int workerId)

Parameters

lineName string: The name of the line with which to work.
unitTestId int: The identifier of the unit test to check for override permission.
workerId int: The identifier of the worker.

Returns

bool: true if the worker is authorized to override the test result; otherwise, false.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: A unit test with identifier unitTestId does not exist.
FaultException<TDetail>: The worker identifier workerId does not exist or specifies an inactive worker.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

IsOverrideTestAuthorizedAsync(string, int, int)

Checks whether a worker is authorized to override a failed test result.

public Task<bool> IsOverrideTestAuthorizedAsync(string lineName, int unitTestId, int workerId)

Parameters

lineName string: The name of the line with which to work.
unitTestId int: The identifier of the unit test to check for override permission.
workerId int: The identifier of the worker.

Returns

Task<bool>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains true if the worker is authorized to override the test result; otherwise, false.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: A unit test with identifier unitTestId does not exist.
FaultException<TDetail>: The worker identifier workerId does not exist or specifies an inactive worker.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

NotifyTableChanged(int)

Notifies Acuit Pinpoint that one or more tables have been changed by the web interface.

public void NotifyTableChanged(int databaseId)

Parameters

databaseId int: The database identifier for the database that contains the table(s).

Remarks

This should be called when any changes of any kind to any data tables occur, including (for example): a table was created, a table was deleted, a table was renamed, or any table data was changed. This ensures that lines that reference the affected tables are immediately updated.

Exceptions

FaultException<TDetail>: databaseId does not refer to an existing database.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

NotifyTableChangedAsync(int)

Notifies Acuit Pinpoint that one or more tables have been changed by the web interface.

public Task NotifyTableChangedAsync(int databaseId)

Parameters

databaseId int: The database identifier for the database that contains the table(s).

Returns

Task: The task object representing the asynchronous operation.

Remarks

Exceptions

FaultException<TDetail>: databaseId does not refer to an existing database.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

OverrideTest(string, int, int, int, string?)

Overrides a failed test result.

public OverrideTestStatus OverrideTest(string lineName, int unitStationId, int unitTestId, int workerId, string? notes)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
unitTestId int: The identifier of the test to override.
workerId int: The identifier of the worker performing the override.
notes string: Optional additional notes about the test. This can be null or empty.

Returns

OverrideTestStatus: An OverrideTestStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: A unit station with identifier unitStationId does not exist or has already released its unit.
FaultException<TDetail>: A unit test with identifier unitTestId does not exist, or is not associated with the same unit as that of the unit station with identifier unitStationId, or has already been overridden.
FaultException<TDetail>: The worker identifier workerId does not exist or specifies an inactive worker.
FaultException<TDetail>: The worker is not authorized to perform this action.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

OverrideTestAsync(string, int, int, int, string?)

Overrides a failed test result.

public Task<OverrideTestStatus> OverrideTestAsync(string lineName, int unitStationId, int unitTestId, int workerId, string? notes)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
unitTestId int: The identifier of the test to override.
workerId int: The identifier of the worker performing the override.
notes string: Optional additional notes about the test. This can be null or empty.

Returns

Task<OverrideTestStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains an OverrideTestStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: A unit station with identifier unitStationId does not exist or has already released its unit.
FaultException<TDetail>: A unit test with identifier unitTestId does not exist, or is not associated with the same unit as that of the unit station with identifier unitStationId, or has already been overridden.
FaultException<TDetail>: The worker identifier workerId does not exist or specifies an inactive worker.
FaultException<TDetail>: The worker is not authorized to perform this action.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

PerformUnitFinalCheck2(string, string)

Performs a final check against a unit.

public WorkflowCheckResult PerformUnitFinalCheck2(string lineName, string serialNumber)

Parameters

lineName string: The name of the line with which to work.
serialNumber string: The serial number of the unit.

Returns

WorkflowCheckResult: A WorkflowCheckResult with the result.

Remarks

The final check includes:

Ensure that there are no unrepaired defects.
Ensure that all required buyoffs have been set.
Ensure that all components were verified and are valid.
Ensure that all tests were performed and passed.

Note that final checks ignore sequence numbers, which are used for intermediate checks.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: A unit with serial number serialNumber could not be found. The business logic fault reason will be UnitSerialSearchNotFound.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

PerformUnitFinalCheck2Async(string, string)

Performs a final check against a unit.

public Task<WorkflowCheckResult> PerformUnitFinalCheck2Async(string lineName, string serialNumber)

Parameters

lineName string: The name of the line with which to work.
serialNumber string: The serial number of the unit.

Returns

Task<WorkflowCheckResult>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a WorkflowCheckResult with the result.

The final check includes:

Ensure that there are no unrepaired defects.
Ensure that all required buyoffs have been set.
Ensure that all components were verified and are valid.
Ensure that all tests were performed and passed.

Note that final checks ignore sequence numbers, which are used for intermediate checks.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: A unit with serial number serialNumber could not be found. The business logic fault reason will be UnitSerialSearchNotFound.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

PerformUnitSequenceCheck2(string, string, float?, float?)

Performs a sequence check against a unit.

public WorkflowCheckResult PerformUnitSequenceCheck2(string lineName, string serialNumber, float? minSequence, float? maxSequence)

Parameters

lineName string: The name of the line with which to work.
serialNumber string: The serial number of the unit.
minSequence float?: The minimum sequence number check to perform against the unit, or null to enforce no minimum.
maxSequence float?: The maximum sequence number check to perform against the unit, or null to enforce no maximum.

Returns

WorkflowCheckResult: A WorkflowCheckResult with the result.

Remarks

Sequence checks are intermediate checks on the unit state, which include:

Ensure that there are no unrepaired defects.
Ensure that all required buyoffs with sequence numbers defined and in the specified sequence range have been set.
Ensure that all components with sequence numbers defined and in the specified sequence range were verified and are valid.
Ensure that all tests with sequence numbers defined and in the specified sequence range were performed and passed.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: A unit with serial number serialNumber could not be found. The business logic fault reason will be UnitSerialSearchNotFound.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

PerformUnitSequenceCheck2Async(string, string, float?, float?)

Performs a sequence check against a unit.

public Task<WorkflowCheckResult> PerformUnitSequenceCheck2Async(string lineName, string serialNumber, float? minSequence, float? maxSequence)

Parameters

lineName string: The name of the line with which to work.
serialNumber string: The serial number of the unit.
minSequence float?: The minimum sequence number check to perform against the unit, or null to enforce no minimum.
maxSequence float?: The maximum sequence number check to perform against the unit, or null to enforce no maximum.

Returns

Task<WorkflowCheckResult>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a WorkflowCheckResult with the result.

Sequence checks are intermediate checks on the unit state, which include:

Ensure that there are no unrepaired defects.
Ensure that all required buyoffs with sequence numbers defined and in the specified sequence range have been set.
Ensure that all components with sequence numbers defined and in the specified sequence range were verified and are valid.
Ensure that all tests with sequence numbers defined and in the specified sequence range were performed and passed.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: A unit with serial number serialNumber could not be found. The business logic fault reason will be UnitSerialSearchNotFound.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

PrepareBlankUnitRecords3(string, string?, string)

Prepares blank unit records.

public BlankUnitRecordsStatus PrepareBlankUnitRecords3(string lineName, string? scheduleName, string productionSchedule)

Parameters

lineName string: The name of the line with which to work.
scheduleName string: The production schedule name. If this is null or empty, then unit records will not be associated with a schedule.
productionSchedule string: The production schedule.

Returns

BlankUnitRecordsStatus: A BlankUnitRecordsStatus object representing the status.

Remarks

This is typically used to upload a production schedule.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: productionSchedule is null.
FaultException<TDetail>: productionSchedule is invalid or an I/O error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

PrepareBlankUnitRecords3Async(string, string?, string)

Prepares blank unit records.

public Task<BlankUnitRecordsStatus> PrepareBlankUnitRecords3Async(string lineName, string? scheduleName, string productionSchedule)

Parameters

lineName string: The name of the line with which to work.
scheduleName string: The production schedule name. If this is null or empty, then unit records will not be associated with a schedule.
productionSchedule string: The production schedule.

Returns

Task<BlankUnitRecordsStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a BlankUnitRecordsStatus object representing the status.

This is typically used to upload a production schedule.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: productionSchedule is null.
FaultException<TDetail>: productionSchedule is invalid or an I/O error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

QueryDefectCounts(string, ProductionPeriod)

Retrieves all defects that occurred during a given period for a line.

public QueryDefectCountsResult QueryDefectCounts(string lineName, ProductionPeriod productionPeriod)

Parameters

lineName string: The name of the line with which to work.
productionPeriod ProductionPeriod: The period for which to retrieve results.

Returns

QueryDefectCountsResult: A QueryDefectCountsResult object.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: productionPeriod is null.
FaultException<TDetail>: productionPeriod is invalid.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

QueryDefectCountsAsync(string, ProductionPeriod)

Retrieves all defects that occurred during a given period for a line.

public Task<QueryDefectCountsResult> QueryDefectCountsAsync(string lineName, ProductionPeriod productionPeriod)

Parameters

lineName string: The name of the line with which to work.
productionPeriod ProductionPeriod: The period for which to retrieve results.

Returns

Task<QueryDefectCountsResult>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a QueryDefectCountsResult object.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: productionPeriod is null.
FaultException<TDetail>: productionPeriod is invalid.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

QueryDefectCountsTree(string, ProductionPeriod)

Retrieves all defects that occurred during a given period for a line, organized as a tree.

public QueryDefectCountsTreeResult QueryDefectCountsTree(string lineName, ProductionPeriod productionPeriod)

Parameters

lineName string: The name of the line with which to work.
productionPeriod ProductionPeriod: The period for which to retrieve results.

Returns

QueryDefectCountsTreeResult: A QueryDefectCountsTreeResult object.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: productionPeriod is null.
FaultException<TDetail>: productionPeriod is invalid.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

QueryDefectCountsTreeAsync(string, ProductionPeriod)

Retrieves all defects that occurred during a given period for a line, organized as a tree.

public Task<QueryDefectCountsTreeResult> QueryDefectCountsTreeAsync(string lineName, ProductionPeriod productionPeriod)

Parameters

lineName string: The name of the line with which to work.
productionPeriod ProductionPeriod: The period for which to retrieve results.

Returns

Task<QueryDefectCountsTreeResult>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a QueryDefectCountsTreeResult object.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: productionPeriod is null.
FaultException<TDetail>: productionPeriod is invalid.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

QueryLatestDefects(string, int)

Retrieves the latest defects for a line.

public IList<UnitDefect> QueryLatestDefects(string lineName, int takeCount)

Parameters

lineName string: The name of the line with which to work.
takeCount int: The maximum number of defects to retrieve.

Returns

IList<UnitDefect>: A list of unit defects.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

QueryLatestDefectsAsync(string, int)

Retrieves the latest defects for a line.

public Task<IList<UnitDefect>> QueryLatestDefectsAsync(string lineName, int takeCount)

Parameters

lineName string: The name of the line with which to work.
takeCount int: The maximum number of defects to retrieve.

Returns

Task<IList<UnitDefect>>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a list of unit defects.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

RemoveComponent2(string, int, string)

Remove a component from a unit.

public ComponentStatus RemoveComponent2(string lineName, int unitStationId, string componentTypeName)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
componentTypeName string: The component type name.

Returns

ComponentStatus: A ComponentStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

RemoveComponent2Async(string, int, string)

Remove a component from a unit.

public Task<ComponentStatus> RemoveComponent2Async(string lineName, int unitStationId, string componentTypeName)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
componentTypeName string: The component type name.

Returns

Task<ComponentStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a ComponentStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

RemoveDatabase(int)

Removes a database reference.

public void RemoveDatabase(int databaseId)

Parameters

databaseId int: The database identifier.

Remarks

This only causes Acuit Pinpoint to stop using the database; it does not delete the database itself.

Exceptions

FaultException<TDetail>: databaseId does not refer to an existing database.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

RemoveDatabaseAsync(int)

Removes a database reference.

public Task RemoveDatabaseAsync(int databaseId)

Parameters

databaseId int: The database identifier.

Returns

Task: The task object representing the asynchronous operation.

Remarks

This only causes Acuit Pinpoint to stop using the database; it does not delete the database itself.

Exceptions

FaultException<TDetail>: databaseId does not refer to an existing database.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

RemovePreassembly(string, int, string)

Removes a preassembly from a unit, causing a new preassembly to be created containing the removed components and other associated history.

public RemovePreassemblyStatus RemovePreassembly(string lineName, int unitStationId, string componentTypeName)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
componentTypeName string: The component type name.

Returns

RemovePreassemblyStatus: A RemovePreassemblyStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

RemovePreassemblyAsync(string, int, string)

Removes a preassembly from a unit, causing a new preassembly to be created containing the removed components and other associated history.

public Task<RemovePreassemblyStatus> RemovePreassemblyAsync(string lineName, int unitStationId, string componentTypeName)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
componentTypeName string: The component type name.

Returns

Task<RemovePreassemblyStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a RemovePreassemblyStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

ScanPreassembly2(string, int, string, string, string?)

Scans a preassembly into a unit.

public ScanPreassemblyStatus ScanPreassembly2(string lineName, int unitStationId, string componentTypeName, string componentSerialNumber, string? componentModelNumber)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
componentTypeName string: The component type name.
componentSerialNumber string: The component serial number.
componentModelNumber string: The component model number. This must be specified if the component type is configured for uniqueSerialNumbersPerPartNumber; otherwise, it can be null or empty.

Returns

ScanPreassemblyStatus: A ScanPreassemblyStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentSerialNumber is null.
FaultException<TDetail>: componentSerialNumber contains one or more invalid characters.
FaultException<TDetail>: componentModelNumber is null when the component type is configured to require unique serial numbers per part number.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

ScanPreassembly2Async(string, int, string, string, string?)

Scans a preassembly into a unit.

public Task<ScanPreassemblyStatus> ScanPreassembly2Async(string lineName, int unitStationId, string componentTypeName, string componentSerialNumber, string? componentModelNumber)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
componentTypeName string: The component type name.
componentSerialNumber string: The component serial number.
componentModelNumber string: The component model number. This must be specified if the component type is configured for uniqueSerialNumbersPerPartNumber; otherwise, it can be null or empty.

Returns

Task<ScanPreassemblyStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a ScanPreassemblyStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentSerialNumber is null.
FaultException<TDetail>: componentSerialNumber contains one or more invalid characters.
FaultException<TDetail>: componentModelNumber is null when the component type is configured to require unique serial numbers per part number.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SendMail(string?, string, string, string)

Sends an email.

public void SendMail(string? from, string recipients, string subject, string body)

Parameters

from string: The address information of the message sender. If this is null or empty, then the configured "from" address is Acuit Pinpoint is used.
recipients string: The addresses that the message is sent to. Multiple addresses should be separated by commas.
subject string: The subject line for the message.
body string: The message body.

Remarks

The email is sent asynchronously. Errors sending the email will be logged in Acuit Pinpoint.

Exceptions

FaultException<TDetail>: recipients is null or empty.
FaultException<TDetail>: subject is null.
FaultException<TDetail>: body is null.
FaultException<TDetail>: from is malformed.
FaultException<TDetail>: recipients is malformed.
FaultException<TDetail>: The mail settings have not been configured.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SendMailAsync(string?, string, string, string)

Sends an email.

public Task SendMailAsync(string? from, string recipients, string subject, string body)

Parameters

from string: The address information of the message sender. If this is null or empty, then the configured "from" address is Acuit Pinpoint is used.
recipients string: The addresses that the message is sent to. Multiple addresses should be separated by commas.
subject string: The subject line for the message.
body string: The message body.

Returns

Task: The task object representing the asynchronous operation.

Remarks

The email is sent asynchronously. Errors sending the email will be logged in Acuit Pinpoint.

Exceptions

FaultException<TDetail>: recipients is null or empty.
FaultException<TDetail>: subject is null.
FaultException<TDetail>: body is null.
FaultException<TDetail>: from is malformed.
FaultException<TDetail>: recipients is malformed.
FaultException<TDetail>: The mail settings have not been configured.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SendNotification(string?, string, string)

Sends a notification.

public void SendNotification(string? recipients, string subjectContext, string body)

Parameters

recipients string: The email addresses to which to send the notification. Multiple addresses should be separated by commas. If this is null or empty, then the configured administrator email address(es) will be used.
subjectContext string: The notification subject context. The resulting email subject will be "Acuit Pinpoint Notification: ", followed by this subject context.
body string: The notification body.

Remarks

This is similar to SendMail(string?, string, string, string). The only effective differences are:

The configured "from" address in Acuit Pinpoint is always used.
The subject line in the notification email will be "Acuit Pinpoint Notification: ", followed by this subject context.

Currently, notifications are only sent via email, which requires the mail settings to be configured in Acuit Pinpoint.

The email is sent asynchronously. Any errors sending the email will be logged in Acuit Pinpoint.

Exceptions

FaultException<TDetail>: subjectContext is null.
FaultException<TDetail>: body is null.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SendNotificationAsync(string?, string, string)

Sends a notification.

public Task SendNotificationAsync(string? recipients, string subjectContext, string body)

Parameters

recipients string: The email addresses to which to send the notification. Multiple addresses should be separated by commas. If this is null or empty, then the configured administrator email address(es) will be used.
subjectContext string: The notification subject context. The resulting email subject will be "Acuit Pinpoint Notification: ", followed by this subject context.
body string: The notification body.

Returns

Task: The task object representing the asynchronous operation.

Remarks

This is similar to SendMail(string?, string, string, string). The only effective differences are:

The configured "from" address in Acuit Pinpoint is always used.
The subject line in the notification email will be "Acuit Pinpoint Notification: ", followed by this subject context.

Currently, notifications are only sent via email, which requires the mail settings to be configured in Acuit Pinpoint.

The email is sent asynchronously. Any errors sending the email will be logged in Acuit Pinpoint.

Exceptions

FaultException<TDetail>: subjectContext is null.
FaultException<TDetail>: body is null.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SetActiveSettingsXml2(string, string, string)

Updates the active configuration for a line.

public void SetActiveSettingsXml2(string lineName, string settings, string userName)

Parameters

lineName string: The name of the line with which to work.
settings string: The new settings XML.
userName string: The user making this configuration change (e.g., "DOMAIN\user").

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: settings is null.
FaultException<TDetail>: userName is null.
FaultException<TDetail>: settings contains an invalid configuration.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SetActiveSettingsXml2Async(string, string, string)

Updates the active configuration for a line.

public Task SetActiveSettingsXml2Async(string lineName, string settings, string userName)

Parameters

lineName string: The name of the line with which to work.
settings string: The new settings XML.
userName string: The user making this configuration change (e.g., "DOMAIN\user").

Returns

Task: The task object representing the asynchronous operation.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: settings is null.
FaultException<TDetail>: userName is null.
FaultException<TDetail>: settings contains an invalid configuration.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SetBuyoff2(string, int, string)

Sets a buyoff for a unit.

public BuyoffStatus SetBuyoff2(string lineName, int unitStationId, string buyoffName)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
buyoffName string: The buyoff name.

Returns

BuyoffStatus: A BuyoffStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: buyoffName is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SetBuyoff2Async(string, int, string)

Sets a buyoff for a unit.

public Task<BuyoffStatus> SetBuyoff2Async(string lineName, int unitStationId, string buyoffName)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).
buyoffName string: The buyoff name.

Returns

Task<BuyoffStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a BuyoffStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: buyoffName is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SetDatabaseConfigurationXml(int, string, string)

Updates the configuration settings for a database.

public void SetDatabaseConfigurationXml(int databaseId, string configXml, string userName)

Parameters

databaseId int: The identifier of the database.
configXml string: The new configuration settings XML.
userName string: The user making this configuration change (e.g., "DOMAIN\user").

Exceptions

FaultException<TDetail>: databaseId is not a valid database identifier.
FaultException<TDetail>: configXml is null.
FaultException<TDetail>: userName is null.
FaultException<TDetail>: configXml contains an invalid configuration.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SetDatabaseConfigurationXmlAsync(int, string, string)

Updates the configuration settings for a database.

public Task SetDatabaseConfigurationXmlAsync(int databaseId, string configXml, string userName)

Parameters

databaseId int: The identifier of the database.
configXml string: The new configuration settings XML.
userName string: The user making this configuration change (e.g., "DOMAIN\user").

Returns

Task: The task object representing the asynchronous operation.

Exceptions

FaultException<TDetail>: databaseId is not a valid database identifier.
FaultException<TDetail>: configXml is null.
FaultException<TDetail>: userName is null.
FaultException<TDetail>: configXml contains an invalid configuration.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SetServerSettings(ServerSettings)

Sets the Acuit Pinpoint email settings.

public void SetServerSettings(ServerSettings settings)

Parameters

settings ServerSettings: The new Acuit Pinpoint email settings.

Exceptions

FaultException<TDetail>: settings is null.
FaultException<TDetail>: The settings properties are not valid.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SetServerSettingsAsync(ServerSettings)

Sets the Acuit Pinpoint email settings.

public Task SetServerSettingsAsync(ServerSettings settings)

Parameters

settings ServerSettings: The new Acuit Pinpoint email settings.

Returns

Task: The task object representing the asynchronous operation.

Exceptions

FaultException<TDetail>: settings is null.
FaultException<TDetail>: The settings properties are not valid.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SubassemblyComponentScanned(string, string, string, string)

Indicates that a subassembly component was scanned at a station, and checks whether the component is acceptable.

public SubassemblyComponentScannedStatus SubassemblyComponentScanned(string lineName, string assemblyModelNumber, string componentTypeName, string componentModelNumber)

Parameters

lineName string: The name of the line with which to work.
assemblyModelNumber string: The subassembly model number.
componentTypeName string: The component type name.
componentModelNumber string: The component model number to verify.

Returns

SubassemblyComponentScannedStatus: A SubassemblyComponentScannedStatus object representing the results.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: assemblyModelNumber is null.
FaultException<TDetail>: assemblyModelNumber contains one or more invalid characters.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentModelNumber is null.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SubassemblyComponentScannedAsync(string, string, string, string)

Indicates that a subassembly component was scanned at a station, and checks whether the component is acceptable.

public Task<SubassemblyComponentScannedStatus> SubassemblyComponentScannedAsync(string lineName, string assemblyModelNumber, string componentTypeName, string componentModelNumber)

Parameters

lineName string: The name of the line with which to work.
assemblyModelNumber string: The subassembly model number.
componentTypeName string: The component type name.
componentModelNumber string: The component model number to verify.

Returns

Task<SubassemblyComponentScannedStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a SubassemblyComponentScannedStatus object representing the results.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: assemblyModelNumber is null.
FaultException<TDetail>: assemblyModelNumber contains one or more invalid characters.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentModelNumber is null.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SubassemblyScanned2(string, int, string)

Indicates that a subassembly was scanned at a station.

public SubassemblyScanStatus SubassemblyScanned2(string lineName, int workerStationId, string modelNumber)

Parameters

lineName string: The name of the line with which to work.
workerStationId int: The worker station identifier (e.g., from a previous call to WorkerLogOn2(string, string, string, int)).
modelNumber string: The subassembly model number.

Returns

SubassemblyScanStatus: A SubassemblyScanStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: modelNumber is null.
FaultException<TDetail>: modelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

SubassemblyScanned2Async(string, int, string)

Indicates that a subassembly was scanned at a station.

public Task<SubassemblyScanStatus> SubassemblyScanned2Async(string lineName, int workerStationId, string modelNumber)

Parameters

lineName string: The name of the line with which to work.
workerStationId int: The worker station identifier (e.g., from a previous call to WorkerLogOn2(string, string, string, int)).
modelNumber string: The subassembly model number.

Returns

Task<SubassemblyScanStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a SubassemblyScanStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: modelNumber is null.
FaultException<TDetail>: modelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

TestServerEmail(ServerSettings)

Tests Acuit Pinpoint email settings.

public void TestServerEmail(ServerSettings settings)

Parameters

settings ServerSettings: The email settings to test.

Remarks

If no exception is thrown, the test succeeded.

Exceptions

FaultException<TDetail>: settings is null.
FaultException<TDetail>: The settings properties are not valid.
FaultException<TDetail>: The test failed. See the exception message for details.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

TestServerEmailAsync(ServerSettings)

Tests Acuit Pinpoint email settings.

public Task TestServerEmailAsync(ServerSettings settings)

Parameters

settings ServerSettings: The email settings to test.

Returns

Task: The task object representing the asynchronous operation.

Remarks

If no exception is thrown, the test succeeded.

Exceptions

FaultException<TDetail>: settings is null.
FaultException<TDetail>: The settings properties are not valid.
FaultException<TDetail>: The test failed. See the exception message for details.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UnitReleased3(string, int)

Indicates that a unit was released from a station.

public UnitReleaseStatus UnitReleased3(string lineName, int unitStationId)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).

Returns

UnitReleaseStatus: A UnitReleaseStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UnitReleased3Async(string, int)

Indicates that a unit was released from a station.

public Task<UnitReleaseStatus> UnitReleased3Async(string lineName, int unitStationId)

Parameters

lineName string: The name of the line with which to work.
unitStationId int: The unit station identifier (e.g., from a previous call to UnitScanned4(string, int, string, string?)).

Returns

Task<UnitReleaseStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a UnitReleaseStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UnitScanned4(string, int, string, string?)

Indicates that a unit was scanned at a station.

public UnitScanStatus UnitScanned4(string lineName, int workerStationId, string serialNumber, string? modelNumber)

Parameters

lineName string: The name of the line with which to work.
workerStationId int: The worker station identifier (e.g., from a previous call to WorkerLogOn2(string, string, string, int)).
serialNumber string: The serial number of the unit. This may be empty for station types that do not work with serialized units.
modelNumber string: The model number of the unit. This may be null (with Acuit Pinpoint versions 6.229.27 and later) or empty if the unit record already exists.

Returns

UnitScanStatus: A UnitScanStatus object representing the status.

Remarks

serialNumber can contain a beginning '', an ending '', or both, to support wilcard searches. If serialNumber contains wildcards, modelNumber must be null or empty.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: serialNumber contains one or more invalid characters.
FaultException<TDetail>: modelNumber contains one or more invalid characters.
FaultException<TDetail>: modelNumber must be null or empty when serialNumber contains wildcards.
FaultException<TDetail>: A business logic error occurred.
FaultException<TDetail>: A line switch must occur to scan the unit.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UnitScanned4Async(string, int, string, string?)

Indicates that a unit was scanned at a station.

public Task<UnitScanStatus> UnitScanned4Async(string lineName, int workerStationId, string serialNumber, string? modelNumber)

Parameters

lineName string: The name of the line with which to work.
workerStationId int: The worker station identifier (e.g., from a previous call to WorkerLogOn2(string, string, string, int)).
serialNumber string: The serial number of the unit. This may be empty for station types that do not work with serialized units.
modelNumber string: The model number of the unit. This may be null (with Acuit Pinpoint versions 6.229.27 and later) or empty if the unit record already exists.

Returns

Task<UnitScanStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a UnitScanStatus object representing the status.

serialNumber can contain a beginning '', an ending '', or both, to support wilcard searches. If serialNumber contains wildcards, modelNumber must be null or empty.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: serialNumber is null.
FaultException<TDetail>: serialNumber contains one or more invalid characters.
FaultException<TDetail>: modelNumber contains one or more invalid characters.
FaultException<TDetail>: modelNumber must be null or empty when serialNumber contains wildcards.
FaultException<TDetail>: A business logic error occurred.
FaultException<TDetail>: A line switch must occur to scan the unit.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UnitScannedViaComponent2(string, int, string, string, string?, string?)

Indicates that a unit was scanned at a station by a component scan.

public UnitScanStatus UnitScannedViaComponent2(string lineName, int workerStationId, string componentTypeName, string componentSerialNumber, string? componentModelNumber, string? unitModelNumber)

Parameters

lineName string: The name of the line with which to work.
workerStationId int: The worker station identifier (e.g., from a previous call to WorkerLogOn2(string, string, string, int)).
componentTypeName string: The component type name.
componentSerialNumber string: The component serial number.
componentModelNumber string: The component model number. This may be null or empty if the unit record already exists or if the component type does not scan component model numbers. This must be specified if the component type is configured for uniqueSerialNumbersPerPartNumber.
unitModelNumber string: The model number of the unit. This may be null or empty if the unit record already exists.

Returns

UnitScanStatus: A UnitScanStatus object representing the status.

Remarks

If a unit record is found or can be created from the provided information (i.e., no business logic error has occurred thus far), then a component scan will be attempted if componentModelNumber was provided. The scan will be recorded only if the component scan is deemed valid. If the component scan fails for any reason (e.g., invalid component model), a business logic fault will occur, and no changes will be saved at all, for the component scan or the unit scan, even if "allowInvalid" is set to "true" in the line's component verification settings.

This must be used instead of UnitScannedViaComponent3(string, int, string, string, string?, string?, string?, int?) with Acuit Pinpoint versions earlier than 6.227.204.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentSerialNumber is null.
FaultException<TDetail>: componentSerialNumber contains one or more invalid characters.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: unitModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UnitScannedViaComponent2Async(string, int, string, string, string?, string?)

Indicates that a unit was scanned at a station by a component scan.

public Task<UnitScanStatus> UnitScannedViaComponent2Async(string lineName, int workerStationId, string componentTypeName, string componentSerialNumber, string? componentModelNumber, string? unitModelNumber)

Parameters

lineName string: The name of the line with which to work.
workerStationId int: The worker station identifier (e.g., from a previous call to WorkerLogOn2(string, string, string, int)).
componentTypeName string: The component type name.
componentSerialNumber string: The component serial number.
componentModelNumber string: The component model number. This may be null or empty if the unit record already exists or if the component type does not scan component model numbers. This must be specified if the component type is configured for uniqueSerialNumbersPerPartNumber.
unitModelNumber string: The model number of the unit. This may be null or empty if the unit record already exists.

Returns

Task<UnitScanStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a UnitScanStatus object representing the status.

This must be used instead of UnitScannedViaComponent3Async(string, int, string, string, string?, string?, string?, int?) with Acuit Pinpoint versions earlier than 6.227.204.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentSerialNumber is null.
FaultException<TDetail>: componentSerialNumber contains one or more invalid characters.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: unitModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UnitScannedViaComponent3(string, int, string, string, string?, string?, string?, int?)

Indicates that a unit was scanned at a station by a component scan.

public UnitScanStatus UnitScannedViaComponent3(string lineName, int workerStationId, string componentTypeName, string componentSerialNumber, string? componentModelNumber, string? unitModelNumber, string? productionGroupName, int? sequenceNumber)

Parameters

lineName string: The name of the line with which to work.
workerStationId int: The worker station identifier (e.g., from a previous call to WorkerLogOn2(string, string, string, int)).
componentTypeName string: The component type name.
componentSerialNumber string: The component serial number.
componentModelNumber string: The component model number. This may be null or empty if the unit record already exists or if the component type does not scan component model numbers. This must be specified if the component type is configured for uniqueSerialNumbersPerPartNumber.
unitModelNumber string: The model number of the unit. This may be null or empty if the unit record already exists. If this is provided and the unit record already exists, this must match the value for the existing unit.
productionGroupName string: The optional production group name to assign to a new unit. If this is provided and the unit record already exists, this must match the value for the existing unit.
sequenceNumber int?: The optional production sequence number to assign to a new unit. If this is provided and the unit record already exists, this must match the value for the existing unit.

Returns

UnitScanStatus: A UnitScanStatus object representing the status.

Remarks

Note that if this is used to create a new preassembly, any productionGroupName or sequenceNumber values provided to this method will be discarded when the preassembly is later merged into a unit, but these values can be useful for providing to label templates when the preassembly is created.

This is supported by Acuit Pinpoint versions 6.227.204 and later; for earlier versions, use UnitScannedViaComponent2(string, int, string, string, string?, string?).

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentSerialNumber is null.
FaultException<TDetail>: componentSerialNumber contains one or more invalid characters.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: unitModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UnitScannedViaComponent3Async(string, int, string, string, string?, string?, string?, int?)

Indicates that a unit was scanned at a station by a component scan.

public Task<UnitScanStatus> UnitScannedViaComponent3Async(string lineName, int workerStationId, string componentTypeName, string componentSerialNumber, string? componentModelNumber, string? unitModelNumber, string? productionGroupName, int? sequenceNumber)

Parameters

lineName string: The name of the line with which to work.
workerStationId int: The worker station identifier (e.g., from a previous call to WorkerLogOn2(string, string, string, int)).
componentTypeName string: The component type name.
componentSerialNumber string: The component serial number.
componentModelNumber string: The component model number. This may be null or empty if the unit record already exists or if the component type does not scan component model numbers. This must be specified if the component type is configured for uniqueSerialNumbersPerPartNumber.
unitModelNumber string: The model number of the unit. This may be null or empty if the unit record already exists. If this is provided and the unit record already exists, this must match the value for the existing unit.
productionGroupName string: The optional production group name to assign to a new unit. If this is provided and the unit record already exists, this must match the value for the existing unit.
sequenceNumber int?: The optional production sequence number to assign to a new unit. If this is provided and the unit record already exists, this must match the value for the existing unit.

Returns

Task<UnitScanStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a UnitScanStatus object representing the status.

This is supported by Acuit Pinpoint versions 6.227.204 and later; for earlier versions, use UnitScannedViaComponent2Async(string, int, string, string, string?, string?).

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: componentTypeName is null.
FaultException<TDetail>: componentSerialNumber is null.
FaultException<TDetail>: componentSerialNumber contains one or more invalid characters.
FaultException<TDetail>: componentModelNumber contains one or more invalid characters.
FaultException<TDetail>: unitModelNumber contains one or more invalid characters.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UpdateLine(Line)

Updates a line.

public Line UpdateLine(Line line)

Parameters

line Line: The line to update. DatabaseId and/or Name in Database indicates the database, and LineId indicates the line.

Returns

Line: The updated line.

Exceptions

FaultException<TDetail>: line is null.
FaultException<TDetail>: Database in line is null.
FaultException<TDetail>: DatabaseId and/or Name in Database in line does not specify one database.
FaultException<TDetail>: LineId in line does not correspond to an existing line.
FaultException<TDetail>: Name in line is null or empty.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UpdateLineAsync(Line)

Updates a line.

public Task<Line> UpdateLineAsync(Line line)

Parameters

line Line: The line to update. DatabaseId and/or Name in Database indicates the database, and LineId indicates the line.

Returns

Task<Line>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains the updated line.

Exceptions

FaultException<TDetail>: line is null.
FaultException<TDetail>: Database in line is null.
FaultException<TDetail>: DatabaseId and/or Name in Database in line does not specify one database.
FaultException<TDetail>: LineId in line does not correspond to an existing line.
FaultException<TDetail>: Name in line is null or empty.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UpgradeDatabase(int)

Upgrades a database with an older schema to the current schema.

public void UpgradeDatabase(int databaseId)

Parameters

databaseId int: The database identifier.

Exceptions

FaultException<TDetail>: databaseId does not refer to an existing database or does not refer to a database that can be upgraded.
FaultException<TDetail>: An error while attempting to upgrade the database.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

UpgradeDatabaseAsync(int)

Upgrades a database with an older schema to the current schema.

public Task UpgradeDatabaseAsync(int databaseId)

Parameters

databaseId int: The database identifier.

Returns

Task: The task object representing the asynchronous operation.

Exceptions

FaultException<TDetail>: databaseId does not refer to an existing database or does not refer to a database that can be upgraded.
FaultException<TDetail>: An error while attempting to upgrade the database.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

Use(PinpointServiceClientOptions, Action<PinpointServiceClient>)

A helper to perform work with a PinpointServiceClient, properly closing the client and handling errors properly.

public static void Use(PinpointServiceClientOptions options, Action<PinpointServiceClient> worker)

Parameters

options PinpointServiceClientOptions: The client options to use for the Acuit Pinpoint service client.
worker Action<PinpointServiceClient>: The delegate that performs the work, which will be provided the Acuit Pinpoint service client as its only parameter.

Remarks

This uses Use<TClient>(Func<TClient>, Action<TClient>) internally. See the remarks for that method for more information.

Exceptions

ArgumentNullException: options is null.
ArgumentNullException: worker is null.
InvalidOperationException: The options are invalid.
CommunicationException: A communication error occurred. This includes faults.
TimeoutException: A communication timeout error occurred.

UseAsync(PinpointServiceClientOptions, Func<PinpointServiceClient, Task>)

A helper to perform work with a PinpointServiceClient, properly closing the client and handling errors properly.

public static Task UseAsync(PinpointServiceClientOptions options, Func<PinpointServiceClient, Task> worker)

Parameters

options PinpointServiceClientOptions: The client options to use for the Acuit Pinpoint service client.
worker Func<PinpointServiceClient, Task>: The delegate that performs the asynchronous work, which will be provided the Acuit Pinpoint service client as its only parameter and should return a task object representing the asynchronous operation.

Returns

Task: The task object representing the asynchronous operation.

Remarks

This uses UseAsync<TClient>(Func<TClient>, Func<TClient, Task>) internally. See the remarks for that method for more information.

Note: When targeting .NET 8 or later, using this method is unnecessary, as the client's IAsyncDisposable.DisposeAsync implementation provides the equivalent functionality in a more natural way using await using.

Exceptions

ArgumentNullException: options is null.
ArgumentNullException: worker is null.
InvalidOperationException: The options are invalid.
CommunicationException: A communication error occurred. This includes faults.
TimeoutException: A communication timeout error occurred.

UseAsync<TResult>(PinpointServiceClientOptions, Func<PinpointServiceClient, Task<TResult>>)

A helper to perform work with a PinpointServiceClient, properly closing the client and handling errors properly.

public static Task<TResult> UseAsync<TResult>(PinpointServiceClientOptions options, Func<PinpointServiceClient, Task<TResult>> worker)

Parameters

options PinpointServiceClientOptions: The client options to use for the Acuit Pinpoint service client.
worker Func<PinpointServiceClient, Task<TResult>>: The delegate that performs the asynchronous work, which will be provided the Acuit Pinpoint service client as its only parameter and should return a task object representing the asynchronous operation, producing as its result a value of type TResult.

Returns

Task<TResult>: The task object representing the asynchronous operation.

Type Parameters

TResult: The return value type.

Remarks

Once the operation completes, the Result property on the returned task object contains the value produced by worker.

This uses UseAsync<TClient, TResult>(Func<TClient>, Func<TClient, Task<TResult>>) internally. See the remarks for that method for more information.

Exceptions

ArgumentNullException: options is null.
ArgumentNullException: worker is null.
InvalidOperationException: The options are invalid.
CommunicationException: A communication error occurred. This includes faults.
TimeoutException: A communication timeout error occurred.

Use<TResult>(PinpointServiceClientOptions, Func<PinpointServiceClient, TResult>)

A helper to perform work with a PinpointServiceClient, properly closing the client and handling errors properly.

public static TResult Use<TResult>(PinpointServiceClientOptions options, Func<PinpointServiceClient, TResult> worker)

Parameters

options PinpointServiceClientOptions: The client options to use for the Acuit Pinpoint service client.
worker Func<PinpointServiceClient, TResult>: The delegate that performs the work, which will be provided the Acuit Pinpoint service client as its only parameter and should return a value of type TResult.

Returns

TResult: The return value from worker.

Type Parameters

TResult: The return value type.

Remarks

This uses Use<TClient, TResult>(Func<TClient>, Func<TClient, TResult>) internally. See the remarks for that method for more information.

Exceptions

ArgumentNullException: options is null.
ArgumentNullException: worker is null.
InvalidOperationException: The options are invalid.
CommunicationException: A communication error occurred. This includes faults.
TimeoutException: A communication timeout error occurred.

WorkerLogOff(string, int)

Logs a worker off of a station.

public void WorkerLogOff(string lineName, int workerStationId)

Parameters

lineName string: The name of the line with which to work.
workerStationId int: The worker station identifier (e.g., from a previous call to WorkerLogOn2(string, string, string, int)).

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

WorkerLogOffAsync(string, int)

Logs a worker off of a station.

public Task WorkerLogOffAsync(string lineName, int workerStationId)

Parameters

lineName string: The name of the line with which to work.
workerStationId int: The worker station identifier (e.g., from a previous call to WorkerLogOn2(string, string, string, int)).

Returns

Task: The task object representing the asynchronous operation.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

WorkerLogOn2(string, string, string, int)

Logs a worker onto a station.

public WorkerLogOnStatus WorkerLogOn2(string lineName, string stationType, string stationName, int workerId)

Parameters

lineName string: The name of the line with which to work.
stationType string: The station type.
stationName string: The station name.
workerId int: The worker identifier.

Returns

WorkerLogOnStatus: A WorkerLogOnStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: stationType is null.
FaultException<TDetail>: stationName is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

WorkerLogOn2Async(string, string, string, int)

Logs a worker onto a station.

public Task<WorkerLogOnStatus> WorkerLogOn2Async(string lineName, string stationType, string stationName, int workerId)

Parameters

lineName string: The name of the line with which to work.
stationType string: The station type.
stationName string: The station name.
workerId int: The worker identifier.

Returns

Task<WorkerLogOnStatus>: The task object representing the asynchronous operation.

Remarks

Once the operation completes, the Result property on the returned task object contains a WorkerLogOnStatus object representing the status.

Exceptions

FaultException<TDetail>: lineName is null.
FaultException<TDetail>: lineName does not refer to an existing line.
FaultException<TDetail>: stationType is null.
FaultException<TDetail>: stationName is null.
FaultException<TDetail>: A business logic error occurred.
CommunicationException: A communication error occurred.
TimeoutException: A communication timeout error occurred.

Table of Contents

Class PinpointServiceClient

Constructors

PinpointServiceClient(PinpointServiceClientOptions)

Parameters

Remarks

Exceptions

Methods

AddDatabase(string, bool)

Parameters

Exceptions

AddDatabaseAsync(string, bool)

Parameters

Returns

Exceptions

AddDefect3(string, int, string, string?)

Parameters

Returns

Exceptions

AddDefect3Async(string, int, string, string?)

Parameters

Returns

Remarks

Exceptions

AddRepair(string, int, int, string, string?)

Parameters

Returns

Exceptions

AddRepairAsync(string, int, int, string, string?)

Parameters

Returns

Remarks

Exceptions

AddTestResult(string, int, string, bool, string?, string?, IDictionary<string, string?>?)

Parameters

Returns

Exceptions

AddTestResult2(string, int, string, bool, string?, string?, string?)

Parameters

Returns

Exceptions

AddTestResult2Async(string, int, string, bool, string?, string?, string?)

Parameters

Returns

Remarks

Exceptions

AddTestResultAsync(string, int, string, bool, string?, string?, IDictionary<string, string?>?)

Parameters

Returns

Remarks

Exceptions

AuthenticateWorker(string, string?, string?)

Parameters

Returns

Remarks

Exceptions

AuthenticateWorker2(string, string?, string?)

Parameters

Returns

Remarks

Exceptions

AuthenticateWorker2Async(string, string?, string?)

Parameters

Returns

Remarks

Exceptions

AuthenticateWorkerAsync(string, string?, string?)

Parameters

Returns

Remarks

Exceptions

ChangeUnitNumbers(string, int, string?, string?, string?)

Parameters

Returns

Remarks

Exceptions

ChangeUnitNumbersAsync(string, int, string?, string?, string?)

Parameters

Returns

Remarks