Header ID
- Last Updated: November 28, 2024
- 2 minute read
- MOVEit Automation
- Version 2024.1
- Version 2024
- Documentation
Header ID reads a text string on the first (Header) line of a file from a set character position. A new task parameter called HeaderID_Value can be used for integration into MOVEit Automation tasks.
Input Parameters
- HeaderID_Length (Required) - Specifies the number of characters (length) to read from the first line of the file.
- HeaderID_Start (Required) - Specifies the starting character position (column) from which to read the text string value.
- HeaderID_Strip (Required) - Set this optional parameter to "Yes" if you want to remove the entire first line after capturing the Header ID_Value.
Output Parameter
- HeaderID_Value - Returns the text string found on the first line, beginning at HeaderID_Start and continuing for HeaderID_Length characters.
Example #1
Bill wants to read a value from the first line of a file starting in column 1 and continuing 8 characters, and then use this text string to rename the file on the task's destination with a date stamp extension.
To integrate this application with MOVEit Automation , Bill does the following:
- Creates a new task with a source, process, destination and schedule.
- Selects "Header ID" as the process.
- Sets process parameters:
- HeaderID_Start = 1
- HeaderID_Length = 8
- Edits the Destination to set FileName to [Parm:HeaderID_Value].[YYYY][MM][DD]
Example #2
Cheryl wants to read a value from the first line starting in column 5 and continuing 6 characters. She wants to discard this first line and use the HeaderID_Value in conjunction with a LookUp process to find the folder on a FTP server where each respective file should go.
To integrate this application with MOVEit Automation :
- Create a new task with a source, process, destination and schedule.
- Select "Header ID" as the 1st process
- Set the Header ID process parameters:
- HeaderID_Start = 5
- HeaderID_Length = 6
- Add a second process, choosing the built in "Look Up" script
- Set the Look Up process parameters:
- LookUp_Key = [Parm:HeaderID_Value]
- LookUp_FilePath = C:\LookUp\List1.txt (Note: This is an example)
- LookUp_ActionIfKeyNotMatched = Throw_Error
- LookUp_MatchType = Require_Exact_Match
- Edit the Destination to set Folder to [Parm:LookUp_Value]