ReadABSFile

Description

Reads a blob file in the specified virtual directory.

  • Ensure that you have a properly configured SFTP connection resource set up under the Resources folder.

  • SFTP file names are typically case-sensitive; therefore, abc.JPG, abc.jpg, and ABC.jpg will be saved as different files. To ensure consistency, we recommend using lower-case file names and extensions: abc.jpg.

Configuring the ReadABSFile Activity

The ReadABSFile Configuration panel has four tabs: Configuration, Advanced, Input, and Output. This section offers details on how to use them.

Configuration

Field
Required
Description
Example

Name

Required

The name of the activity. This name must be unique in a workflow.

Read Data for Scheduled Processing

Description

Optional

The description of the activity. We recommend you make this as clear as possible to guide execution, foster understanding, and support collaboration.

Reads raw application data files, such as logs, sensor readings, and financial transactions, making it available for downstream analysis.

Resource

Required

A predefined resource for accessing ABS blobs.

/Resources/ABSConnection

Container Name

Required

The name of the container in ABS.

raw-data

File Path

Required

The location of the virtual directory that contains the blob that you want to delete.

Note

While entering the path, only include the virtual directories without adding the container name, because the container name is already specified (see Container Name, above).

For example, consider the following complete path:

raw-data/logs/2025/04/08/

In this complete path:

  • raw-data is the blob container.

  • 08 is the virtual directory that contains the blob you want to update.

  • logs/2025/04/08 is the path to the blob.

File Name

Required

The name of the blob file that you want to read.

error-logs.zip

Encryption Type

Optional

The encryption that must be used to decrypt the file before it can be read.

PGP

Encryption Resource

Mandatory if Encryption Type is specified.

The encryption key resource that you want to use to decrypt the file you want to read.

DocTestPGPKey

Content Type

Optional

The type of blob file that you want to read.

TEXT

Compression Type

Optional

The compression type used on the file.

ZIP

Buffer Size

Optional

The amount of data that must be read from ABS into memory at one time before being read. Enter this value in KB.

10240

Input

Field
Required
Data Type
Description
Example

filepath

Optional

String

The location of the virtual directory (without the container name) that contains the blobs that you want to read.

logs/2025/04/08

filename

Mandatory

String

The name of the file that you want to read.

error-logs.zip

bufferSize

Optional

Number

The size of the blob chunk that you want read at a time.

Note

Larger buffer sizes can potentially improve throughput by reducing the number of network round trips. However, they also consume more memory.

4000

streaming

Optional

Boolean

Indicates whether the file can be read as streaming data instead of as chunks.

True

Output

Field
Required
Data Type
Description
Example

schema

Required

NA

A custom schema that can be imported.

NA

title

Required

String

Title of the object containing the data returned.

ReadFileOutput

content

Required

String

Content read from the file.

name,age\r\nAbhishek,23

contentLength

Required

Number

The size of the read content, in bytes.

500

fileName

Required

String

The name of the file read.

error-logs.zip

path

Required

String

The location of the virtual directory (without the container name) that contains the blobs that the application read.

logs/2025/04/08

Last updated

Was this helpful?