LogoLogo
  • 🖐️Welcome Aboard!
  • 📖Information
    • What is Autom Mate?
    • What is Autom?
    • Features of Autom Mate
    • Architecture of Autom Mate
  • 🤓Learn Autom Basics
  • 📚Libraries
    • Integration
      • Active Directory
      • AFAS
      • Autom Mate
      • Azure Active Directory
      • Azure DevOps
      • BambooHR
      • ChatGPT
      • ConnectWise
      • Database
      • Desktop Actions
      • EasyVista
      • Email
      • Exchange Web Server
      • Exact Online
      • Excel
      • Freshdesk
      • Freshservice
      • Ftp-Sftp
      • GitLab
      • Google Drive
      • Google Workspace
      • HaloITSM
      • Hubspot
      • Intune
      • Ivanti Service Manager
      • Jenkins
      • Jira Confluence
      • Jira Service Management
      • Jira Software
      • Lakeside
      • Lansweeper
      • Matrix42
      • ME ServiceDesk Plus
      • Microsoft Outlook Calendar
      • Microsoft SharePoint
      • Microsoft Teams
      • My ChatGPT
      • OCR
      • PDF
      • PowerShell
      • Python
      • RESTful Web Service
      • Salesforce
      • ServiceDesk Plus Cloud
      • ServiceNow
      • Slack
      • SolarWinds
      • Stripe
      • TOPdesk
      • Twilio
      • Twitch
      • VMware
      • WhatsApp
      • Word
      • X
      • Xurrent
    • Transform
      • Advanced Actions
      • Array
      • Base64
      • Condition
      • Cryptography
      • CSV
      • Data Table
      • Date
      • File
      • Folder
      • Number
      • Object
      • Repeatable
      • SSH
      • String
      • Text
    • Utility
      • Display Message
      • Grouping
      • Mate DB
      • Mate Drive
      • Time Management
    • Agentic AI (Beta Version)
      • Open AI (Beta Version)
  • 🎇Autom Features
    • Variables
    • Triggers
    • Data Manager
    • Debug
    • Stop Action
    • Function
    • Error Handling and Exception Management
    • Development Mode ( Dev Mode )
    • Business Impact Estimator
  • 🛰️Product Features
    • Dashboard
      • Dashboard
      • Monitoring
      • Alerts
    • Store
      • Autom Store
      • Library Store
    • My Environment
      • Mate Agent
      • Automs
      • Libraries
    • Management
      • User Management
        • Users
        • Roles
        • Forgot Password
      • Vault
      • Webhook & API
      • Alert Management
      • Queue
    • Create Autom
    • Settings
      • Personalization
      • Port & SSL
      • Mail Server
      • License
      • Log Retention
    • Time Zone Management in Autom Mate
  • 💾Installation Setup
    • System Requirements and Ports Configuration
    • Autom Center Installation
      • Autom Center Installation
      • Autom Center Update
    • Mate Agent Installation
      • Mate Agent Installation
      • Mate Agent Update
    • App Installations
      • MS Teams ChatBot Installation
    • Full Chain PFX File Creation Guide
  • 📔Release Notes
    • Amsterdam Edition
      • Amsterdam 3.2.9
      • Amsterdam 3.3.0
    • Boston Edition
      • Boston 4.0.0
      • Boston 4.1.0
      • Boston 4.2.0
      • Boston 4.3.0
        • Boston 4.3.1
        • Boston 4.3.2
        • Boston 4.3.3
        • Boston 4.3.4
        • Boston 4.3.5
        • Boston 4.3.6
        • Boston 4.3.7
      • Boston 4.4.0
        • Boston 4.4.1
      • Boston 4.5.0
  • 🎓Academy
    • 🎓Autom Mate Academy: Basics of Autom Mate
    • 🎓Mastering Automation with Autom Mate: From Workflow Creation
    • 🎓The Ultimate Autom Mate: Teams & Smart Integrations
  • 👔Autom Store & Use Cases
    • 🛒Autom Store Use Cases
    • 🖥️Use Cases
      • How to Create Bidirectional Connection Between JIRA and Xurrent to Open Requests or Tickets
      • Employee Onboarding Process Automation Using Autom Mate
  • ❓FAQ
    • ⚙️General Functionality
    • 🧩Integration Capabilities
    • Data Management and Validation
    • ⁉️Error Handling and Workflow Management
    • Automation Use Cases
    • Connectors and Triggers
    • Custom GPT Models
Powered by GitBook
On this page
  • Introduction
  • What is File?
  • How To Use Action
  • Create
  • Copy
  • Delete
  • Move
  • Get File Properties
  • Rename
  • Unzip
  • Zip
  • Additional Tips
  • Use Cases
  • FAQ

