DeleteCSVAttributes

Removes the CSV Attributes from a workfile.

Required parameters

JOBSTEP resource

Parameter Key Value Type Parameter Description
jobName Alphanumeric string The job name. Maximum length for strings is 10.
jobOwner Alphanumeric string

The owner of the job in the appropriate format. For example, in Windows, the format might be: DOMAIN\user

Maximum length for strings is 10.

jobStepKey Alphanumeric string The job step key this CSV data belongs to.
jobStepNumber Integer The order or index of the job step in the multi-step job. First job step has 0 step number, second has 1, and so on.
productLine Integer

The productline of the job step.

Maximum length is 14.
token Alphanumeric string

The token of job step the CSV data belongs to.

Maximum length for strings is 10.
jobStepType Fixed values The type of job step. Fixed values are application, universe, user, and menu.
jobStepDescription Alphanumeric string Describes the job step. Maximum length for string is 30.
jobStepParameters Alphanumeric string

Additional parameters needed for the job step.

Maximum length for strings is 2000.
workFilePath Alphanumeric string

Path where workfile is located.

Maximum length for strings is 60.
jobStepTranSize Integer The Tran Size of the job step. If the job step is an application type, this value defaults to 50 if the job's program isUpdate is true. Otherwise, value is 0.
machineName Alphanumeric string

The machine name of job step where CSV workfiles belong to.

Maximum length for strings is 10.
intRptServer Integer

The value of interpretive server of the job step where CSV workfiles belong to.
dataArea Alphanumeric string The data area where the CSV workfile is stored. Maximum length for strings is 14
CSVATTRIBUTES resource
Parameter Key Value Type Parameter Description
workFileName Alphanumeric string

The name of the workfile for this job step.

Maximum length for strings is 10.

Optional parameters

CSVATTRIBUTES resource

Parameter Key Value Type Parameter Description
jobOwner Alphanumeric string

The owner of the job in the domain format.

For example, in Windows, the format might be: DOMAIN\user
jobName Alphanumeric string The job name.
jobStepNumber

The job step number this CSV data belongs to.
jobStepKey Alphanumeric string

The job step key this CSV data belongs to.
productLine Alphanumeric string

The productline of the job step.

Maximum length for strings is 14.
systemCode Alphanumeric string

The system code of job where this CSV data belongs to.

Maximum length for strings is 5.
programCode Alphanumeric string

The program code of job this CSV data belongs to.

Maximum length for strings is 5.
workFilePath Alphanumeric string

Path where workfile is located.

Maximum length for strings is 60.
jobStepWrkType Alphanumeric string

The file type of the CSV work file for this job step.

Fixed value and default value is csv.
usage Fixed values

Fixed values are output,input, or inputOutput. This parameter is used to specify whether the file is write-only, read-only, or both.

Default value is inputOutput.
fileHeader Boolean

Specifies whether a file header containing field names should be written to the CSV file or, if the file is being read, if the header exists.

Fixed values are true and false. Default value is false.
xltHeader Boolean

Specifies whether to translate header names. If you are writing to a file and you choose On, it translates the header names as specified in the user's Locale record.

Fixed values are true and false. Default value is false.
fieldSeparator Fixed values

The symbol separating fields in the file.

Fixed values are:
  • comma
  • tab
  • space
  • none
  • userDefined
Default value is comma.
dateFormat Fixed values

The date format to use in any date fields that might be included in the file.

Fixed values are:
  • mmddccyy
  • ddmmccyy
  • ccyymmdd
  • yymmdd
  • mmddyy
  • ddmmyy
dateSeparator Alphanumeric string

The symbol separating month, day, and year formats.

Maximum length for strings is 1.
timeSeparator Alphanumeric string

The symbol separating hours and minutes in any time formats that might be included in the file.

Maximum length for strings is 1.
decimalSeparator Alphanumeric string

The symbol separating the parts of a number that has decimal places.

Maximum length for strings is 1.
thousandSeparator Alphanumeric string

The symbol separating the thousands place from the hundreds, and so on.

Maximum length for strings is 1.
quoteCharacter Alphanumeric string

The symbol to use for delimiting strings.

Maximum length for strings is 1.
fileTerminator Boolean

The code that denotes the end of the file.

Fixed values are true and false. Default value is false.
lineTerminator Fixed values

The code that denotes the end of each line in the file.

Fixed values are:
  • newLine
  • carriageReturn
  • carriageReturnNewLine
Default value is newLine.

XML request format

This is the format of the request XML payload for POST method calls. Note that this must always be wrapped by <ACTION> nodes.

<JOBSTEP jobOwner="XXX" jobName="XXX" jobStepNumber="XXX" jobStepKey="XXX" jobStepType="XXX" jobStepDescription="XXX jobStepParameters="XXX" productLine="XXX" dataArea="XXX" token="XXX" workFilePath="XXX" jobStepTranSize="XXX" machineName="" intRptServer="XXX" >

<CSVATTRIBUTES jobOwner="XXX" jobName="XXX" jobStepNumber="XXX" jobStepKey="XXX" productLine="XXX" systemCode="XXX" programCode="XXX" workFileName="XXX" workFilePath="XXX" miscOpts="XXX" pcFileName="" jobStepWrkType="XXX" usage="XXX" fileHeader="XXX" xltHeader="XXX" fieldSeparator="XXX" dateFormat="XXX" dateSeparator="XXX" timeSeparator="XXX" decimalSeparator="XXX" thousandSeparator="XXX" quoteCharacter="XXX" fileTerminator="XXX" lineTerminator="XXX" autoDownload="XXX" />

</JOBSTEP>