Enhanced Pad Staff Workstation

materialisticgumneckΗλεκτρονική - Συσκευές

27 Νοε 2013 (πριν από 3 χρόνια και 8 μήνες)

304 εμφανίσεις


________________________________
________________________________
_______________


3M Confidential Information.

In the event that this information is inadvertently disclosed, then
the following notice shall apply: Copyright© 3M 2009
-
2011

All Rights Reserved.



Enhanced Pad Staff Workstation

Software Development Kit
Application Programming Interface

TagService

void ConnectReader()

Activate the 3M RFID Reader. This will initiate a poll for the contents within the RFID Reader pad
RF field.

Calls to GetItems() w
ill not work unless ConnectReader is first called.

Possible Faults (Exceptions):



ReaderHardwareNotAvailableException



Reader hardware is not available; ensure the
hardware is connected and configured correctly.



FaultException


An unanticipated error has
occurred. Check the Enhanced Pad Staff
Workstation log files for additional details.

void DisconnectReader()

De
-
activate the 3M RFID reader. This will cause the RFID reader to stop polling for RFID tags.

This
should be done when the ILS is performing fu
nctions which do not involve the RFID reader.

Possible Faults (Exceptions):



FaultException


An unanticipated error has occurred. Check the Enhanced Pad Staff
Workstation log files for additional details.

Item[] GetItems()

Return an array of Item objects
. See the definition of Item below.

The Items are a representation
of what is on the pad based on how the RFID tags are programmed.

Possible Faults (Exceptions):



NotConnectedToReaderException



You are not connected to the reader. Call
ConnectReader() a
nd try again.



FaultException


An unanticipated error has occurred. Check the Enhanced Pad Staff
Workstation log files for additional details.


________________________________
________________________________
_______________


3M Confidential Information.

In the event that this information is inadvertently disclosed, then
the following notice shall apply: Copyright© 3M 2009
-
2011

All Rights Reserved.

bool IsConnected()

Ask the service if the 3M RFID pad is actively polling for RFID tags. Return value of true i
ndicates
that the 3M RFID reader pad is actively polling for RFID tags.

Possible Faults (Exceptions):



FaultException


An unanticipated error has occurred. Check the Enhanced Pad Staff
Workstation log files for additional details.

bool IsOnline()

Ask the
service if the 3M RFID reader pad is ready to be connected to. A return value of true
means that most likely the 3M RFID reader pad is functioning properly.

Possible Faults (Exceptions):



FaultException


An unanticipated error has occurred. Check the Enh
anced Pad Staff
Workstation log files for additional details.

void SetTagSecu
rit
y(string tagId, bool isSecured)

If the RFID tag supports a secure mode, this call will set the security setting on the specified tag
with the given tagId to secure if isSecured

is true and not secure otherwise.

Variable

Definition

tagId


Identifier of an RFID tag in the RF field of the 3M RFID reader. This value is
obtained through the ID field of the Tag object of the Item object. See the
Item and Tag definition below.

isSe
cured

Set to true to attempt to secure the specified RFID tag.


Possible Faults (Exceptions):



NotConnectedToReaderException



You are not connected to the reader. Call
ConnectReader() and try again.



TagNotFoundException



The specified tag could not be f
ound within range of the reader.



TagSecurityNotSupportedException



Security is not supported by the specified tag. This
may have to do with the tag itself, or the type of security currently configured (e.g. EAS vs
AFI ISO)


________________________________
________________________________
_______________


3M Confidential Information.

In the event that this information is inadvertently disclosed, then
the following notice shall apply: Copyright© 3M 2009
-
2011

All Rights Reserved.



InputValidationException



Inva
lid input was provided into the operation invocation.
Check the fault message and/or Enhanced Pad Staff Workstation log files.



FaultException


An unanticipated error has occurred. Check the Enhanced Pad Staff
Workstation log files for additional details
.


void WriteTag(Tag tag)

Write all the field
s

contained in the tag object to the RFID tag on the 3M RFID reader. The Tag
object contains the RFID tag identifier used to specify which unique tag to write the content to
during the write process.

Variable

D
efinition

tag


Object of type Tag (see definition below). This object can be found within
the Item object and fields can be changed and then written back to the
RFID tag


Possible Faults (Exceptions):



NotConnectedToReaderException



You are not connecte
d to the reader. Call
ConnectReader() and try again.



TagNotFoundException



The specified tag could not be found within range of the reader.



TagFormatNotProvidedException



The specified tag does not have its TagFormat set to a
valid value. See the list
of tag formats below.



InputValidationException



Invalid input was provided into the operation invocation.
Check the fault message and/or Enhanced Pad Staff Workstation log files.



FaultException


An unanticipated error has occurred. Check the Enhanced P
ad Staff
Workstation log files for additional details.

TagFormat[] GetTagFormats()

Return an array of TagFormat objects. See the definition of TagFormat below. The TagFormats
are a representation of the formats of tags the reader is configured to recogn
ize.

Possible Faults (Exceptions):



FaultException


An unanticipated error has occurred. Check the Enhanced Pad Staff
Workstation log files for additional details.


________________________________
________________________________
_______________


3M Confidential Information.

