Home

IRIS Automation

Execution Modes

There are several ways to execute IRIS. Each execution mode listed below provides a different level of automation.

Interactive mode: IRIS

The program starts and presents a main "ribbon" with menus and speedbuttons. The user manually interacts with the program to build, organize, and transmit transactions.


Command-line mode: IRIS [/HOLDERID:{HolderID}]   [/QUEUE]   [/JUSTRECV]   [/NOMAIL]    [{TransactionSpecifier}   {DetailFilename}   [{Argument1}   [{Argument2}]...]]    [/ESI:{ESIFilename}]

The program starts and automatically conditions {DetailFilename} using {TransactionSpecifier}, {Argument1}, {Argument2}, etc. (if present). To skip an argument that is not required, use a single underscore character (_).

{DetailFilename} must be the absolute path and filename of the file to condition and send.

/HOLDERID:{HolderID} is optional, and specifies a holder ID to use for this transaction/connection which is different than the primary one in System Parameters. Its presence causes IRIS to switch personalities. This is useful for merchants who have multiple accounts, or warehouses which send transactions for two or more separate warehouse IDs. Example: /HOLDERID:M123456

If the /QUEUE parameter is specified, the transaction(s) will be added to the "Pending Transactions" list, but communications will not be initiated. This is used when you want to accumulate transactions throughout the day, and then send them to the provider system all at once. If /QUEUE is not specified, communication with the provider system is initiated.

The /JUSTRECV parameter is used to make IRIS call the provider system and just receive mail (detail confirmations) without sending any transactions.

If the /NOMAIL parameter is specified, the holder's mailbox will not be checked (for detail confirmations) while connected. This basically turns the process into a "send-only" session. Normally (without /NOMAIL specified), IRIS will check for mail and receive any that is waiting.

/ESI:{ESIFilename} is only used for shipping order transactions (shipping orders, early shipping orders, sample orders, and block shipping orders), and is optional. ESI stands for Extended Shipping Instructions. {ESIFilename} is the absolute path and filename of a text file containing free-form instructions. The file can also have formatted instructions that conform to the "SO Instructions" specification (DI records) published by EWR, Inc. for shipping order transactions.

Example:   IRIS   XFR   c:\myfiles\recap.txt   M123456


Response-file mode: IRIS [/HOLDERID:{HolderID}]   [/QUEUE]   [/NOMAIL]   @{ResponseFilename}

Same as command-line mode, but {ResponseFilename} is assumed to be the absolute path and filename of a response file. The response file is a text file of IRIS parameter sets (as described above in the command-line mode), one per line, each line separated by carriage return and line feed.

Dependent transactions: since a response file can contain multiple transactions, any given transaction can be marked as "dependent" upon its preceding transaction. This will cause IRIS to wait for positive acknowledgement for the preceding transaction before sending the dependent transaction. To do this, simply add the /DEPENDENT flag to the end of the transaction line.

If the /HOLDERID:{HolderID} parameter is specified on the first line of the response file, then it is treated as if it appeared on the command line.

Example:   IRIS   @c:\myfiles\autoewr.rsp

where autoewr.rsp contains:

LDP   popthese.txt
XFR   recap1.txt   M123456   9464   /DEPENDENT
XFR   poolbales.txt   Z998877   BP1


Fully-conditioned file mode: IRIS [/HOLDERID:{HolderID}]   [/QUEUE]   [/NOMAIL]   %{TransmissionFilename}

{TransmissionFilename} is the absolute path and filename of a fully-conditioned file. The program starts and communication with the provider system is initiated to send {TransmissionFilename}.

Example:   IRIS   %c:\myfiles\manytran.txt


Transaction Specifiers and Arguments

Every transaction that is fed to IRIS is described by a three-letter Transaction Specifier. Most transactions also require 1 or more arguments, and a detail file of bale records. This document explains the Transaction Specifiers and arguments. Detail file specifications can be found on the EWR, Inc. website.

Transaction Specifiers defined (click one to see its arguments):

CRTCreate individual bale receipts
CTFCreate certificated bale receipts
CRBCreate block receipts
 
UPDUpdate/correct individual receipts
UPLUpdate/correct individual receipt locations
UPCUpdate/correct certificated receipts
UDBUpdate/correct block receipts
 
