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
      • 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
    • 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
  • 🎓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
  • Mate Agent Installation
  • Post-Installation Configuration
  • Adding Paths to Environment Variables
  • Adding Log On Credentials to MAGateway Service
  • Port Policy for Communication
  • Agent Server Port Configuration

Was this helpful?

  1. Installation Setup
  2. Mate Agent Installation

Mate Agent Installation

Guides users through the installation of the Mate Agent, which facilitates workflow execution.

PreviousMate Agent InstallationNextMate Agent Update

Last updated 6 months ago

Was this helpful?

Download Links

Before proceeding with the installation, please ensure that you have reviewed the hardware and software requirements, as well as the port configurations, from the corresponding documentation section. This is essential to avoid any issues during or after installation, particularly when setting up an on-premises Mate Agent.


Introduction

The Mate Agent is a crucial component responsible for executing automation tasks in the background without the need for user intervention. This document serves as a comprehensive guide for the installation of the Mate Agent on an on-premises server, along with the necessary port configurations to ensure secure and efficient communication within the Autom Mate ecosystem.

Mate Agent Installation

1

Download the Mate Agent Setup File

  • Navigate to the Mate Agents menu in the "My Environment" section.

2

Run the Setup File

  • Run the MateAgent.exe file as an administrator.

  • This ensures that the installation has the necessary permissions to complete successfully.

3

Installation Wizard - Setup Choices

  • The installation wizard will prompt you to check your installation choices.

  • Review your choices and click the "Next" button to proceed.

4

Choose the Installation Directory

  • Determine the directory where the Mate Agent will be installed.

  • After selecting the directory, click the "Next" button.

5

Accept the License Agreement

  • Carefully read through the license agreement.

  • Once reviewed, accept the terms and click "Next" to proceed.

6

Application Settings Verification

  • Before beginning the installation, verify that the application settings are correct.

  • Click the "Installation" button to initiate the process.

7

Installation Progress

The installation will begin. You can click "Show Details" if you want to view the detailed progress of the installation.

8

Completing the Installation

Once the Mate Agent is installed successfully, click "Finish" to close the installation wizard.


Post-Installation Configuration

Adding Paths to Environment Variables

In some cases, the necessary paths for the Mate Agent might not be automatically added to the system’s environment variables. If they are not added, follow these steps to do so manually:

1

Open System Properties

Press Windows + R, type SystemPropertiesAdvanced, and click OK.

2

Access Environment Variables

In the Advanced tab, click the "Environment Variables" button.

3

Edit System Path Variable

Under System Variables, locate the variable named Path. Select it and click "Edit".

4

Add Missing Paths

  • If the following paths are not already added, add them one by one by clicking "New":

    • C:\mateagent\opencv\build

    • C:\mateagent\opencv\build\bin

    • C:\mateagent\Tesseract-OCR

    • C:\Program Files\nodejs (if it is not added automatically)

  • Click OK to save the changes.


Adding Log On Credentials to MAGateway Service

To activate the use of the Desktop Actions library, the MAGateway service requires an administrator user with Task Scheduler authority. If the default admin user lacks this authority, follow these steps:

1

Open Services

Press Windows + R, type services.msc, and click OK.

2

Locate and Configure MAGateway

Find MAGateway in the list of services, right-click it, and select "Properties".

3

Log On Configuration

  • In the Log On tab, enter the credentials for the admin user.

  • Click "Apply" and then "OK".

We strongly recommend performing the installation of both the Autom Center and Mate Agent on a fresh server to avoid potential conflicts with existing software and ensure optimal performance.


Port Policy for Communication

The port policy for Autom Mate ensures secure and efficient communication between the Mate Agent, Autom Mate Cloud, and other system components. Adhering to this policy is critical for the smooth operation of the system.


Agent Server Port Configuration

Below is a list of ports used for communication and various services:

5051 (TCP)
  • Agent: Inbound traffic allowed.

  • Autom Center: Outbound traffic allowed.

443 (TCP)
  • Agent: Outbound traffic allowed.

  • Autom Center: Inbound traffic allowed.

Note

Outbound traffic is restricted on the server hosting the Mate Agent, except for ports 443, and 5051.

Importance of Port Policy

Implementing a well-defined port policy is essential for maintaining the security and efficiency of the Autom Mate system. By configuring the necessary ports for inbound and outbound traffic, you enable seamless communication between the Mate Agent, Autom Mate Cloud, and other system components, thereby enhancing the overall performance and security of the system.

💾

Version 4.2.0

Download the MateAgent setup file.

Mate Agent Installation
Page cover image