//////////////////////////////////////////////////////////////////////////// // // // IBM LMO MAIL JOB MIF DEFINITION // // Version 1.2.0 // // // /////////////////////////////////////////////////////////////////////////// // // // This file specifies the MIF definition for the IBM LMO Mail Job // // Component. This file is based on the 1.2 draft version of the // // LMO Standards Specification and includes IBM Extensions. // /////////////////////////////////////////////////////////////////////////// start component name = "LMO Mail Job" description = "This component is used by Management" " Applications to manage attributes associated with LMO" " Mail Job processing. There are six attribute groups and" " tables defined in this component. They are: the" " ComponentID group, the Print Job Table, the Insert Job" " Table, the Bill of Materials Table, the Mailpiece" " XReference Table and the Mailpiece History Table." start path name = "DirectInterface" os2 = direct-interface end path //////////////////////////////////////////////////////////////////////////// // // // GLOBAL ENUMERATIONS // // // // Enumerations are MIF language block definitions that allow strings // // to be associated with signed 32-bit integers. They are primarily // // used by component instrumentation to pass integers through the DMI // // so that management applications can display the corresponding text // // string in the users native language. This section defines Named // // enumerations specified at the component level. These definitions // // are global to the component and may be referenced by name in // // attribute definitions that use them. // // The following are standard enumerations for CURRENT STATUS in // // the LMO Product and LMO Mail Job MIFs. // //////////////////////////////////////////////////////////////////////////// start enum name = "Status" type = integer 1 = "Other" 2 = "Unknown" // Host set // 10 = "Created" 11 = "Spooled" 12 = "Held" 13 = "Started" 14 = "Normal End" 15 = "Abnormal End" // Print set // 20 = "Printing" 21 = "Printed" 22 = "Reprinted" // Insert set // 30 = "Inserting" 31 = "Inserted" 32 = "Removed" 33 = "Diverted" 34 = "Mutilated" 35 = "Missing" 36 = "Recovered" // Manual set // 50 = "Quality" 51 = "Inventory" 55 = "Mailing" 56 = "Mailed" // LMO System set // 60 = "Reconciling" 61 = "Reconciled" // Customer extensions // // 1xxx = " " // // Vendor extensions // // 2xxx = " " // // IBM extensions // // 3xxx = " " // end enum /////////////////////////////////////////////////////////////////////////// // // // COMPONENT ID GROUP // // // // This is the DMTF REQUIRED group. // // // // // /////////////////////////////////////////////////////////////////////////// start group name = "ComponentID" id = 1 class = "DMTF|ComponentID|1.0" description = "This group defines attributes common to all components." " This group is required in all components and must have" " an ID set equal to 1." start attribute name = "Manufacturer" id = 1 description = "The name of the organization that produces" " this component." access = read-only storage = common type = string(64) value = "IBM" end attribute start attribute name = "Product" id = 2 description = "The name of this component or product." access = read-only storage = common type = string(64) value = "LMO Mail Job Component" end attribute start attribute name = "Version" id = 3 description = "The version string definition for this component." access = read-only storage = specific type = string(64) value = "1.2.0" end attribute start attribute name = "Serial Number" id = 4 description = "The serial number for this component." access = read-only storage = specific type = string(64) value = "unsupported" end attribute start attribute name = "Installation" id = 5 description = "The time and date of the last install of this" " component on this system." access = read-only storage = specific type = date value = "19951215000000.000000-000" // yyyymmddHHMMSS.uuuuuu+000 end attribute start attribute name = "Verify" id = 6 description = "Verification level for this component." " Asking for the verify attribute causes" " the component instrumentation code to" " perform checks to verify that the component" " is still in the system and working" " properly." access = read-only storage = common type = start enum name = "VerifyType" type = integer 0 = "An error occurred; Check status code" 1 = "Component does not exist" 2 = "Verify not supported" 4 = "Component exists, functionally untested" 5 = "Component exists, functionally unknown" 6 = "Component exists, functionally no good" 7 = "Component exists, functionally good" end enum value = 2 end attribute end group ///////////////////////////////////////////////////////////////////////// // // // PRINT JOB TABLE // // // // Print output from products is segmented into manageable units of // // work called Print Jobs. // // The Print Job table contains an entry for each print job // // describing its general characteristics, associated control objects, // // estimated and actual size, current state, and other pertinent // // management information. // ///////////////////////////////////////////////////////////////////////// start group name = "Print Job Table" id = 2 class = "IBM|Direct Print Job Table|1.2.0" description = "This group specifies the attributes that apply" " to the active print jobs in a LMO system." key = 1,2,3 start attribute name = "Product Name" id = 1 description = "The name of the product to which this" " print job entry applies." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Product Instance Qualifier" id = 2 description = "The Instance Qualifier for the name of the product" " associated with this print job entry. The combination" " of Product Name and Product Instance Qualifier is" " required to insure unique key access to table entries" " when multiple instances of a product are" " active in the system at the same time." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Print Job Name" id = 3 description = "The name of the print job assigned by the application." " This name is unique within the domain of print job" " names for a given product instance and may be used" " as a key to access a particular print job entry in" " the table." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Description" id = 4 description = "A text string describing a print job" " that is active in the system." access = read-write storage = specific type = displaystring(255) value = *"DirectInterface" end attribute start attribute name = "Required Media Name" id = 5 description = "The name of the required media or form to" " be used when printing this job." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Associated FormDef Name" id = 6 description = "The name of the FormDef object used to control the" " printing process for the print job. This name is" " captured at print time and later used by reprint" " components to re-establish the print environment" " before reprinting mutilated statements." access = read-write storage = specific type = displaystring(8) value = *"DirectInterface" end attribute start attribute name = "Associated PageDef Name" id = 7 description = "The name of the PageDef object used to format line" " data into pages for the print job. This name may" " be captured at print time and later used by reprint" " agent components to establish the print environment" " before reprinting mutilated statements. This" " attribute only applies to processing LINEMODE" " or MIXEDMODE print file formats." access = read-write storage = specific type = displaystring(8) value = *"DirectInterface" end attribute start attribute name = "Associated Job Ticket Name" id = 8 description = "The name of the Job Ticket used to control the" " inserting process for this print job. This name may" " also be used to re-establish the inserting environment" " before reprocessing mutilated mailpieces." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Associated Document Index Name" id = 9 description = "The name of the Document Index file to use to" " locate individual mailpiece pages within an" " archived print data set. This attribute is accessed" " by reprint components to retrieve pages of" " individual statements for reprinting of mutilated" " mailpieces." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Print File Name" id = 10 description = "The name of the file containing the print data" " for this print job. This attribute is used by" " print, archive, and reprint service processes" " that operate on mail job print data." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Print File Format" id = 11 description = "A text string specifying the document format of" " print data contained in the print file for this" " print job. ISO AFP values for this attribute are" " LINEDATA, MIXED, and MODCA. Other document format" " strings defined by ISO/DPA Standard 10175 should be" " used when appropriate." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "JES Assigned ID" id = 12 description = "A text string specifying the ID assigned by the" " Job Entry System or Print Manager when print files" " are submitted for spooling. This attribute is used" " to correlate release/hold and cancel requests for" " mail job printing by the print job spooler." access = read-write storage = specific type = displaystring(8) value = *"DirectInterface" end attribute start attribute name = "Date Created" id = 13 description = "The date and time that this print job" " was created and identified to the system." access = read-write storage = specific type = date value = *"DirectInterface" end attribute start attribute name = "Mail Job Size" id = 14 description = "An integer count of the number of mailpiece page" " groups contained within this print job." access = read-write storage = specific type = counter value = *"DirectInterface" end attribute start attribute name = "Print Job Size Unit" id = 15 description = "The unit of measure used to estimate and report on" " the size of this print job." access = read-write storage = specific type = start enum name = "Segment Size Unit" type = integer 1 = "Other" 2 = "Unknown" 3 = "Lines of Print" 4 = "Pages" 5 = "Mailpieces" end enum value = *"DirectInterface" end attribute start attribute name = "Estimated Print Job Size" id = 16 description = "The estimated size of this print job in Print Job" " Size Units. This attribute may be used by" " installations to schedule work for both printers" " and inserters of print data." access = read-write storage = specific type = integer value = *"DirectInterface" end attribute start attribute name = "Actual Print Job Size" id = 17 description = "The actual size of the print output produced by" " this print job expressed in Print Job Size Units." access = read-write storage = specific type = integer value = *"DirectInterface" end attribute start attribute name = "Current Device" id = 18 description = "The name of the current printer or inserter device" " that is processing the print output of this print" " job." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Current Status" id = 19 description = "The current status of this print job." access = read-write storage = specific type = "Status" value = *"DirectInterface" end attribute ///////////////////////////////////////////////////////////////////////// // The following two attributes are IBM extensions to the LMO // // Standards Specification. // ///////////////////////////////////////////////////////////////////////// start attribute name = "First Mailpiece Identifier" id = 3010 description = "The name of the first mailpiece in this print job." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Last Mailpiece Identifier" id = 3011 description = "The name of the last mailpiece in this print job." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute ///////////////////////////////////////////////////////////////////////// // The following attributes are IBM extensions to the LMO Standards // // Specification. // ///////////////////////////////////////////////////////////////////////// start attribute name = "Delete Row" id = 3998 description = "Delete a row in the table." access = read-write type = start enum name = "Deletetype" type = integer 0 = "False" 1 = "True" end enum value = *"DirectInterface" end attribute start attribute name = "Query" id = 3999 description = "Query information about keys." access = read-write storage = specific type = string(10) value = *"DirectInterface" end attribute end group ///////////////////////////////////////////////////////////////////////// // // // INSERT JOB TABLE // // // // The Insert Job table contains an entry for each active insert job // // in the LMO system. Insert jobs control finishing and inserting of // // physical materials into envelopes or containers for mailing and // // delivery. There may be one or more insert job definitions associa- // // ted with a given product. For example, machine setups, bill of // // materials and job ticket instructions can vary within a product for // // different postal classes of service or special accounts mailings - // // e.g., platinum card holder billings. Each entry in the table is a // // unique insert job specification. // ///////////////////////////////////////////////////////////////////////// start group name = "Insert Job Table" id = 3 class = "IBM|Direct Insert Job Table|1.2.0" description = "This group specifies the attributes that apply" " to the active insert jobs in an LMO system." key = 1,2,3 start attribute name = "Product Name" id = 1 description = "The name of the product associated with" " this insert job." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Product Instance Qualifier" id = 2 description = "The Instance Qualifier associated with the name of the" " product to which this insert job applies. The combination" " of Product Name and Product Instance Qualifier is" " required to insure unique key access to table entries" " when multiple instances of a product are" " active in the system at the same time." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Insert Job Name" id = 3 description = "The name assigned to this insert job. This name is" " unique within the domain of insert job names for a" " given product and is one of the keys used to access" " entries in the Insert Job Table." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Description" id = 4 description = "A free form text description of this insert job." " This description may be presented to operators and" " other users of the system by the LMO Graphical User" " Interface and other management applications." access = read-write storage = specific type = displaystring(255) value = *"DirectInterface" end attribute start attribute name = "Associated Job Ticket Name" id = 5 description = "The name of the Job Ticket used to control the" " inserting process for this insert job." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Date Created" id = 6 description = "The date and time that this insert job" " was created and identified to the system." access = read-write storage = specific type = date value = *"DirectInterface" end attribute start attribute name = "Insert Job Size Unit" id = 7 description = "The unit of measure used to estimate and report on" " the size of this insert job." access = read-write storage = specific type = start enum name = "Segment Size Unit" type = integer 1 = "Other" 2 = "Unknown" 4 = "Pages" 5 = "Mailpieces" end enum value = *"DirectInterface" end attribute start attribute name = "Estimated Insert Job Size" id = 8 description = "The estimated size of this insert job in Insert Job" " Size Units. This attribute may be used by" " installations to schedule work for inserters." access = read-write storage = specific type = integer value = *"DirectInterface" end attribute start attribute name = "Actual Insert Job Size" id = 9 description = "The actual size of the insert output produced by" " this insert job expressed in Insert Job Size Units." access = read-write storage = specific type = integer value = *"DirectInterface" end attribute start attribute name = "Current Device" id = 10 description = "The name of the current inserter device" " that is processing the print output for this insert" " job. This value only has" " meaning when the current status of the Insert Job" " is Inserting." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Current Status" id = 11 description = "The current status of this insert job." access = read-write storage = specific type = "Status" value = *"DirectInterface" end attribute ///////////////////////////////////////////////////////////////////////// // The following attributes are IBM extensions to the LMO Standards // // Specification. // ///////////////////////////////////////////////////////////////////////// start attribute name = "Delete Row" id = 3998 description = "Delete a row in the table." access = read-write type = start enum name = "Deletetype" type = integer 0 = "False" 1 = "True" end enum value = *"DirectInterface" end attribute start attribute name = "Query" id = 3999 description = "Query information about keys." access = read-write storage = specific type = string(10) value = *"DirectInterface" end attribute end group ///////////////////////////////////////////////////////////////////////// // // // BILL OF MATERIALS TABLE // // // // This table lists the bill of materials associated with insert jobs. // // Each entry in the table identifies a specific type of insert such // // as print output from a print job, call inserts setup by operators, // // or named media stock supplied from inventory. Multiple bill of // // material entries of the same or different types may be associated // // with a given insert job. // ///////////////////////////////////////////////////////////////////////// start group name = "Bill of Materials Table" id = 4 class = "IBM|Direct Process History Table|1.2.0" description = "A list of materials associated with insert" " jobs that are active in the system." key = 1,2,3,4 start attribute name = "Product Name" id = 1 description = "The name of the product associated with" " this bill of material entry." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Product Instance Qualifier" id = 2 description = "The Instance Qualifier for the name of the product" " associated with this bill of material entry." " The combination of" " Product Name and Product Instance Qualifier is" " required to insure unique key access to entries in" " the table when multiple instances of a product are" " active in the system at the same time." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Insert Job Name" id = 3 description = "The name of the insert job to which this bill of" " material entity is associated." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Material Name" id = 4 description = "The name of the material for the type of material" " referenced by Type. For example," " if the type is Print Job, then the value is a Print" " Job Name; if the type is Call Insert, then the" " value is the Call Name referenced by the vendor" " defined Job Ticket to accommodate late bindings, and" " if the type is Named Media, then the value is the" " name of preprinted media that possibly may be" " maintained in inventory." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Type" id = 5 description = "The type of material that is referenced by this" " bill of material entry." access = read-write storage = specific type = start enum name = "Insert Type" type = integer 1 = "Other" 2 = "Unknown" 3 = "Print Job" 4 = "Call Insert" 5 = "Named Media" 6 = "Envelope" end enum value = *"DirectInterface" end attribute start attribute name = "Description" id = 6 description = "A free form text description of this material" " insert in a form meaningful to inserter operators" " and management applications." access = read-write storage = specific type = displaystring(255) value = *"DirectInterface" end attribute ///////////////////////////////////////////////////////////////////////// // The following attributes are IBM extensions to the LMO Standards // // Specification. // ///////////////////////////////////////////////////////////////////////// start attribute name = "Number Required" id = 3001 description = "The amount of this material required for the insert job." access = read-write storage = specific type = integer value = *"DirectInterface" end attribute start attribute name = "Number Used" id = 3002 description = "The amount of this material used for the insert job." access = read-write storage = specific type = integer value = *"DirectInterface" end attribute start attribute name = "Delete Row" id = 3998 description = "Delete a row in the table." access = read-write type = start enum name = "Deletetype" type = integer 0 = "False" 1 = "True" end enum value = *"DirectInterface" end attribute start attribute name = "Query" id = 3999 description = "Query information about keys." access = read-write storage = specific type = string(10) value = *"DirectInterface" end attribute end group ///////////////////////////////////////////////////////////////////////// // // // MAILPIECE XREFERENCE TABLE // // // // This table provides a mapping of Mailpiece Identifiers to the // // Process Assigned Identifier, the Insert Job Name, or the Print // // Job Name for each mailpiece, to enable reprint and tracking. // ///////////////////////////////////////////////////////////////////////// start group name = "Mailpiece XReference Table" id = 5 class = "IBM|Direct Mailpiece XReference Table|1.2.0" description = "This table provides a cross" " reference index used by tracking" " and reprint agents to correlate" " mail piece identifiers to print" " job names. This table is optional" " depending on the document index" " formats chosen for archive and" " job ticket processing." key = 1,2,3 start attribute name = "Product Name" id = 1 description = "The name of the product associated with this" " mailpiece entry." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Product Instance Qualifier" id = 2 description = "The Instance Qualifier for the name of the product" " associated with this mailpiece entry." " The combination of Product Name and Product" " Instance Qualifier is required to insure unique" " key access to table entries when multiple instances" " of a product are active in the system at the same" " time." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Mailpiece Identifier" id = 3 description = "The name of the mailpiece assigned by the" " application. For example, an account number." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Process Assigned Identifier" id = 4 description = "A sequence number assigned to this mailpiece in" " the print job file as a result of performing" " a value add process; for example, presorting" " mailpiece data by zip code, walk sequence," " or traying sequence." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Print Job Name" id = 5 description = "The name of the print job that contains the print" " data associated with this mailpiece entry." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Insert Job Name" id = 6 description = "The name of the insert job that contains" " this mailpiece entry." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Mailpiece Size Unit" id = 7 description = "The unit of measure used to report on" " the size of a Mailpiece." access = read-write storage = specific type = start enum name = "Mailpiece Size Unit" type = integer 1 = "Other" 2 = "Unknown" 3 = "Lines of Print" 4 = "Pages" 5 = "Ounces" 6 = "Tenths of Ounces" 7 = "Pounds" 8 = "Grams" 9 = "Kilograms" end enum value = *"DirectInterface" end attribute start attribute name = "Mailpiece Size" id = 8 description = "The size of this mailpiece expressed" " in Mailpiece Size Units." access = read-write storage = specific type = integer value = *"DirectInterface" end attribute start attribute name = "Mailpiece Postage Unit" id = 9 description = "The unit of measure used to report on" " the size of a Mailpiece." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Mailpiece Postage" id = 10 description = "The amount of postage required to mail this" " mailpiece, expressed in Mailpiece Postage Units." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Current Status" id = 11 description = "The status of this mailpiece entry." access = read-write storage = specific type = "Status" value = *"DirectInterface" end attribute ///////////////////////////////////////////////////////////////////////// // The following attributes are IBM extensions to the LMO Standards // // Specification. // ///////////////////////////////////////////////////////////////////////// start attribute name = "Delete Row" id = 3998 description = "Delete a row in the table." access = read-write type = start enum name = "Deletetype" type = integer 0 = "False" 1 = "True" end enum value = *"DirectInterface" end attribute start attribute name = "Query" id = 3999 description = "Query information about keys." access = read-write storage = specific type = string(10) value = *"DirectInterface" end attribute end group ///////////////////////////////////////////////////////////////////////// // // // MAILPIECE HISTORY TABLE // // // // This table provides a history of Mailpieces as they proceed through // // the system. // ///////////////////////////////////////////////////////////////////////// start group name = "Mailpiece History Table" id = 6 class = "IBM|Direct Mailpiece History Table|1.2.0" description = "This table provides a history" " of Mailpieces as they proceed" " through the system." key = 1,2,3,4 start attribute name = "Product Name" id = 1 description = "The name of the product associated with this" " mailpiece entry." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Product Instance Qualifier" id = 2 description = "The Instance Qualifier for the name of the product" " associated with this mailpiece entry." " The combination of Product Name and Product" " Instance Qualifier is required to insure unique" " key access to table entries when multiple instances" " of a product are active in the system at the same" " time." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Mailpiece Identifier" id = 3 description = "The name of the mailpiece assigned by the" " application." access = read-write storage = specific type = displaystring(63) value = *"DirectInterface" end attribute start attribute name = "Time Stamp" id = 4 description = "The date and time that this row was placed in" " the table." access = read-write storage = specific type = date value = *"DirectInterface" end attribute start attribute name = "Current Status" id = 5 description = "The status of this mailpiece entry." access = read-write storage = specific type = "Status" value = *"DirectInterface" end attribute ///////////////////////////////////////////////////////////////////////// // The following attributes are IBM extensions to the LMO Standards // // Specification. // ///////////////////////////////////////////////////////////////////////// start attribute name = "Delete Row" id = 3998 description = "Delete a row in the table." access = read-write type = start enum name = "Deletetype" type = integer 0 = "False" 1 = "True" end enum value = *"DirectInterface" end attribute start attribute name = "Query" id = 3999 description = "Query information about keys." access = read-write storage = specific type = string(10) value = *"DirectInterface" end attribute end group end component