Application object

Table 1. Attributes for the application object
Name Description DataType Required Default value Possible values Updateable
name Name of the application nameString Yes  
  • Application name
  • "_ALL"
 Yes
description Description of the application descString No ""   Yes
appGroup The application group that this application belongs to nameString Yes     No
identifier The application group identifier dbString2 Yes "" Determined by the application group Yes
dataType The data type of this application appTypeString No
  • "AFP"
  • "SCS"
  • "AFP"
  • "Line"
  • "BMP"
  • "GIF"
  • "PCX"
  • "TIFF"
  • "PDF"
  • "JPEG"
  • "PNG"
  • "User Defined"
  • "OD Defined"
  • "E-Mail"
  • "None"
  • "SCS"
  • SCS-Extended
  • Global DJDE
 No
indexer The name of the indexer program to use with this application indexerString No "None"
  • "None"
  • "ACIF"
  • "Generic"
  • "PDF"
  • OS/390®
  • OS/400®
 Yes
dataCompression The compression technique that is used for the data compressionString No "OD77"
  • "OD77"
  • "LZW12"
  • "LZW16"
  • "Disable"
  • "None"
 Yes
resCompression The compression technique that is used for the resources compressionString No "OD77"
  • "OD77"
  • "LZW12"
  • "LZW16"
  • "Disable"
  • "None"
 Yes
resourceComparison The number of resource comparisons resCompValue No 50 0–9999 Yes
largeObject Whether this application a Large Object yesnoString No "No"
  • "Yes"
  • "No"
 Yes
size The number of pages or size of the object in kilobytes that is based on the setting of the largeObject attribute Integer No 100 Positive integer representing either object size or number of pages based on setting of largeObject Yes
pageIdentifiers Whether page identifiers should be used yesnoString No "No"
  • "Yes"
  • "No"
 Yes
postProcesserString The post processor string postProcString No ""   Yes
printAmount The default print option to specify which page or pages to print printAmString No "All Pages"
  • "All Pages"
  • "Current Pages"
 Yes
defaultPrinter Default printer nameString No "*NONE"   Yes
cicsJCLParms Values that are used by the CICS® or ESA client program to print documents string No "None"   Yes
printParms Print parameters that are used by the server print manager string No ""   Yes
afpToLine Options that OnDemand uses to convert AFP data to line data string No ""   Yes
usePreview Whether to use the preview user exit yesnoString No "No"
  • "Yes"
  • "No"
 Yes
previewParms Whether the preview parameters should be used string No ""   Yes
agQueryName Name of the application group that has all the applications you want to export. When you specify agQueryName during export, the values for the name and appGroup attributes are ignored. If you specify agQueryName, you cannot specify folderQueryName. string No ""   No
folderQueryName Name of folder that has the applications you want to export. When you specify folderQueryName during export, the values for the name and appGroup attributes are ignored. If you specify folderQueryName, you cannot specify agQueryName. string No ""   No
Note:
  1. If the application group contains more than one field object, identifier is required.
  2. The identifier object can be updated to an unused field value only.
Table 2. Child objects under the application object
Name Minimum number Maximum number Deleteable Updateable
lineData 0 1 No Yes
SCSData 0 1 No Yes
afpData 0 1 No Yes
pdfData 0 1 No Yes
imageData 0 1 No Yes
udData 0 1 No Yes
indexParm 0 1 Yes Yes
preprocessParm 0 Dependent No Yes
imageOverlay 0 Unbounded Yes No
Important: The udData child is required if the application dataType is User Defined.
Table 3. Attributes for the SCSData object under the application object
Attributes Description DataType Required Default value Possible values Updateable
codePage The code page to use Integer No 37 Nonnegative integer Yes
prMode Processing Mode prmodeString No "None"
  • "None"
  • "SOSI1"
  • "SOSI2"
  • "SOSI3"
 Yes
Table 4. Child objects under the SCSData object
Name Minimum number Maximum number Deleteable Updateable
lvHeader 0 1 No Yes
lvField 0 30 Yes Yes
logView 0 20 Yes Yes

