Skip to main content

WriteABSFile

Description

Enables you to write data to any of the three types of Azure Blob Storage (ABS) blobs—block blobs, append blobs, and page blobs—in a container.

info
  • 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 WriteABSFile Activity

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

Configuration

FieldRequiredDescriptionExample
NameRequiredThe name of the activity. This name must be unique in a workflow.Send Finalized Image to ABS
DescriptionOptionalThe description of the activity. We recommend you make this as clear as possible to guide execution, foster understanding, and support collaboration.Writes the finalized image to ABS once the employee finalizes and saves their profile picture in the HRMS.
ResourceRequiredA predefined resource for accessing ABS blobs./Resources/ABSConnection
Container NameRequiredThe name of the container in ABS.user-profile-images
File PathRequired

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

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:

user-profile-images/2024/01/15

In this complete path:

  • user-profile-images is the blob container.
  • 15 is the virtual directory that contains the blob you want to update.
  • 2024/01/15 is the path to the blob.
File NameRequiredThe name of the blob file.005321_JohnWSmith1.png
Encryption TypeOptionalThe type of encryption that you want Azure to use when it stores the blob file.PGP
Encryption ResourceOptionalThe resource that you want to use for encryption.DocTestPGPKey
Content TypeOptionalThe content type of the file you want to write.BINARY
Compression TypeOptionalIf you want to use compression, specify the format that you want to use.ZIP
Create container if Not ExistsOptional

Instructs the application to create a container with the specified name if it doesn’t exist.

Note

Your account must have the access required to create a container.

Deselected
OverwriteOptionalInstructs the application to overwrite the existing file.Deselected
AppendOptionalInstructs the application to append the blob content to the blob file already present in ABS.Deselected

WriteABSFile Configuration

Advanced

FieldRequiredDescriptionExample
Encryption TypeOptional

Specifies the encryption method for the file being written. Options are:-

  • None: No encryption.
  • PGP: Encrypt using a PGP key
PGP
Encryption ResourceRequired if Encryption Type = PGPSelect the PGP public key resource used to encrypt the file before upload.SalesPGPPublicKey
Create Container if Not ExistsOptionalIf selected, the Azure container will be created automatically if it does not already exist.Selected
Overwrite if Blob ExistsOptionalIf selected, overwrites the blob if one with the same name already exists.Deselected
Append to BlobOptionalIf selected, appends the file content to an existing blob rather than overwriting it.Deselected

WriteABSFile Advanced Configuration

Input

FieldRequiredData TypeDescriptionExample
blobpathMandatoryStringThe location of the virtual directory (without the container name) that contains the blob to which you want to write.files/user-uploads
blobNameMandatoryStringThe name of the blob to which you want to write.report_20240417.pdf
createContainerOptionalBoolean

Instructs the application to create a container with the specified name if it doesn’t exist.

Note

Your account must have the access required to create a container.

True

Output

FieldRequiredData TypeDescriptionExample
schemaRequiredNAA JSON schema describing the structure of the data written to the blob (if applicable). This is especially useful if the content being written is structured data that can be represented as JSON.NA
contentLengthRequiredNumberThe size of the written blob in bytes. This corresponds to the Content-Length of the created blob in Azure Blob Storage.125890 (representing 125,890 bytes)
fileNameRequiredStringThe final name of the blob created in Azure Blob Storage.report_20240417.pdf
pathRequiredStringThe location of the virtual directory (without the container name) that contains the blobs to which the application wrote.files/user-uploads