In the event that this information is inadvertently disclosed, then
the following notice shall apply: Copyright© 3M 2009
-
2011

All Rights Reserved.

Item

One or more tags make up an item. If there is more than one RFID tag making up an ite
m, then
that is a set, with each tag containing that tags place (SetNumber) within the total set (SetSize).

Each item has a descriptive identifier (Id) which identifies it within the ILS.

An item is considered
valid if it is a complete set and each tag w
ithin the set is properly programmed.

{

System.DateTime FirstSeen { set; get; }

String Id { set; get; }

ItemSecured IsSecured { set; get; }

bool IsValid { set; get; }

Tag[] Tags { set; get; }

ItemType? Type {set; get; }

}

ItemSecured

(Enumeration)

Val
ue

Description

No

No tag within the Item is secured

Partially

One or more tags but not all are secured

Yes

All tags within the Item are secured

ItemType

(Enumeration)

Value

Description

Blank

The presented RFID tag has not been
programmed.

Ignore

The
item has been actively set to be ignored.

Item

A library item asset.

Location

The tag present identifies a location.


________________________________
________________________________
_______________


3M Confidential Information.

In the event that this information is inadvertently disclosed, then
the following notice shall apply: Copyright© 3M 2009
-
2011

All Rights Reserved.

Person

The tag present identifies a person.

Task

The tag present identifies a task.

Equipment

The tag present identifies a piece of eq
uipment.

Other

The tag present identifies something other than
what has been listed here.

Unknown

The tag present indicates a usage that is
unknown.

Discard

The tag present indicates the item has been
discarded.

Tag

Representation for an RFID tag withi
n the RF field of the 3M RFID reader pad. Contained data will
vary depending on how the tag was programmed if it ever was.

{

TagField[] Fields { set; get; }

String Id { set; get; }

bool IsSecutirySupported { set; get; }

bool IsTagSecured { set; get; }

uin
t TagFormat { set; get; }

ItemType? Type { set; get; }

}

TagField

Key value pairs that vary depending on the format used to write to the tag. Each key value pair
contains a data type for use when casting the value object.

{

string Name { set; get; }

TagFi
eldType Type { set; get; }


________________________________
________________________________
_______________


3M Confidential Information.

In the event that this information is inadvertently disclosed, then
the following notice shall apply: Copyright© 3M 2009
-
2011

All Rights Reserved.

object Value { set; get; }

}

TagFieldType

(Enumeration)

Value

Description

Null

Null data type

String

S
tring data type

UnsignedInteger32

32 bit unsigned integer

data type


TagFormat

Provides detail on a format that the reader
can be configured to recognize.

{


string Description { get;

}


TagFieldFormat[] Fields { get; }


int Id { get;

}


bool IsEnabled

{ get;

}


MarketTypes Markets { get;

}


int Ordinal { get;
}


UsageTypes Usages { get;

}

}


________________________________
________________________________
_______________


3M Confidential Information.

In the event that this information is inadvertently disclosed, then
the following notice shall apply: Copyright© 3M 2009
-
2011

All Rights Reserved.

TagFieldFo
rmat

Provides detail on a field within a format that the reader can be configured to recognize.

{


string Description { get; }


bool HasValueDescription { get; }


int Id { get; }


string LongDescription { get; }


uint Maximum { get; }


ui
nt Minimum { get; }


string Name { get; }


TagFieldType Type { get; }

}

MarketTypes (Enumeration)

Value

Description

Library

Tag format is used in Library markets

TrackTrace

Tag format is used in 3M Track & Trace markets

UsageTypes (Enumeration)

V
alue

Description

All

Tag format is
can be used

for all usages

Blank

Tag format is
can be used
as a blank tag

Discard

Tag format can be used to indicate tag is
attached to a discarded item.

Equipment

Tag format can be used to identify equipment.

Ignore

Tag format is
can be used as
an ignore tag


________________________________
________________________________
_______________


3M Confidential Information.

In the event that this information is inadvertently disclosed, then
the following notice shall apply: Copyright© 3M 2009
-
2011

All Rights Reserved.

Item

Tag format is
can be used
as an item tag

Location

Tag format is
can be used
as a location tag

Other

Tag format can be used to indicate a usage
other than the ones explicitly listed here.
(custom)

Person

Tag format is
can be used
as a person (patron)
tag

Task

Tag format is
can be used
as a task tag

Unknown

Tag format can be used to indicate the usage is
unknown.



________________________________
________________________________
_______________


3M Confidential Information.

In the event that this information is inadvertently disclosed, then
the following notice shall apply: Copyright© 3M 2009
-
2011

All Rights Reserved.

Tag Formats

Note: this is not an exhaustive list. New formats can be added through additi
onal installations.

Format ID

Name

3

3M Numeric Item

4

3M Alphanumeric Item

5

3M General Purpose Item

85

3M Manufacturing Blank

86

Generic Blank

255

3M Ignore Tag

512

French Numeric Item

513

French Alphanumeric Item

544

Dutch Object ID Item

545

D
utch Barcode Item

640

Danish Item

641

Finnish Item

768

ISO
-
28560


p慲琠2


佢橥O琠敮eod楮g

769

䥓I
-
28560


p慲琠3


䙩硥d 敮捯d楮g