See Table 10, Table 11, and Table 12 for descriptions of the lvHeader, lvField, and logView objects.

Table 5. Attributes for the SCSExData object under the application object
Attributes Description DataType Required Default value Possible values Updateable
codePage The code page to use Integer No 37 Nonnegative integer Yes
orientation The orientation or rotation angle, in degrees, of the document orientString No 0
  • 0
  • 90
  • 180
  • 270
 Yes
paperSize The output paper size paperString No "Autosize" See the list that follows this table for possible values for the paperSize attribute. Yes
Possible values for the paperSize attribute are:
  • A3
  • A4 Wide
  • A4
  • A5
  • Autosize
  • B4 Wide
  • B4
  • B5
  • Cut Sheet
  • Euro Fanfold
  • Executive 1
  • Executive 2
  • Executive 3
  • Folio
  • Ledger
  • Legal Wide
  • Legal
  • Letter Wide
  • Letter
  • Narrow
  • Quarto
  • Short
  • Statement
  • Stationery
  • Tabloid
  • Wide
  • 1403W
  • 1403WS
  • 3800N
  • 3800NS
  • 3800W
  • 3800WS
Table 6. Child object under the SCSExData object
Name Minimum number Maximum number Deleteable Updateable
logView 0 20 Yes Yes
Table 7. Attributes for the logView object under the SCSExData object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
  • "update"
 N/A
name Name of this logical view nameString Yes     Yes
user User for this logical view nameString Yes  
  • User name
  • "*PUBLIC"
 No
defaultView Whether this is the default view yesnoString No "No"
  • "Yes"
  • "No"
 Yes
zoom Zoom Factor Integer No 100 Positive integer Yes
selAreaColor Selected Area Color saColorString No "Yellow"
  • "White"
  • "Black"
  • "Red"
  • "Blue"
  • "Green"
  • "Yellow"
  • "Grey"
  • "Custom"
 Yes
bgColor Background bgColorString No "White"
  • "White"
  • "Black"
  • "Red"
  • "Blue"
  • "Green"
  • "Yellow"
  • "Grey"
  • "Green Bar"
  • "Custom"
 Yes
Table 8. Attributes for the lineData object
Attributes Description DataType Required Default value Possible values Updateable
lineCount The line count Integer No 0 Nonnegative integer Yes
codePage The code page to use Integer No 500 Positive integer Yes
recFM The record format recfmString No "Variable"
  • "Fixed"
  • "Variable"
  • "Stream"
 Yes
LRECL The record length Integer No 133 Positive integer Yes
delimiter The line delimiter (specified in hex) hexString No "0A" Hex character string Yes
prMode Processing mode prmodeString No "None"
  • "None"
  • "SOSI1"
  • "SOSI2"
  • "SOSI3"
 Yes
trc Whether the data contains table reference characters yesnoString No "No"
  • "Yes"
  • "No"
 Yes
CCType The type of the carriage control character yesnoString No "ANSI"
  • "ANSI"
  • "Machine"
  • "None"
 Yes
Table 9. Child objects under the lineData object
Name Minimum number Maximum number Deleteable Updateable
lvHeader 0 1 No Yes
lvField 0 30 Yes Yes
logView 0 20 Yes Yes
Table 10. Attributes for the lvHeader object
Attributes Description DataType Required Default value Possible values Updateable
pageHdrRows Number of page header rows Integer No 0 Nonnegative integer Yes
fieldHdrRows Number of field header rows Integer No 0 Nonnegative integer Yes
validationRow The validation row Integer Dependent 0 Nonnegative integer Yes
validationCol The validation column Integer Dependent 0 Nonnegative integer Yes
validationString The validation string String Dependent ""   Yes
Table 11. Attributes for the lvField object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
  • "update"
 N/A