CNLCancel receipts
CNNCancel non-negotiable block receipts
CNBCancel negotiable block receipts
UNCUncancel receipts
 
WEIWarehouse Electronic Invoice
 
CCCPlace EWRs in CCC loan
CLTPlace EWRs in CCC loan (electronically redeemable)
LDPRequest LDP
 
URDUpdate "cargo" receipt data (gins)
UXRUpdate "cargo" receipt data (gins) and transfer
CXRUpdate classing (gins) and transfer
CLXUpdate classing (gins) and transfer loan options
UXCUpdate (gins), add classing, and transfer
UCLUpdate (gins), add classing, and transfer loan options
 
XFRTransfer EWRs to another holder
XFBTransfer EWRs to another holder via bank draft
XLETransfer CCC loan equity to another holder
XBRTransfer block EWRs to another holder
 
SHPShipping Order
ESOEarly Shipping Order
SAMSample Order
SHBBlock EWR Shipping Order
SDCSchedule Date Change request
RRQLoan Redemption Order
 
HBRHolder bale report, specific bales
HRQHolder bale report, all bales
WBRWarehouse reconciliation report
WLRWarehouse loan bales report
 
CWWWorld Cotton: Create Individual Receipts
CWTWorld Cotton: Create Container Receipts
UPWWorld Cotton: Update/correct World Receipts
VCGWorld Cotton: Verify Container Group
CNTWorld Cotton: Cancel Container Group
SHWWorld Cotton: Shipping Order
RCGWorld Cotton: Request Container Group
XCRWorld Cotton: Transfer Container Group
UNTWorld Cotton: Uncancel Container Group
 

Definitions of the transaction arguments (an argument that is not required can be skipped by supplying a single underscore character (_) in its place)

CRT   (no arguments)

CTF   (no arguments)

CRB   (no arguments)

UPD   (no arguments)

UPL   (no arguments)

UPC   (no arguments)

UDB   (no arguments)

CNL   [{Marks}]
{Marks} is an optional alphanumeric entry which will show up on the confirmations. Maximum length is 8 characters.

CNN   [{Marks}]
{Marks} is an optional alphanumeric entry which will show up on the confirmations. Maximum length is 8 characters.

CNB   [{Marks}]
{Marks} is an optional alphanumeric entry which will show up on the confirmations. Maximum length is 8 characters.

UNC   [{BlockFlag}]
{BlockFlag} optional Y/N flag indicating whether the receipts to be cancelled are block receipts.

WEI   {HolderID}
{HolderID} is the holder ID of the person or company to which you want to send the invoice. This would normally be the shipper of the order to which the invoice applies.

CCC   {ProducerName}
{ProducerName} is the name of the producer who grew the crop. This should be recognizably similar to the name the ASCS office has on file for the given farm. A maximum of six words can be present in the name. The maximum size of the name is 40 characters.

CLT   {StateCode}   {CountyCode}   {LoanNumber}   {LoanDate}
{StateCode} State code of the CMA/LSA.
{CountyCode} County code of the CMA/LSA.
{LoanNumber} Assigned by the CMA/LSA.
{LoanDate} Assigned by the CMA/LSA. The format is MM/DD/YY, MMDDYYYY, or MM/DD/YYYY.

LDP   {FarmNumber}   {ProducerName}
{FarmNumber} is the ASCS farm number (not including the state and county codes) for the following bale list (separate CCC transactions must be made for each farm).
{ProducerName} is the name of the producer who grew the crop. This should be recognizably similar to the name the ASCS office has on file for the given farm.

URD   (no arguments)

UXR   (no arguments)

CXR   (no arguments)

CLX   (no arguments)

UXC   (no arguments)

UCL   (no arguments)

