Outputs tray, sack, or pallet tags for the specified presort.
This request outputs container tags to a text file.
This request outputs container tags to a text file for each batch of a batch presort.
{
"$schema":"http://json-schema.org/draft-04/schema#",
"title":"Container Tags",
"type":"object",
"properties":{
"addressTable":{
"title":"Address Table",
"description":"Group of records used for processing.",
"type":"string",
"pattern":"(?i)^([0-9]{10}|name\\$.+|file\\$[a-z]+)$"
},
"absoluteContainerNumbers":{
"title":"Absolute Container Numbers",
"description":"Uses continuous tag numbers (i.e, does not reset to 1 at the beginning of each stream).",
"default":false,
"type":"boolean"
},
"across":{
"title":"Across",
"description":"Number of tags across the page.",
"default":"",
"type":"integer"
},
"allBatches":{
"title":"All Batches",
"description":"Sequentially generates output (tags, reports, labels) for all saved presorts associated with the batch presort.",
"default":false,
"type":"boolean"
},
"collate":{
"title":"Collate",
"description":"Collates multiple copies.",
"default":false,
"type":"boolean"
},
"consecutiveBatchNumbers":{
"title":"Consecutive Batch Numbers",
"description":"Maintains the sequence number on the container tags across all batches in a Batch presort.",
"default":false,
"type":"boolean"
},
"containerPieceLimit":{
"title":"Container Piece Limit",
"description":"Specifies the number of pieces within a container to use as a threshold or ceiling.",
"default":null,
"type":"integer",
"minimum":0
},
"containerThreshold":{
"title":"Container Threshhold",
"description":"Specifies how the value specified for the Container Piece Limit command is interpreted. A value of true will treat the Container Piece Limit value as a threshold and a value of false will treat the Container Piece Limit value as a ceiling. The value DEFAULT is interpreted as true.",
"default":false,
"type":"boolean"
},
"copies":{
"title":"Copies",
"description":"Number of container tag copies.",
"default":0,
"type":"integer",
"minimum":0
},
"defOrder":{
"title":"Def Order",
"description":"Allows a custom DEFORDER.TXT file.",
"default":"",
"type":"string",
"pattern":"^.*\\.(txt)$"
},
"down":{
"title":"Down",
"description":"Number of tags down the page.",
"default":"",
"type":"integer"
},
"eInduction":{
"title":"E-Induction",
"description":"Flags whether 'EINDUCTION' will be printed on the pallet placard.",
"default":false,
"type":"boolean"
},
"fileName":{
"title":"File Name",
"description":"Path and filename for tags output to disk file.",
"default":"",
"type":"string"
},
"fileType":{
"title":"File Type",
"description":"File type for tags output to disk file.",
"default":"",
"type":"string",
"enum":[
"TEXT",
"DELIMITED",
"DBASE",
"PDF"
],
"enumValues":[
{
"value":"TEXT",
"displayValue":"Text",
"description":"Text"
},
{
"value":"DELIMITED",
"displayValue":"Delimited",
"description":"Delimited"
},
{
"value":"DBASE",
"displayValue":"DBASE",
"description":"DBASE"
},
{
"value":"PDF",
"displayValue":"PDF",
"description":"PDF"
}
]
},
"firstContainer":{
"title":"First Container",
"description":"Specifies the first container within the first stream selected. The DEFAULT value will select the first container within the first stream selected.",
"default":1,
"type":"integer",
"minimum":1
},
"fromPage":{
"title":"From Page",
"description":"First page from which to print tags.",
"default":1,
"type":"integer"
},
"headerLabel":{
"title":"Header Label",
"description":"Includes a header label as the first label.",
"default":false,
"type":"boolean"
},
"infoLine":{
"title":"Info Line",
"description":"Includes an information line as the last line of each tag.",
"default":false,
"type":"boolean"
},
"infoLineFormat":{
"title":"Info Line Format",
"description":"Determines whether the default or custom information line is used.",
"default":"",
"type":"string"
},
"infoLineFormat2":{
"title":"Info Line Format 2",
"description":"Determines if the second custom information line is used.",
"default":"",
"type":"string"
},
"labelHeight":{
"title":"Label height",
"description":"Distance from the top to the bottom edge of a label or tag.",
"default":0.0,
"type":"number"
},
"labelHorzPitch":{
"title":"Label horizontal pitch",
"description":"Distance from the right edge of a label to the right edge of the next tag across.",
"default":0.0,
"type":"number"
},
"labelWidth":{
"title":"Label width",
"description":"Distance from the right to the left edge of a label or tag.",
"default":0.0,
"type":"number"
},
"labelVertPitch":{
"title":"Label vertical pitch",
"description":"Distance from the top edge of a label to the top edge of next label down.",
"default":0.0,
"type":"number"
},
"lastContainer":{
"title":"Last Container",
"description":"Specifies the last container within the last stream selected. The DEFAULT value will select the last container within the last stream selected. The container number is with respect to the last stream selected.",
"default":null,
"type":"integer",
"minimum":1
},
"mailerID":{
"title":"Mailer ID",
"description":"Six or nine-digit number that identifies the mailer or subscriber, provided by the USPS. If it is 9 digits, it must start with a 9; if it is 6 digits, it cannot start with a 9.",
"default":"",
"type":"string",
"pattern":"^[0-8][0-9]{5}$|^[9][0-9]{8}$"
},
"mailerName":{
"title":"Mailer Name",
"description":"Mailer name and location.",
"default":"",
"type":"string"
},
"marginTop":{
"title":"Margin top",
"description":"Top margin for the page of tags. Units are in inches.",
"default":0.0,
"type":"number"
},
"marginLeft":{
"title":"Margin left",
"description":"Left margin for the page of tags. Units are in inches.",
"default":0.0,
"type":"number"
},
"newPageStream":{
"title":"New page stream",
"description":"Starts a new page at the beginning of each stream",
"default":true,
"type":"boolean"
},
"nonSimplifiedOnly":{
"title":"Non Simplified Only",
"description":"Includes only non-simplified containers. Valid only with ECR presorts.",
"default":false,
"type":"boolean"
},
"omitBarcodes":{
"title":"Omit Barcodes",
"description":"Does not print barcodes on container tags.",
"default":false,
"type":"boolean"
},
"orientation":{
"title":"Orientation",
"description":"Paper or tag stock orientation.",
"default":"PORTRAIT",
"type":"string",
"enum":[
"PORTRAIT",
"LANDSCAPE"
],
"enumValues":[
{
"value":"PORTRAIT",
"displayValue":"Portrait",
"description":"Portrait"
},
{
"value":"LANDSCAPE",
"displayValue":"Landscape",
"description":"Landscape"
}
]
},
"overwrite":{
"title":"Overwrite",
"description":"Overwrites existing file if the same filename is used.",
"default":true,
"type":"boolean"
},
"paperLength":{
"title":"Paper length",
"description":"Length of the paper for the page of labels or tags. Units are in inches.",
"default":0.0,
"type":"number"
},
"paperWidth":{
"title":"Paper width",
"description":"Width of the paper for the page of labels or tags. Units are in inches.",
"default":0.0,
"type":"number"
},
"presortName":{
"title":"Presort Name",
"description":"Name used for saving the presort.",
"default":"",
"type":"string"
},
"selfAdhesivePlacard":{
"title":"Self Adhesive Placards",
"description":"Prints the optional 4”x7” adhesive pallet placard.",
"default":false,
"type":"boolean"
},
"simplifiedOnly":{
"title":"Simplified Only",
"description":"Includes only simplified containers. Valid only with ECR presorts.",
"default":false,
"type":"boolean"
},
"streamList":{
"title":"Stream List",
"description":"Mail streams to use for the job. It is displayed as Stream, NDC, NDC Number. The stream name may be specified without a destination or with a destination and ZIP Code™. Additionally, any word of the stream name may be specified as ALL or omitted to indicate that all streams present in the presort, that match other specified criteria, should be selected. When using the command ALL;ALL ALL, presort streams will be processed in the order: Destination (alphabetical) / ZIP (3-digit followed by 5-digit) / Stream (by type).",
"default":"ALL;ALL ALL",
"type":"string"
},
"streamOrder":{
"title":"Stream Order",
"description":"Defines the order streams are output.",
"default":"",
"type":"string",
"enum":[
"CONTAINERS",
"DESTINATION",
"LASTSAVED",
"PIECES",
"STREAM",
"ZIP"
],
"enumValues":[
{
"value":"CONTAINERS",
"displayValue":"Containers",
"description":"Containers"
},
{
"value":"DESTINATION",
"displayValue":"Destination",
"description":"Destination"
},
{
"value":"LASTSAVED",
"displayValue":"Last Saved",
"description":"Last Saved"
},
{
"value":"PIECES",
"displayValue":"Pieces",
"description":"Pieces"
},
{
"value":"STREAM",
"displayValue":"Stream",
"description":"Stream"
},
{
"value":"ZIP",
"displayValue":"ZIP",
"description":"Order output in ZIP Code order"
}
]
},
"subset":{
"title":"Filter for creating a subset of the presort",
"description":"Creates a subset of the presorted items for Containers, Pallets, or Streams. Must be prefaced with a single character ((C)ontainers), (P)allets, (S)treams). Containers are either sacks or trays, Pallets are the physical pallets and streams are the presorted streams. May contain multiple values separated by commas. Each value must contain either an integer range specified as 'x-y', or a single integer. (i.e. 'P1-6,10' is pallets 1 thru 6, and 10) If specified the following commands will be ignored: firstContainer, lastContainer and streamList.",
"default":"",
"type":"string",
"pattern":"((C|P|S)\\d+(-\\d+)?(,\\d+(-\\d+)?)*|^$)"
},
"tagForEachPack":{
"title":"Tag for Each Pack",
"description":"Allows a container tag to be printed for each package in the container.",
"default":false,
"type":"boolean"
},
"tagType":{
"title":"Tag Type",
"description":"Defines container type for which the tags are used.",
"default":"",
"type":"string",
"enum":[
"SACK",
"IMTRAYLABEL",
"TRAY",
"PALLET",
"CRSLIP"
],
"enumValues":[
{
"value":"SACK",
"displayValue":"Sack",
"description":"Sack"
},
{
"value":"IMTRAYLABEL",
"displayValue":"IM Tray Label",
"description":"IM Tray Label"
},
{
"value":"TRAY",
"displayValue":"Tray",
"description":"Tray"
},
{
"value":"PALLET",
"displayValue":"Pallet",
"description":"Pallet"
},
{
"value":"CRSLIP",
"displayValue":"CR Slip",
"description":"CR Slip"
}
]
},
"toPage":{
"title":"To Page",
"description":"Last page for which to print tags.",
"default":1,
"type":"integer"
},
"useOriginForMailerLine":{
"title":"Use Origin For Mailer Line",
"description":"Populates the Mailer/Mailer Location line with city and state based on the origin ZIP Code of the presort If the value is set to “N”, the Mail/Mail Location line is populated with the specified or default value.",
"default":false,
"type":"boolean"
}
},
"required":[
"addressTable",
"fileName",
"fileType",
"presortName",
"tagType"
],
"additionalProperties":false
}