name The name of the logical view field nameString Yes     Yes
dbName The application group database name nameString No "*NONE" database field name or "*NONE" Yes
startCol The start column for this field definition Integer Yes 0 An integer value between 1 and 999 Yes
endCol The end column for this field definition Integer Yes 0 an integer value between 1 and 999 Yes
Table 12. Attributes for the logView object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
  • "update"
 N/A
name Name of this logical view nameString Yes     Yes
user user for this logical (or PUBLIC) view nameString Yes  
  • User name
  • "*PUBLIC"
 No
defaultView Whether this is the default view yesNoString No "No"
  • Yes
  • No
 Yes
zoom Zoom factor Integer No 100 Positive integer Yes
selAreaColor Selected area color saColorString No "Yellow"
  • "White"
  • "Black"
  • "Red"
  • "Blue"
  • "Green"
  • "Yellow"
  • "Grey"
  • "Custom"
 Yes
bgColor Background color bgColorString No "White"
  • "White"
  • "Black"
  • "Red"
  • "Blue"
  • "Green"
  • "Yellow"
  • "Grey"
  • "Green Bar"
  • "Custom"
 Yes
headingColor Heading color hdgColorString No "BG Color"
  • "BG Color"
  • "White"
  • "Black"
  • "Red"
  • "Blue"
  • "Green"
  • "Yellow"
  • "Grey"
  • "Custom"
 Yes
textFidelity Text fidelity fidelityString No "Line"
  • "Line"
  • "Word"
  • "Char"
  • "Draft"
  • "240-pel"
 Yes
overstrike Text overstrike option overstrikeString No "Separate Lines"
  • "Separate Lines"
  • "Merge Lines"
  • "Overstrike Lines"
 Yes
fieldOrder A string showing the order in which the fields are to be displayed String No ""   Yes
lockHeader Whether the header lines should be locked in place during scrolling yesnoString No "No"
  • "Yes"
  • "No"
 Yes
lockField Number of fields that you want to lock in place Integer No 0 Nonnegative integer Yes
Table 13. Attributes for the afpData object
Attributes Description DataType Required Default value Possible values Updateable
orientation The orientation or rotation angle, in degrees, of the document orientString No 0
  • "0"
  • "90"
  • "180"
  • "270"
 Yes
paperSize The output paper size paperString No "Autosize" See the list that follows this table for possible values for the paperSize attribute. Yes
The following are possible values for the paperSize attribute:
  • A3
  • A4 Wide
  • A4
  • A5
  • Autosize
  • B4 Wide
  • B4
  • B5
  • Cut Sheet
  • Euro Fanfold
  • Executive 1
  • Executive 2
  • Executive 3
  • Folio
  • Ledger
  • Legal Wide
  • Legal
  • Letter Wide
  • Letter
  • Narrow
  • Quarto
  • Short
  • Statement
  • Stationery
  • Tabloid
  • Wide
  • 1403W
  • 1403WS
  • 3800N
  • 3800NS
  • 3800W
  • 3800WS
Table 14. Child objects under the afpData object
Name Minimum number Maximum number Deleteable Updateable
logView 0 20 Yes Yes
Table 15. Attributes for the logView object under the afpData object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • delete
  • "update"
 N/A
name Name of this logical view nameString Yes     Yes
user User for this logical view (or PUBLIC) nameString Yes  
  • User name
  • "*PUBLIC"
 No
defaultView Whether this is the default view yesnoString No "No"
  • Yes
  • No
 Yes
zoom Zoom factor Integer No 100 Positive integer Yes
selAreaColor Selected area color saColorString No "Yellow"
  • "White"
  • "Black"
  • "Red"
  • "Blue"
  • "Green"
  • "Yellow"
  • "Grey"
  • "Custom"
 Yes
bgColor Background color bgColorString No "White"
  • "White"
  • "Black"
  • "Red"
  • "Blue"
  • "Green"
  • "Yellow"
  • "Grey"
  • "Green Bar"
  • "Custom"
 Yes
