Workiva Support Center

To access and work with files on Microsoft Windows® and Linux®-based operating systems as part of a chain, add a step with a File Utilities connection command.

To enable these commands, an IT admin first creates a File Utilities connection.

Base 64 encode

Base64 encoding takes binary data (like images, documents, or other files) and converts it into a string of ASCII characters. By representing binary data as text, Base64 encoding helps prevent data loss or corruption during transmission over media that are not designed to handle binary formats.

Note: Base64 encoding causes an overhead of 33–37% relative to the size of the original binary data (33% by the encoding itself and up to 4% more by the inserted line breaks).

Properties

Outputs

Exit codes

Base 64 decode

Base64 decoding converts ASCII strings back into the original binary data. This allows you to access and use the original data after it has been encoded for transport or storage.

Properties

Outputs

Exit codes

Checksum

To verify a file has not been corrupted or changed from its original source, use a Checksum command. The command can be run on multiple files, and their returned hash values can be compared to determine whether those files are identical.

Properties

Outputs

Exit codes

Clean line breaks

To remove extra line breaks from a tabular file's cells, such as within an output from one system to upload to another, use a Clean Line Breaks command.

Properties

Outputs

Exit codes

Copy

To copy files and directories, use a Copy command.

Properties

Outputs

None

Exit codes

Create file

To create a new file, use a Create File command.

Properties

Outputs

Exit codes

Delete

To delete files or directories, use a Delete command.

Properties

Outputs

None

Exit Codes

Delete directory

To delete one or more directories, use a Delete directory command.

Properties

Outputs

None

Exit codes

Find

To search for a text string in a file or set of files, use a Find command.

Properties

Outputs

Exit codes

Find and replace

To perform a find-and-replace in a file, use a Find and Replace command.

Properties

Outputs

Exit codes

Get file

To retrieve a file from the local file system, use a Get File command.

Properties

Outputs

Exit codes

Get file/folder info

To retrieve the file system information for a file or folder, use a Get File/Folder Info command.

Properties

Outputs

For example: { "absPath": "/tmp", "name": "tmp", "size": 4096, "mode": 2148532735, "modTime": "2018-09-27T19:31:52Z", "isDir": true, "exists": true }

Exit codes

Note: This command always succeeds. If the file or folder isn't found, the exists property will be false.

Gunzip file

To unzip a GZIP archive using gunzip, use a Gunzip File command. For example, use this command to unzip a file output from Oracle® Hyperion Financial Management (HFM).

Properties

Outputs

Exit codes

Gzip file

To compress a file using gzip, use a Gzip File command.

Properties

Outputs

Exit codes

List directory

To list the contents of a directory, use a List Directory command.

Properties

Outputs

Note: The Found files list output is limited to 500 items; for larger operations, the Result file output should be used instead.

Exit codes

List file content

To list the contents of a file, use a List File Content command.

Note: This command can't return individual lines larger than 64KB.

Properties

Example

The following image shows 5 preview lines with an offset of 5. Please note that because the offset starts at 0, the first line shown is actually 6.

Outputs

Exit codes

Make directory

To create a directory, use a Make Directory command.

Properties

Outputs

None

Exit codes

Move

To move files or directories, use a Move command.

Properties

Outputs

None

Exit codes

Select Lines

To retain a specific number of lines from the start or end of a file, use a Select Lines command. This is basically the opposite of the Strip Lines command. Instead of removing lines specified by the pattern, it keeps the lines. As with Strip Lines, the sections can be anywhere in the file.

Properties

Outputs

Exit codes

Split file

To split a file into multiple file chunks based on byte size, line count, or regular expression (RegExp) delimiter, use a Split File command. For example, use this command to process smaller files in parallel to help improve performance

Properties

Outputs

Exit codes

Stack files

To stack multiple asymmetric files on top of one another, use a Stack Files command.

Note: With the Tabular Transformation connector, you can use a Stack Files command to stack symmetric files that all have the same number of columns.

Properties

Outputs

Exit codes

Strip lines

To remove lines from a file according to the line numbers provided, use a Strip Lines command.
This is basically the opposite of the Select Lines command. Instead of keeping the lines specified by the pattern, it removes them. As with Select Lines, the sections can be anywhere in the file.

Properties

Outputs

Exit codes

Tar

To create a tape archive (TAR) file, use a Tar command.

Properties

Outputs

Exit codes

Template File

This command replaces the specified keys with their respective values from the input file template. These values can be strings or files. If the value is a file, its entire contents will replace the specified value.

Difference from the Handlebars command:Handlebars supports only raw string values for replacement, and has a maximum total variable (i.e. all replacement values) size of 250MB.  Template File supports both raw string values and referenced file contents, and does not have a maximum total variable size.

Properties

Outputs

Exit codes

UTF-8 encode

To convert a file to be encoded in Unicode Transformation Format–8-bit (UTF-8), use a UTF-8 Encode command.

Properties

Outputs

Exit codes

Untar

To unpack a TAR file, use an Untar command.

Properties

Outputs

None

Exit codes

Unzip

To unpack a ZIP or GZIP archive, use an Unzip command.

Note: This command requires a GroundRunner.

Properties

Outputs

None

Exit codes

Zip

To create a ZIP, GZIP, or GZIP+TAR archive, use a Zip command.

Properties

Outputs

Exit codes