XFR   {NewHolderID}   [{Reference#}]   [{CertFlag}]   [{LoanReconFlag}]   [{WorldFlag}]
{NewHolderID} is the holder ID of the person or company to which title should be transferred.
{Reference#} is an optional reference number which will show up on the confirmations. It is intended to be used as an invoice number or purchase order number. If you are trying to transfer EWRs that have a collateral agent on them, this number is required and is used by the bank to release the collateral by reference number.
{CertFlag} optional Y/N flag indicating whether the receipts to be transferred are certificated.
{LoanReconFlag} optional Y/N flag indicating whether this is a transfer of Loan Recon receipts from the warehouse back to the shipper.
{WorldFlag} optional Y/N flag indicating whether the receipts to be transferred are World receipts.

XFB   {NewHolderID}   {BankHolderID}   {Reference#}   {$Amount}   [{CertFlag}]   [{BlockFlag}]
{NewHolderID} is the holder ID of the person or company to which title should be transferred after the bank draft goes through.
{BankHolderID} is the holder ID of the bank which is going to perform the "envelope transfer."
{Reference#} is a reference number which will show up on the confirmations and will be used by the bank to eventually transfer the EWRs to the buyer.
{$Amount} is the dollar amount that the bank should transfer into your account (include the decimal point, maximum 99999999.99).
{CertFlag} optional Y/N flag indicating whether the receipts to be transferred are certificated.
{BlockFlag} optional Y/N flag indicating whether the receipts to be transferred are block receipts.

XLE   {NewHolderID}
{NewHolderID} is the holder ID of the person or company to which title of the CCC loan equities should be transferred. This changes the EquityHolder of the EWRs while maintaining CCC as the "Holder." When CCC releases the receipts, {NewHolderID} will be the free-and-clear holder.

XBR   {NewHolderID}   [{Reference#}]
{NewHolderID} is the holder ID of the person or company to which title should be transferred.
{Reference#} is an optional reference number which will show up on the confirmations. It is intended to be used as an invoice number or purchase order number. If you are trying to transfer EWRs that have a collateral agent on them, this number is required and is used by the bank to release the collateral by reference number.

SHP  {WarehouseID}   {ShippingOrder#}   {Marks}   [{RequestDate}]   [{ShippingRequirements}]    [{PrevESOFlag}]   [{LoanReconFlag}]   [{DestWh}]
{WarehouseID} The 6-digit warehouse ID of the receipts in this transaction.
{ShippingOrder#} is a reference number which will show up on the confirmations. It is intended to be used as a shipping order number. If you are trying to place a shipping order for EWRs that have a collateral agent on them, this number is used by the bank to release the collateral by shipping order number.
{Marks} is an alphanumeric entry which will show up on the confirmations. Maximum length is 8 characters.
{RequestDate} optional date by which the shipping order is requested to be ready.
{ShippingRequirements} optional Y/N flags indicating if each of the following are required: mark all bales, reweigh all bales, ship samples with order, phytosanitary certificate, fumigation, paper tag list with order. All six of these flags are concatenated together into one word, e.g. YNYNYN
{PrevESOFlag} optional Y/N flag indicating if a previous early shipping order was issued for this order.
{LoanReconFlag} optional Y/N flag indicating that the receipts in this transaction are for Loan Recon bales.
{DestWh} optional destination warehouse ID. Only used if {LoanReconFlag} is Y.

ESO  {WarehouseID}   {ShippingOrder#}   {Marks}   [{RequestDate}]   [{ShippingRequirements}]    [{BlockFlag}]
{WarehouseID} The 6-digit warehouse ID of the receipts in this transaction.
{ShippingOrder#} is an optional reference number which will show up on the confirmations. It is intended to be used as a shipping order number. If you are trying to place a shipping order for EWRs that have a collateral agent on them, this number is required and is used by the bank to release the collateral by shipping order number.
{Marks} is an alphanumeric entry which will show up on the confirmations. Maximum length is 8 characters.
{RequestDate} optional date by which the shipping order is requested to be ready.
{ShippingRequirements} optional Y/N flags indicating if each of the following are required: mark all bales, reweigh all bales, ship samples with order, phytosanitary certificate, fumigation, paper tag list with order.
{BlockFlag} optional Y/N flag indicating if the receipts in this transaction are block receipts.

SAM   {WarehouseID}
{WarehouseID} The 6-digit warehouse ID of the receipts in this transaction.

SHB   {WarehouseID}   {ShippingOrder#}   {Marks}   [{RequestDate}]   [{ShippingRequirements}]    [{PrevESOFlag}]
{WarehouseID} The 6-digit warehouse ID of the receipts in this transaction.
{ShippingOrder#} is an optional reference number which will show up on the confirmations. It is intended to be used as a shipping order number. If you are trying to place a shipping order for EWRs that have a collateral agent on them, this number is required and is used by the bank to release the collateral by shipping order number.
{Marks} is an alphanumeric entry which will show up on the confirmations. Maximum length is 8 characters.
{RequestDate} optional date by which the shipping order is requested to be ready.
{ShippingRequirements} optional Y/N flags indicating if each of the following are required: mark all bales, reweigh all bales, ship samples with order, phytosanitary certificate, fumigation, paper tag list with order. All six of these flags are concatenated together into one word, e.g. YNYNYN
{PrevESOFlag} optional Y/N flag indicating if a previous early shipping order was issued for this order.

SDC   (no arguments)

RRQ   {RedeemDate}   {EMail}
{RedeemDate} date on which the receipts should be redeemed.
{EMail} your email address, for CMA/LSA confirmation.

HBR   {ReportMode}   [{BlockFlag}]
{ReportMode} is one of the following single letters: H - Holder, S - Subholder, E - either.
{BlockFlag} optional Y/N flag indicating whether the report should contain block receipts instead of individual receipts.

HRQ   {ReportMode}   [{BlockFlag}]   [{ReportFilter}   {ReportFilterValue}]
{ReportMode} One of the following single letters: H - Holder, S - Subholder, E - either.
{BlockFlag} optional Y/N flag indicating whether the report should contain block receipts instead of individual receipts.
{ReportFilter} is one of the following single letters, used to specify a filter type for the report: A - no filter, C - Crop Year, D - Draft Number, G - Gin ID, H - Current Holder, I - Invoice Number, L - CCC Loan Number, O - Purchase Order Number, P - Previous Holder ID, R - StaplCtn Grower Reference #, S - Subholder ID, W - Warehouse ID, Z - Shipping Order Number.
{ReportFilterValue} Value of the field specified by {ReportFilter} on which receipts should match to qualify for the report.

WBR   (no arguments)

WLR   (no arguments)


---World Cotton transactions---

CWW   (no arguments)

CWT   (no arguments)

UPW   (no arguments)

VCG  {EWRContainerID}   {Lot#}   {ContainerMark}   [{NewHolderID}]
{EWRContainerID} Container ID that was assigned in the Request Container Group transaction.
{Lot#} Lot # assigned by ICE.
{ContainerMark} Mark to be physically placed on the container. Maximum length is 12 characters.
{NewHolderID} is the holder ID of the person or company to which title should be transferred.

CNT   (no arguments)

SHW  {WarehouseID}   {ShippingOrder#}   {Marks}    [{DecertFlag}]   [{RequestDate}]   [{ShippingRequirements}]   [{CertTransferDestinationWh}]
{WarehouseID} The 6-digit warehouse ID of the receipts in this transaction.
{ShippingOrder#} is a reference number which will show up on the confirmations. It is intended to be used as a shipping order number.
{Marks} is an alphanumeric entry which will show up on the confirmations. Maximum length is 8 characters.
{DecertFlag} Y to decert all bales, or T to keep them certificated for transfer to another warehouse.
{RequestDate} optional date by which the shipping order is requested to be ready.
{ShippingRequirements} optional Y/N flags indicating if each of the following are required: mark all bales, reweigh all bales, ship samples with order, phytosanitary certificate, fumigation, paper tag list with order. All six of these flags are concatenated together into one word, e.g. YNYNYN
{CertTransferDestinationWh} optional destination warehouse ID. Only used for Cert Transfers.

RCG  {WarehouseID}   [{ContainerMark}]   [{PurchaseOrder#}]   [{Invoice#}]  [{DisolveFlag}]  [{CertFlag}]  [{ContainerID}]
{WarehouseID} The 6-digit warehouse ID of the receipts in this transaction.
{ContainerMark} Mark to be physically placed on the container. Maximum length is 12 characters.
{PurchaseOrder#} is an optional reference number which will show up on the confirmations.
{Invoice#} is an optional reference number which will show up on the confirmations.
{DisolveFlag} optional Y/N flag indicating if the container should be disolved instead of created.
{CertFlag} optional Y/N flag indicating if this container request is the second half of a Cert Transfer.
{ContainerID} optional container ID if this request is the second half of a Cert Transfer.

XCR  {NewHolderID}  [{DisolveFlag}]
{NewHolderID} is the holder ID of the person or company to which title should be transferred.
{DisolveFlag} optional Y/N flag indicating if the transfer should disolve a container first.

UNT   (no arguments)

2016 EWR, Inc. All rights reserved.   Privacy Policy