imageColor Image color imgColorString No "Black"
  • "Black"
  • "Red"
  • "Blue"
  • "Green"
  • "Yellow"
  • "Magenta"
  • "Cyan"
  • "Custom"
 Yes
textFidelity Text fidelity fidelityString No "Line"
  • "Line"
  • "Word"
  • "Char"
  • "Draft"
  • "240-pel"
 Yes
imageIntensity Image intensity intensityString No "Normal"
  • "Normal"
  • "Light"
  • "None"
 Yes
copyGroup The copy group for the document Integer No 1 Nonnegative integer Yes
Table 16. Attributes for the pdfData object
Attributes Description DataType Required Default value Possible values Updateable
orientation The orientation or rotation angle, in degrees, of the document orientString No 0
  • 0
  • 90
  • 180
  • 270
 Yes
Table 17. Child objects under the pdfData object
Name Minimum number Maximum number Deleteable Updateable
logView 0 Unbounded Yes Yes
Table 18. Attributes for the logView object under pdfData
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • delete
  • "update"
 N/A
name Name of this logical view nameString Yes     Yes
user User for this logical view (or PUBLIC) nameString Yes  
  • User name
  • "*PUBLIC"
 No
defaultView Whether this is the default view yesnoString No "No"
  • Yes
  • No
 Yes
zoom Zoom factor Integer No 100 Positive integer Yes
selAreaColor Selected area color saColorString No "Yellow"
  • "White"
  • "Black"
  • "Red"
  • "Blue"
  • "Green"
  • "Yellow"
  • "Grey"
  • "Custom"
 Yes
Table 19. Attributes for the imageData object
Attributes Description DataType Required Default value Possible values Updateable
orientation The orientation or rotation angle, in degrees, of the document orientString No 0
  • 0
  • 90
  • 180
  • 270
 Yes
Table 20. Child objects under the imageData object
Name Minimum number Maximum number Deleteable Updateable
logView 0 20 Yes Yes
Table 21. Attributes for the logView object under imageData
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • delete
  • "update"
 N/A
name Name of this logical view nameString Yes     Yes
user User for this logical view (or PUBLIC) nameString Yes  
  • User name
  • "*PUBLIC"
 No
defaultView Whether this is the default view yesnoString No "No"
  • "Yes"
  • "No"
 Yes
zoom Zoom factor Integer No 100 Integer value 10 — 1000 Yes
contrast Image contrast value Integer No 128 Integer value 0–255 Yes
brightness Image brightness value Integer No 128 Integer value 0–255 Yes
greyScale Whether the image should use grey scales yesnoString No "No"
  • "Yes"
  • "No"
 Yes
Table 22. Attributes for the udData object
Attributes Description DataType Required Default value Possible values Updateable
fileExt File extension fileExtString Yes     Yes
Table 23. Attributes for the indexParm object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
  • "update"
 n/a
<character data> The character data that represents the index parameters for this application string Yes     Yes
Important: The index parameters are not represented by any attribute data. They are represented by the character data field between the <indexParm> and </indexParm> fields.
Table 24. Attributes for the preprocessParm object
Attributes Description DataType Required Default value Possible values Updateable
dbName Application group database name dbString Yes     No
loadIDName Load ID name namestring No dbName   Yes
defaultValue The default value string No ""   Yes
embedded The embedded characters to remove string No ",."   Yes
leading The leading characters to remove string No ""   Yes
trailing The trailing characters to remove string No ""   Yes
divideBy The value to divide by if the field is numeric Integer No 1 or 100 based on data type Positive integer Yes
format The date format to use string No %m/%d/%Y   Yes
Table 25. Attributes for the imageOverlay object
Attributes Description DataType Required Default value Possible values Updateable
task The task to perform on this object taskString No "add"
  • "add"
  • "delete"
 N/A
id The name of the image overlay that is added to the application string Yes     No
fileName The full path name of the DLL file that contains the image overlay bitmap that is added to the application string Yes     No
Remember: The "_ALL" value can only be used in an ARSXML export operation.