Archive Shuttle 11.0 - Administration Guide

Running PowerShell with Archive Shuttle

It is possible to add customized steps into a Stage 2 workflow and to execute PowerShell scripts. These can perform customer or environment specific actions. There are essentially two steps which need to be performed:

Addition of scripts

Customization of the Workflow

Addition of scripts

This section of the user interface allows an administrator to add PowerShell scripts to perform various tasks.

Scripts can be added, edited and deleted. When adding a script it should be given a friendly name, and description. The script itself can be added directly, or it can be uploaded from a file that you already have.

Customization of workflow

PowerShell scripts can be added to an existing workflow. It is also possible to add multiple scripts, if required. To add a script edit the desired workflow, and from the right hand side of the screen click on the PowerShellScriptExecutionRunScript command. This will add that command to the bottom of the workflow.

The command can the be moved to the appropriate position in the workflow.

The command in the workflow needs to be edited so that you can provide the name of the script that you want to execute.

Sending an email to a user when their migration is complete

You can send an email to a user when their migration is complete using PowerShell, as described below.

Add the following script:

Param($smtp,$emailSendAccount,$userName,$userEmail) $subject = "Notification: $userName - Migration of your data COMPLETED!" $body = "Dear <b><font color=green>$userName</b></font>, <br>" $body += "<p>migration of your <b>mailbox</b> successfully finished.<br>" $body
+= "<p><p> <i><font size=2>This message has
been automatically generated by QUADROtech Archive Shuttle system, click
<a
href=http://www.quadrotech-it.com/products/archiveshuttle/>here</a>
to check QUADROtech's website.</font></i><br>" Send-MailMessage –From $emailSendAccount –To $userEmail –Subject $subject –Body $body -BodyAsHtml -SmtpServer $smtp -Port 25

Add the following parameters:

smtp

– any valid SMTP server inside the organization

emailSendAccount

– an email address that the service account running the PowerShell Execution module has access to

userName

– Token: {UserFirstName}

userEmail

– Token: {PrimarySMTPAddress}

It is advised to test the Send-MailMessage command line via PowerShell to refine the parameters that might be required by your SMTP server and to ensure that the message looks good in an email client.

Finally, the script execution has to be added to your chosen workflow.

Variables that can be used in PowerShell execution

The table below identifies the PowerShell variables/token that can be used with the Stage 2 workflow command to run a PowerShell script in Archive Shuttle.

Troubleshooting

Archive Shuttle Troubleshooting can be broken down in to a number of different areas, as outlined below.