Skip to main content
On Premises Engine - Setup Microsoft Exchange

Maintain accurate and comprehensive contact records within your secure environment

Updated yesterday

Implementing the SigParser On-Premises Engine can enhance your organization's ability to maintain accurate and comprehensive contact records while ensuring data remains within your secure environment; all email and calendar data is processed within your organization's network.

Note: You must coordinate with the SigParser team before proceeding with these steps. They will enable the On-Prem functionality for your account and schedule a call to guide you through the setup process.


Overview

  1. Virtual Machine Deployment: Install the On-Premises Engine on a virtual machine within your network. This VM will handle the processing of emails and calendar data.

  2. Configuration: Adjust settings to connect the engine to your Microsoft Exchange or Microsoft 365 environment. This includes setting up necessary permissions and specifying which mailboxes to monitor.

  3. Scheduled Tasks: Configure tasks to run the engine at desired intervals, ensuring continuous and up-to-date data extraction.

Estimated Time to complete: 1 hour with help from SigParser team.


To Start

You must have access to the following:

  • Access to your organization's SigParser account

  • Admin access to your organization’s Exchange Admin Center

  • The ability to run Powershell commands

  • A list of email addresses you wish to connect and scan in SigParser

  • Prepare a Windows Virtual Machine to run the SigParser application


Create a Windows Virtual Machine

Create a new Windows virtual machine (VM). The VM is where all the scanning and processing of emails and calendar meetings will be done.

See Virtual Machine Sizing for more information.


Configure Virtual Machine Settings

  • Operating System

    • Windows Operating System

    • OS-orchestrated patching: patches will be installed by OS

  • Network Access

    • Outbound:

      • Amazon AWS

        • US: logs.us-west-2.amazonaws.com - port 443

        • EU: logs.eu-central-1.amazonaws.com - port 443

      • ipaas.sigparser.com - port 443

      • serialkeymanager.com - port 443

      • app.cryptolens.io - port 443

      • time.windows.com - port 123

  • Backups

    • Enable backup

    • Backup policy: (new) DailyPolicy


Open a Notepad file on the VM to temporarily store ID values

  • Create a new Notepad file

  • Copy and paste the following into the file

    • USERNAME:

    • PASSWORD:

    • SIGPARSER API KEY:

  • You will fill in these values in the following steps. These values will be used to create and test the MS365 connection and configure the On Premise engine settings.


Create a Microsoft 365 “SigParser” User

Follow the instructions below to create a Delegated User account and update mailbox permissions.

  • Select Add a user

  • NOTE: you will need the login credentials for this user account (username and password) in the following steps.

    • Display Name: SigParser

    • Username: sigparser

    • Password: save the password you create for following steps.

  • Select Next

  • Use or buy a license with email access for this user.

    • The cheapest option is probably the Exchange Online (Plan 1)

  • Select Next

  • Optional Settings: User (no Admin Center access)

  • Select Next

  • Select Finish adding.


Add "SigParser" User Credentials to Notepad

  • On your Notepad file, add the username and password for the SigParser user in the corresponding fields.


Update Mailbox Permissions

Use the following steps for each mailbox you want SigParser to scan:

  • Select the user (mailbox owner) to open the profile

  • Select Mail > select Read and Manage Permissions (under Mailbox Permissions)

  • Select Add permissions

  • Select the SigParser user account you created

  • Select Add

  • Repeat for each mailbox you want to connect to SigParser via this connection.

Alternatively, you can run the PowerShell command found in THIS help article.


Wait for Microsoft 365 user permissions to update

It can take up to one hour for Microsoft 365 permissions to update.


Generate a SigParser Application API Key

  • Log into your organization's SigParser application at https://app.sigparser.com/

  • Go to Settings > Developers

  • Select "New API Key"

  • Name the API Key "On Premise Engine" > select all checkboxes > select Generate Key

  • Copy the API Key value and paste into the Notepad file

    • SIGPARSER API KEY: xxxxxxxxxxxxxxx

Note: The SigParser team must enable this functionality on your account.


Download On Premise Engine to Virtual Machine

  • Log into your Virtual Machine

    • Make sure that Google Chrome or Microsoft Edge are installed

  • In Windows Explorer turn on visibility of file extensions

  • Download the SigParser On Premise Engine zip file to the Virtual Machine

    • Right click on the Zip file > select Extract All…

    • Enter the following file location: C:\sigparser

    • Select Extract

    • Wait for the extract to finish

Note: The SigParser On Premise Engine zip file will be provided by the SigParser team.


Create Mailboxes Text File

Follow these instructions to find members of a Distribution Group and add to a mailboxes.txt file.

See section: Exchange - Find contacts in Distribution Group and add to mailboxes.txt file.


Configure On Premise Engine Settings

  • Go to C:\sigparser\EmailFetcher folder

  • Rename the file appsettings-template.json to appsettings.json

  • Once renamed, open the file appsettings.json.

  • Within the file, input the following values into the corresponding fields. Values must be placed within the double quotes. Reference the values in your notepad.

    • EmailProvider: Exchange

    • Instance: Enter your company name

      • Example: “Acme Corporation”

    • AllowedPatterns: Enter which email domains should be allowed.

      • Use * for all domains, which is best for most installations.

    • DenyPatterns: Enter which email domains will not be processed

      • Enter your own company domains here so internal emails aren't processed. Separate multiple domains with commas.

    • SigParser API Key: [from notepad]

    • ServerUrl: Enter your Exchange ServerURL

    • Email Address: [from notepad]

      • Enter the email address for the Microsoft 365 “SigParser” user account you created

    • Password: [from notepad]

      • Enter the password for the Microsoft 365 “SigParser” user account you created

    • UseImpersonation: true

      • If using impersonation to access any mailbox use this. Otherwise, set to false.

    • ExchangeVersion: Enter the version of Exchange your server is running. Choose the highest version that is less than or equal to your version.

      • Example: "Exchange2016"

    • MailboxFileList: Enter the file path for the mailbox list text file

      • Example: "../mailboxes.txt"

  • Once the values are entered, Save the updated appsettings.json file.


Test Email Fetcher

  • Within the EmailFetcher folder, right click on the background > select Open in Terminal

  • Type cmd > select Enter

  • Type emailfetcher.exe > select Enter

  • Once the command begins running successfully, select Ctrl + C or close the Terminal


Configure Scheduled Task to Automatically Run On Premise Engine

  • Open Task Scheduler

  • Select Create Basic Task

  • Configure the task:

    • Name the task: SigParser Email Fetcher

    • Description: Optional > select Next

    • Task Frequency: Daily > select Next

    • Start: leave default date

    • Recur every: 1 days > select Next

    • What action do you want the task to perform: Start a program > select Next

    • Program/script: select Browse > select C:\sigparser folder > scroll down and select the EmailFetcher Application

    • Add arguments (optional): leave blank

    • Start in: C:\sigparser\EmailFetcher > select Next

      1. This must match the first part of the Program file path exactly.

    • Select Finish

Additional Settings

It is recommended to create a designated Service Account to run the task scheduler. This ensures that the task will run even if the employee is not logged in or leaves the company.

  • Right click on the task > select Properties

  • Select: Run whether user is logged on or not > select OK

  • Enter credentials for the designated service account


Test the Scheduled Task

  • Right click the task from the list > select Run


View Logging

  • Open Event Viewer > select Windows Logs > select Application


Setup Complete

The setup is now complete.


If you have any questions, send us an email at support@sigparser.com. You can also book a demo session HERE.

Did this answer your question?