File Name
Syntax
AssignDefault ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure assigns a default value to DataValue based on a parameter passed in through Arguments. If the parameter is an A, first parameter of Arguments, then DataValue will always be replaced by the default DataValue, second parameter of Arguments. If the argument is a B, first parameter of Arguments, then DataValue will be replaced by the default, second parameter of Arguments, only if DataValue is not Known (Blank).
Dialog Forms Called
None
File Name
Syntax
CheckUserErrOption ( VAL ArgString: STRING )
Parameters
ArgString - data contained in the field being checked
Returns
None
Side Effects
None
Description
This function checks a string to see if it matches a user-specific RetCode argument.
Dialog Forms Called
None
File Name
Syntax
ConvertDistDate ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure changes the date from host format (MM/DD/YYYY) to distributed format (YYYY/MM/DD).
Dialog Forms Called
None
File Name
Syntax
ConvertDistTime ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure adds seconds at the end of the host time field. The host time is stored HH:MM while the distributed time is stored HH:MM:SS.
Dialog Forms Called
None
File Name
Syntax
ConvertHostDate ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure changes the date from host format (YYYY/MM/DD) to distributed format (MM/DD/YYYY).
Dialog Forms Called
None
File Name
Syntax
ConvertHostTime ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure adds seconds at the end of the host time field. The host time is stored HH:MM while the distributed time is stored HH:MM:SS.
Dialog Forms Called
None
File Name
Syntax
DeleteStr ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure is a transform action to delete a string from the data contained in Datavalue. A second parameter should be passed within Arguments that identifies how the user wants this transform action to handle an error; WARN or ABORT should be passed as the third parameter.
Dialog Forms Called
None
File Name
Syntax
InsertStrIntoStr ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how the transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure inserts a string into the data contained in Datavalue. The string to be inserted and the location of the insertion are contained in the Arguments parameter. A third parameter identifies how the user wants this action to handle an error; WARN or ABORT should be passed as the third parameter.
Dialog Forms Called
None
File Name
Syntax
MakeLowerCase ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure transforms data in DataValue to lower case.
Dialog Forms Called
None
File Name
Syntax
MakeUpperCase ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure transforms data in DataValue to upper case.
Dialog Forms Called
None
File Name
Syntax
Required ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure verifies that there is data in DataValue because it is a required field. The arguments field should be ABORT or WARN; this determines the RetCode if DataValue is not known. If the argument field is not ABORT or WARN then RetCode will default to ABORT if DataValue does not contain a value.
Dialog Forms Called
None
File Name
Syntax
SearchReplaceStr ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure locates a string within DataValue and replaces it with a new string. The target string and the new string are parameters in Arguments. A third parameter should be passed within Arguments that identifies how the user wants this transform action to handle an error; WARN or ABORT should be passed as the third parameter.
Dialog Forms Called
None
File Name
Syntax
TrimEndWhiteSpace ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - Information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure removes white space from the end of the data contained in DataValue.
Dialog Forms Called
None
File Name
Syntax
TrimLeadingWhiteSpace ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - fata contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure removes white space from the beginning of the data contained in DataValue.
Dialog Forms Called
None
File Name
Syntax
TruncateString ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure shortens a data field based on the number passed in from Arguments and a user-chosen RetCode of ABORT or WARN.
Dialog Forms Called
None
File Name
Syntax
ValidateValue ( REF DataValue: STRING, VAL Arguments: STRING, REF RetCode: INTEGER )
Parameters
DataValue - data contained in the field being converted
Arguments - information used to determine how transformation will change data in DataValue
RetCode - if transformation was successful
Returns
None
Side Effects
None
Description
This procedure verifies that the data contained in DataValue is valid. The Arguments field should contain one or more valid values separated by a comma, with no spaces between commas and values.
Dialog Forms Called
None