API

IRIS contains many command-line scripts, graphical user interfaces (GUIs), Java interfaces, web interfaces, and web services. The following is a list of APIs:

Command-line scripts
Graphical user interfaces (GUIs)
Message interfaces
Web interfaces
Web services
Deprecated web services

Command-line scripts

Script Name	Component	Description
config.sh	Configuration	Silently configures or unconfigures the computer.
configureMQ.sh	Configuration	Configures WebSphere MQ on a local or remote system to use IRIS if using non-clustered WebSphere MQ queue managers.
configureMQHA.sh	Configuration	Configures IRIS and WebSphere MQ (cluster) to use a local or remote WebSphere MQ system.
configureTS.properties	Configuration	Specifies the parameters and values that the configuration script uses during silent configuration.
configureWAS.sh	Configuration	Configures IBM WebSphere Application Server.
deleteSNMData.sh	Serial Number Management application	Deletes all Serial Number Management application-related data from the system.
deployMetadata.sh	Metadata	Deploys the metadata-based schema to the database.
encryptOnce.sh	Configuration	Generates encrypted b5 passwords for WebSphere MQ and the database. Prompts users to enter the password to encrypt.
exportMasterdata.sh	Master data manager	Exports master data.
exportTSAR.sh	IRIS	Exports a complete set of artifacts from an IRIS system to an IRIS archive (TSAR) file.
importAddTSAR.sh	IRIS	Imports a set of artifacts from an IRIS archive (TSAR) file and adds them to currently deployed artifacts.
importMasterdata.sh	Master data manager	Inserts or updates master data from an external XML file into the database.
importReplaceTSAR.sh	IRIS	Imports a complete set of artifacts from an IRIS archive (TSAR) file and replaces the artifacts that have already been deployed.
recreateAS2MQ.sh	IRIS	Recreates the WebSphere MQ queues on the MQ server that are used for Applicability Statement 2 (AS2); recreates the corresponding JMS resources in the IBM WebSphere Application Server Administrative Console.
revokeDBAPrivileges.sh	IRIS	Revokes the database administrator (DBA) privileges of the user that is specified in the userID parameter in the RFIDICServer.xml file.
updateWebServicesBindings.sh	Configuration	Configures the security credentials for internal user interface web service calls.
simpleEventQuery.sh	IRIS	Displays the events that are stored in the database.
startTS.sh	IRIS	Starts one or more of the IRIS products.
stopTS.sh	IRIS	Stops one or more of the products in the IRIS.
submitEvent.sh	Events	Reads events from the file system; submits those events to either the WebSphere MQ message queue or to the HTTP Capture binding interface; resubmits events that are written to the RFID_HOME/logs file because of a system error.
tsEnv.sh	Configuration	Sets the environment variables that are required for running configuration scripts.

Graphical user interfaces (GUIs)

Name (how to access)	Component	Description
Web user interface	IRIS	Displays and allows users to work with events, master data, security policies, alert subscriptions, and reports; manages the locale and time zone.
WebSphere Application Server Administration Console user interface	IRIS	Manages the applications and performs system administration tasks for the IBM WebSphere Application Server environment; runs in the web browser.

Message interfaces

Name (how to access)	Component	Description
Event capture	Event capture	Reads and processes EPCIS events and stores these events in an XML column in the IRIS database.

Web interfaces

Name (how to access)	Component	Description
HTTP capture binding interface	Event capture	Sends events to IRIS by using HTTP.

Web services

Name (how to access)	Component	Description
Alerts registry	Alerts	Registers and manages alerts.
Containment	Track and Trace	Retrieves serialized instances that have a parent-child relationship in which the parent instance contains the child instance.
Delivery methods registry	Alerts	Manages delivery methods.
EPCIS query	IRIS	Provides an end point to which a third party can connect and query the data.
Master data management	Master data manager	Imports and exports the master data for IRIS.
Solution answer query	IRIS	Customizes queries to meet the solution-specific requirements.
Notification configurations registry	Alerts	Manages notification configurations.
Security Policy	Security	Imports and exports security policies.
Policy management	Serial Number Management application	Creates, updates, deletes, export, and imports serial number policies.
Resource management	Serial Number Management application	Creates, exports, and imports resources.
Rule management	Serial Number Management application	Creates, updates, gets rule priority, sets rule priority, exports, and imports serial number rules.
Tag management	Serial Number Management application	Requests and receives serial numbers, confirms the receipt of serial numbers, returns the serial numbers that are not required.
Subscription registry	Alerts	Manages subscriptions to alerts.
Track and Trace	Track and Trace	Retrieves transaction and packaging information about items in the supply chain.

Deprecated web services

Name (how to access)	Component	Description
SSCC resource management service	Serial Number Management application	Creates, enables, and manages SSCC resources.
SSCC tag management service	Serial Number Management application	Creates unique electronic product codes (EPCs) for items.
SGTIN resource management service	Serial Number Management application	Creates, enables, and manages SGTIN resources.
SGTIN tag management service	Serial Number Management application	Creates unique electronic product codes (EPCs) for items.

Last Updated March 03, 2014