Was this helpful?

  1. Libraries
  2. Transform

File

Introduction

The File library in Automate provides actions to automate various file-related operations within workflows. This library enables users to create, copy, delete, and move files seamlessly.

The purpose of the File library is to streamline file management tasks by providing easy-to-use actions for creating, copying, deleting, and moving files.

What is File?

The File component within Automate allows users to perform file operations directly within their automation workflows. It provides a set of actions to interact with files, making it easier to handle file creation, copying, deletion, and moving.

Key Features

  • Create:

    • Create a new file at a specified path.

  • Copy:

    • Copy an existing file to another location.

  • Delete:

    • Delete a specified file.

  • Move:

    • Move a file to a different folder.

How To Use Action

Create

Description: The Create action is used to create a new file at a specified path.

Usage:

  1. File Path:

    • Enter or select the path of the file to be created.

    • Example: C:\Program Files\NewFile.docx

Copy

Description: The Copy action is used to make a copy of an existing file.

Usage:

  1. Source File:

    • Select the file to be copied.

  2. Destination Path:

    • Select or enter the path where the copied file will be placed.

    • Check "Overwrite existing files" if needed.

    • Specify the desired file size (optional).

Delete

Description: The Delete action is used to delete a specified file.

Usage:

  1. File Path:

    • Select the path of the file to be deleted.

Move

Description: The Move action is used to move a file to a different folder.

Usage:

  1. Source File Path:

    • Select the file to be moved.

  2. Destination Folder Path:

    • Select or enter the path of the destination folder.

Get File Properties

Description and Purpose

The Get File Properties action allows Autom Mate users to retrieve detailed metadata and properties of a specific file stored in Mate Drive. This action is useful for inspecting file attributes such as name, size, MIME type, permissions, and modification dates, which can be used for conditional logic, logging, or file validation within a workflow.

By providing the file path and assigning the output to a variable, users can make file-aware decisions across the automation process.


Usage Instructions

1

Provide File Path

File Path (Required): Enter the full path of the file stored in Mate Drive for which properties should be retrieved. Example:

mate:/Release 450 Notes.docx

Use file paths generated by other actions (e.g., Save to MateDrive) to dynamically fetch file details during runtime.

2

Assign Output Variable

Assign file properties to variable (Required): Select an object-type variable (e.g., resp) to store the file properties returned by the action.

You can use the output variable in downstream actions like condition checks, messages, or audit logs.

3

Execute and Review

Run the action. After execution, the output variable will contain the file’s properties such as size, format, creation date, last modified date, permissions, and more.


Inputs

Field
Description

File Path

The full Mate Drive file path to inspect (e.g., mate:/example.docx).


Outputs

Field
Description

Output Variable (object)

Contains all properties of the given file such as name, path, MIME type, size, permissions, and timestamps.


Example Output

{
  "CreatedDate": "2025-06-03 13:04:50.2941845 +0300 +03",
  "Extension": ".docx",
  "LastModified": "2025-06-03 13:04:50.2947408 +0300 +03",
  "Name": "Release 450 Notes.docx",
  "Permissions": "-rw-rw-rw-",
  "Size": 27765
}

Rename

Description and Purpose

The File - Rename action allows Autom Mate users to rename an existing file stored in MateDrive. This action is useful for dynamically changing file names during workflows, such as appending dates, adding version numbers, or organizing files based on their content or context.

By providing the source file path and the new file name, users can automate file renaming tasks without manual intervention, ensuring efficient file management.


Usage Instructions

1

Provide File Path

File Path (Required): Enter the full path of the file that you want to rename. Example:

mate:/newFileName.png

This is the path of the existing file in Mate Drive that will be renamed.

2

Specify New File Name

New File Name (Required): Enter the new name you want to assign to the file. Example:

newFileName

Ensure that the new file name includes the proper extension (e.g., .png, .txt, .pdf) to maintain the file's correct format.

3

Execute and Review

Run the action. After execution, the file at the provided path will be renamed to the new name specified. The change will be reflected in the Mate Drive file system.


Inputs

Field
Description

File Path

The full path of the existing file to rename (e.g., mate:/oldFileName.png).

New File Name

The new name to assign to the file (e.g., newFileName).


Outputs

Field
Description

File Path

The path of the renamed file in Mate Drive (e.g., mate:/newFileName.png).


Example

  • File Path:

mate:/oldFileName.png
  • New File Name:

newFileName.png
  • Output: The file mate:/oldFileName.png will be renamed to mate:/newFileName.png after the action is executed.

Unzip

Description and Purpose

