Utils: Transfer files (Scheduler Based)

Component Name and System Landscape

• Name: FCA_SAP_Utils_File_Transfer, FCA_Util_File_Transfer, RWPC_Utils_File_Transfer
• Description: Transfer files (Scheduler Based)
• Application: FCA_Transactions
• Type: RedwoodScript

Brief Description

With this program you can copy and move (transfer) files from and to various files type sources:

• Full path to files
• For example: D:\\Data\\Example.xlsx or /data/example.xlsx
• Process (Job) files
• For example: Job 123456:example.xlsx or JobFile:123456:example.xlsx
• Redwood Documents
• For example: doc:REDWOOD:/Example.xlsx

Parameter Mapping - Generic Tabs

There are several tabs under this section. Some will be generic, and others are specific to the component. The generic tabs usually are:

• Target: Requires SAP and Client information. You can also hard code the SAP username.
• Infrastructure: Used for Action rules. See the Redwood Finance Automation Reference.
• Recipient parameters: Generally left to default values.
• Job output parameters: Defines the format of the required output. Defaults to RTX and Text. See Porgam Handling for more information.

note

Most of the time these tabs will be shown, but there are components where these differ and either do not appear at all, or they are specific tabs.

Parameter Mapping - Specific Tabs

This guide shows the minimum parameter values required for the component to run. Please refer to the Redwood Automation Engineering Training course for submission and monitoring activities.

Tab	Technical Name	Description	Format	Mandatory Field	Example
Parameters	IN_FROM_FS	From path	Reference to full path to one or multiple files to copy or to move. Within filenames wildcards ? and * are allowed. Multiple files are separated by symbols defined in IN_SPLITTERS When used in combination with IN_FILE parameter, only a single directory is allowed and no wildcards.		Single file: /data/example_file.xlsx D:\\data\\example_file.xlsx Multiple files: /data/file1.txt;/data/file2.txt Wildcards: /data/file*.txt /data/file?.*;/folder/example.*
Parameters	IN_FROM_TRANSACTION	From transaction	Job file number ID:file extension Job file references for the files to copy or to move. Within filenames wildcards ? and * are allowed. Multiple file references are separated by symbols defined in IN_SPLITTERS. When used in combination with IN_FILE parameter, only a single reference is allowed and no wildcards.		Single references: Step 1, Job 1:file.txt Job 12345:file.txt Jobfile:12345:file.txt Or in combination with IN_FILE parameter without file names: Step 1, Job 1: Job 12345: JobFile:12345: Note: when single file references are used including file name(s), then IN_FILE needs to be empty.
Parameters	IN_FILE	File/Pattern to process	Filenames to be copied / moved. This parameter is used in combination with IN_FROM_FS and IN_TO_FS parameters. Wildcards ? and * are allowed. Multiple file references are separated by symbols defined in IN_SPLITTERS.		Single value: Example.txt Multiple values: Example.txt;Example2.xlsx Using Wildcards: Example?.txt Ex*.txt
Parameters	IN_FROM_DOCUMENT	From Document	Reference to single or multiple documents to be copied / moved. Multiple file references are separated by symbols defined in IN_SPLITTERS Wildcards are NOT allowed. When parameter IN_TO_DOCUMENT is used, then the same number of documents must be specified.		Single reference: doc:REDWOOD:/Example.xlsx doc:/Redwood/application/Example.txt Multiple references: doc:REDWOOD:/Example.xlsx;doc:/Redwood/application/Example.txt
Parameters	IN_TO_FS	To path	Reference to the full path where one or multiple files need to be copied or moved to. If the path contains a directory, all files within that directory will be copied / moved. Note: if the directory contains sub directories, those files are not copied / moved. If the path specifies files, then the same number of files need to be specified in IN_FROM_FS, IN_FROM_TRANSACTION or IN_FROM_DOCUMENT No wildcards are allowed. Multiple file references are separated by symbols defined in IN_SPLITTERS. When this parameter and parameters IN_TO_FS, IN_TO_DOCUMENT are left empty, the files will be copied / moved to the current process. When wildcards are used in parameters IN_FROM_TRANSACTION or IN_FILE, the filename part of this parameter is ignored, and original filenames used instead.		Single file: /data/example_file.xlsx D:\\data\\example_file.xlsx Multiple files: /data/file1.txt;/data/file2.txt Wildcards: /data/file*.txt /data/file?.*;/folder/example.* Just directory to copy all files (not files in subdirectories): Single: /data/subdir D:\\Data\\Subdir Multiple: /data/subdir;D:\\Data\\Subdir;D:\\Data\\Subdir\\Subsubdir
Parameters	IN_TO_TRANSACTION	To transaction	Job file references where the files need to be copied or moved to. If the reference specifies files, then the same number of files need to be specified in IN_FROM_FS, IN_FROM_TRANSACTION or IN_FROM_DOCUMENT No wildcards are allowed. Multiple file references are separated by symbols defined in IN_SPLITTERS.		Single reference without filename: Step 2, Job 1: Job 12345: Single reference with filename: Step 2, Job 1:example.txt Job 12345:example.xlsx JobFile:12345:example.txt
Parameters	IN_TO_DOCUMENT	To document	Reference where single or multiple documents are copied / moved to. Multiple file references are separated by symbols defined in IN_SPLITTERS Wildcards are NOT allowed. When this parameter is used, the same number of files need to be specified in IN_FROM_FS, IN_FROM_TRANSACTION or IN_FROM_DOCUMENT		Single reference: doc:REDWOOD:/Example.xlsx doc:/Redwood/application/Example.txt or just: example.txt Should work with just the filename, but doesn’t. Ticket created. Multiple references: doc:REDWOOD:/Example.xlsx;doc:/Redwood/application/Example.txt
Parameters	IN_SPLITTERS	Separators for combined parameter	The separators for parameters with multiple input. Default values: semicolon ; and comma , Each symbol specified here can be used as separator.		;,
Parameters	IN_CREATE	Create Target Directory/Application	If value X is set, then target directory creation is allowed. It can create directories in directories.		This field can only contain an X or be empty.
Parameters	IN_OVERWRITE	Overwrite existing files	If value X is set, then overwriting of existing target files is allowed.		This field can only contain an X or be empty.
Parameters	IN_MOVE	Copy or Move	Available values are: C (to copy files) or M (to move files)		This field can only contain a C or an M. Default is C
Parameters	IN_SIMULATE	Simulate	If value X is set, then the copy or move of files will be simulated without writing or moving the target files		This field can only contain an X or be empty.
Parameters	RULE	Action Rule(s) to process	Not used

Troubleshooting

Parameters Tab

• Issue:
• Resolution: Possible values for the different input parameters can be set dynamically by using REL expressions or Replacements.

See Also

Redwood Finance Automation Reference

financeTopic