Retrieve Stub Email Items from Exchange using EAS and Rampiva Automate

The material in this document is for informational purposes only. The products it describes are subject to change without prior notice, due to the manufacturer’s continuous development program. Rampiva makes no representations or warranties with respect to this document or with respect to the products described herein. Rampiva shall not be liable for any damages, losses, costs or expenses, direct, indirect or incidental, consequential or special, arising out of, or related to the use of this material or the products described herein.

Introduction

This article describes how to configure Rampiva Automate to perform collections from Microsoft on-premise Exchange, identify stub email items in mailboxes, query and retrieve stub emails from the EAS email archive, and finally, reload the retrieved emails from EAS into an existing Nuix case.

Prerequisites 

  • Rampiva Automate 6.2.7 or later.

  • Established Nuix-to-Exchange connection.

  • EAS Middleware installed and configured.


Instructions - Preparing to Deploy the Workflow

A. Download the Retrieve EAS Stubs for Exchange Items_v1.1 from this KB Article.

Download the Rampiva Workflow.

 

Download the required TriggerExport.ps1 file.

 

B. Input the Exchange on-premise connection details into the Rampiva workflow.

1

Open Rampiva Workflow Designer.

2

Identify and input the following settings used to connect to the Microsoft Exchange server (2007-2016) environment.

Required connection values:

  • Exchange Username: The username used to access the mailbox account(s).

    • Rampiva workflow parameter: {exchange_username}

  • Exchange Password: The password used to access the mailbox account(s).

    • Rampiva workflow parameter:{exchange_password}

  • Exchange Mailbox: This setting defines which mailbox to collect. Multiple mailboxes should be listed in comma separated format.

    • Rampiva workflow parameter: {exchange_mailbox}

  • Exchange Mailbox Retrieval: This setting defines what attributes of the mailbox should be retrieved. Multiple attributes should be listed in comma separated format. Any combination of the following settings can be used.

    • Rampiva workflow parameter: {exchange_mailbox_retreival}

      • Available values:

        • mailbox

        • archive

        • purges

        • deletions

        • recoverable_items

        • archive_purges

        • archive_deletions

        • archive_recoverable_items

        • public_folders

 

3

Optional connection values:

  • Exchange URI: The path to the Exchange Web Service (e.g. https://ex2010/ews/exchange.asmx). It can be omitted to use auto-discovery setting based on the mailbox or username address.

    • Rampiva workflow parameter:{exchange_uri}

  • Exchange Domain: This optional parameter defines the Windows networking domain of the server account.

    • Rampiva workflow parameter:{exchange_domain}

  • Exchange Impersonation Type: : A boolean, defaults to false. This optional setting instructs Exchange to impersonate the mailbox user instead of delegating when the mailbox and username are different.

    • Rampiva workflow parameter:{exchange_impersonating}

4

Update the corresponding Parameter value in the Retrieve EAS Stubs for Exchange Items_v1.1 workflow.

5

Save the Workflow.

C. Input the EAS Archive connection details to be used in the Rampiva workflow.

1

Identify and input the following settings used to connect to the EAS Archive middleware application.

Required connection values:

  • ApiUrl: The network address of the EAS Middleware API. (e.g. http://localhost:8010/api).

    • Rampiva workflow parameter:{eas_api_url}

  • ApiUsername: The username used to access the EAS Middleware API.

    • Rampiva workflow parameter:{eas_username}

  • ApiPassword: The password used to access the EAS Middleware API.

    • Rampiva workflow parameter:{eas_password}

These values will be used in the workflow execution script TriggerExport.ps1.

param ([Parameter(Mandatory)]$EasManifestFile, $VerboseLogging=$False) #### Configuration section $ApiUrl = "http://localhost:8010/api" $ApiUsername = "admin" $ApiPassword = "changeme"
2

Update the corresponding Parameter value in the Retrieve EAS Stubs for Exchange Items_v1.1 workflow.

 

3

Save the Workflow.

D. Input additional workflow parameters.

1
  • EAS Trigger Export PowerShell: This required parameter defines the path to the PowerShell file used in the workflow

    • Rampiva workflow parameter:{eas_trigger_export_powershell}

The TriggerExport.ps1 is used to connect to the EAS Middleware application. It passes credentials to access the Middleware API, along with defining the Export location

2
  • EAS Out Folder: This required parameter defines the path to the PowerShell file used in the workflow

    • Rampiva workflow parameter:{eas_out_folder}

3

Save the workflow.

E. EAS Middleware Documentation

1