The File - Unzip action allows Autom Mate users to extract the contents of a ZIP file stored in Mate Drive. This action is useful for automating the extraction of compressed files, enabling easy access to the files inside the archive. Users can choose to extract the contents to the same path or specify a different destination folder.

By providing the path of the ZIP file and the desired extraction destination, users can streamline file management and processing tasks.


Usage Instructions

1

Provide Zip File Path

Zip File Path (Required): Enter the full path of the ZIP file you want to extract. Example:

mate:/archive (2).zip

This is the path to the ZIP file stored in Mate Drive that will be unzipped.

2

Specify Destination Folder

Destination: Choose where you want to extract the files.

  • Extract to same path: Extracts the contents into the same directory as the ZIP file.

  • Extract to given path (Required): Specify a different folder where the files will be extracted. Example:

    mate:/unzip

Ensure the destination path is correct to avoid file overwriting or errors.

3

Overwrite Existing Folder

Overwrite an existing folder: Enable this option if you want to replace the contents of an existing folder with the extracted files.

Enabling this option will remove any existing files in the destination folder and replace them with the extracted files.

4

Assign Folder Path to Variable

Assign folder path to variable (Required): Select a string-type variable (e.g., NewFilePath) to store the full path of the destination folder where the files were extracted. Example:

NewFilePath

This allows referencing the extracted folder's location in subsequent workflow steps.

5

Execute and Review

Run the action. After execution, the contents of the ZIP file will be extracted to the specified folder, and the folder path will be stored in the chosen output variable.


Inputs

Field
Description

Zip File Path

The path of the ZIP file to be extracted (e.g., mate:/archive (2).zip).

Destination

The folder path where the ZIP file should be extracted (either the same path or a new one).

Overwrite Existing Folder

Enable to overwrite existing folder contents with the extracted files.

Assign Folder Path to Variable

Select a string variable (e.g., NewFilePath) to store the destination path.


Outputs

Field
Description

New File Path

The path of the folder where the files were extracted (e.g., mate:/unzip).


Example

  • Zip File Path:

ymate:/archive (2).zip
  • Destination:

mate:/unzip
  • Output Variable (NewFilePath): The files from the archive will be extracted to the folder mate:/unzip, and the output variable will store this path.

Zip

Description and Purpose

The File - Zip action allows Autom Mate users to compress files and directories into a ZIP archive within Mate Drive. This action is useful for organizing multiple files or folders into a single compressed file for easier storage, transfer, or backup. Users can specify the file to be zipped and define the destination and zip file name.


Usage Instructions

1

Provide File Path

File Path (Required): Enter the full path of the file or directory to be compressed into a ZIP archive. Example:

mate:/test.txt

This is the path of the file or folder to be zipped.

2

Specify Zip Name

Zip Name: Enter the desired name for the resulting ZIP file. Example:

ZipTest

By default, if no name is provided, the folder name will be used for the ZIP archive. Make sure the name ends with .zip to indicate it's a compressed file.

3

Choose Destination

Destination: Select where you want to save the ZIP file.

  • Extract to same path: The ZIP file will be saved in the same directory as the original file or folder.

  • Extract to given path: Specify a different folder to store the ZIP file. Example:

    mate:/archives

Make sure the destination path is correct and accessible.

4

Overwrite Existing Folder

Overwrite an existing folder: Enable this option if you want to replace any existing file or folder with the same name in the destination.

Enabling this option will overwrite the existing ZIP file or folder in the destination with the new one.

5

Assign File Path to Variable

Assign file path to variable (Required): Select a string-type variable (e.g., ziptest) to store the full path of the newly created ZIP file. Example:

ziptest

This allows you to reference the created ZIP file’s location in subsequent actions.

6

Execute and Review

Run the action. After execution, the specified file(s) or folder will be compressed into a ZIP file, and the path of the ZIP file will be stored in the output variable.


Inputs

Field
Description

File Path

The path of the file or folder to compress into a ZIP archive.

Zip Name

The name to assign to the resulting ZIP file.

Destination

The folder path where the ZIP file should be saved.

Overwrite Existing Folder

Enable to overwrite an existing file with the same name.

Assign File Path to Variable

Select a string variable to store the file path of the created ZIP archive.


Outputs

Field
Description

New File Path

The path of the created ZIP file (e.g.,mate:/archives/ZipTest.zip).


Example

  • File Path:

mate:/test.txt
  • Zip Name:

ZipTest
  • Destination:

mate:/archives
  • Output Variable (ziptest): The file mate:/test.txt will be compressed into the ZIP file mate:/archives/ZipTest.zip, and the output variable ziptest will store this path.


Additional Tips

PreviousDateNextFolder

Last updated 2 days ago

Was this helpful?

📚
Use Cases
FAQ