Create MSOnline PowerShell Workflow

This tutorial demonstrates how to create and publish an MSOnline PowerShell workflow using Workflow Studio. The workflow executes PowerShell cmdlets against MS Online and displays results in a grid format.

Overview

You will build a workflow that:

• Uses AzXPowerShellActivity to execute PowerShell commands in the MS Online microservice
• Retrieves contacts from Azure Active Directory using Get-MsolContact
• Displays results using DynamicPowershellResultsGrid

The workflow executes this PowerShell command:

Get-MsolContact | ConvertTo-Json

Prerequisites

• MS Online account store configured in EmpowerID
• Permissions to execute MS Online PowerShell cmdlets

info

For detailed information about PowerShell activities and their properties, see PowerShell Activity Concepts.

Create the Workflow

Step 1: Initialize Workflow

1. In Solution Explorer, right-click the Package node and select New Workflow > Flow Chart Workflow.

2. Save the workflow with a descriptive name (e.g., "MsOnlinePowershellWF").

Step 2: Add AzXPowerShellActivity

1. From the Activities tab, search for AzXPowerShellActivity.
2. Drag the activity to the designer window.
3. In the Properties tab, set Name to a meaningful value (e.g., "GetCallMsOnlineCmdlet").

Step 3: Configure PowerShell Command

1. Right-click the activity and select Edit Get/Set Data logic.

2. Add the PowerShell library reference:

   using PS = TheDotNetFactory.Framework.PowerShell;

3. Implement the SetDataCode method:

   public virtual void SetDataCode(uni.WorkflowExecutor context, uni.IActivity activity)
   {
       try
       {
           // Create PowerShell command
           PS.PSCommand cmd = new PS.PSCommand();
           cmd.IsScript = true;
           cmd.CommandText = "Get-MsolContact | ConvertTo-Json";
           
           var commands = new List<PS.PSCommand>();
           commands.Add(cmd);
           
           // Configure activity properties
           this.CurrentWorkflow.GetCallMsOnlineCmdlet.PSServiceType = AzPowerShellType.MSOnline;
           this.CurrentWorkflow.GetCallMsOnlineCmdlet.AccountStoreID = 2615; // Replace with your MS Online account store ID
           this.CurrentWorkflow.GetCallMsOnlineCmdlet.Commands = commands;
           this.CurrentWorkflow.GetCallMsOnlineCmdlet.RestrictDelayToSameServer = true;
           this.CurrentWorkflow.GetCallMsOnlineCmdlet.EnablePassiveResultsHandling = false;
           this.CurrentWorkflow.GetCallMsOnlineCmdlet.MaxWaitLoopCount = 10;
           
           TdnfTrace.Current.TraceData(TraceEventType.Verbose, 411, 
               "Starting to execute command: " + cmd.CommandText);
       }
       catch(Exception ex)
       {
           TdnfTrace.Current.TraceData(TraceEventType.Error, 411, 
               "Error executing PowerShell command: " + ex.Message);
           throw; // Re-throw to allow workflow error handling
       }
   }

   Key Configuration Properties:

   Property	Value	Description
   PSServiceType	AzPowerShellType.MSOnline	Specifies MS Online as the PowerShell service target
   AccountStoreID	Your account store ID	Identifies the MS Online account store for authentication
   RestrictDelayToSameServer	true	Ensures execution on the same server
   EnablePassiveResultsHandling	false	Disables passive result collection
   MaxWaitLoopCount	10	Maximum polling attempts for command completion

   caution

   Replace 2615 with your MS Online account store ID. Find this value in Object Administration > Account Stores by locating your MS Online account store and noting its ID.

Step 4: Add Results Grid

1. Search for DynamicPowershellResultsGrid in the Activities tab.
2. Drag the activity to the designer.
3. Set Name to "ShowResultsGrid" in the Properties tab.

Step 5: Connect Activities and Configure Results

1. Right-click AzXPowerShellActivity and select Edit Get/Set Data logic.

2. Implement the GetDataCode method to pass results to the grid:

   public virtual void GetDataCode(uni.WorkflowExecutor context, uni.IActivity activity)
   {
       // Transfer PowerShell results to the grid display
       this.CurrentWorkflow.ShowResultsGrid.Result = this.CurrentWorkflow.GetCallMsOnlineCmdlet.Results;
   }

3. Connect all activities in the workflow designer.

Step 6: Compile

Click the Compile button to compile the workflow code. Address any compilation errors before proceeding.

Publish the Workflow

1. Click the Compile and Publish button in the Workflow Studio toolbar.
2. In the Publish Workflow wizard that appears, click the Next button.
3. Select the host server and click Next.
4. Click Next again to begin compiling the workflow. Upon a successful compilation, Workflow Studio publishes the workflow.
5. Select Yes when prompted to restart one or more services.
6. In the Active Services window that appears, make sure the EmpowerID Web Role Service is selected and click Restart.
7. Click No when prompted to restart Workflow Studio.

Verify Workflow Execution

1. Log in to the EmpowerID portal.
2. Navigate to Low Code/No Code Workflow > Low Code Workflows.
3. Locate your published workflow and click the workflow name in the Run column.
4. Verify the grid displays MS Online contact data.

Related Topics

• PowerShell Activity Concepts - Learn about PowerShell activity properties and configuration
• Create Azure AD PowerShell Workflow - Build workflows for Azure AD services
• Create MSTeams PowerShell Workflow - Build workflows for Microsoft Teams