Page Comparison

This tutorial will create and publish an MSTeams PowerShell Workflow and execute a cmdlet using the WFSWorkflow Studio. Please read through the concepts and important properties to know more about how WFS Workflow Studio supports executing PowerShell cmdlets. We will cover the following in this tutorial.

• Create a workflow that uses AzXPowerShellActivity, which will run the command below in MS TeamsMicroservice. This command “Retrieves all group members from MSTeams with the given ID and converts the results into JSON. “
  

  Code Block
  Get-TeamUser -GroupId 06f979d3-78be-455c-8bb1-335788a92928 | ConvertTo-Json

• We will include DynamicPowershellResultsGrid Activity in the Workflow to view the results in a grid.

• Publish the Workflow

• Verify the workflow Workflow displays the expected results by running it in the EmpowerID UI.

...

1. In the Workspace tree of Solution Explorer, right-click the Package node where you want to create the Workflow and select New Workflow > Flow Chart Workflow from the context menu.
   

   

2. The Workflow Designer will load a flowchart workflow with default shapes and names.

3. Save the Workflow with an appropriate name. Click on the Save icon, provide a File Name in the dialog, and click the Save button. Once you save the Workflow, the WFS Workflow Studio will reload the Workflow. In the screenshot below, we are saving the Workflow with the Name MSTeamsPowershellWF.
   
   

   Insert excerpt
   IL:Folder Structure Callout IL:Folder Structure Callout name FolderStructure nopanel true

   
   
   

4. Let’s add an activity. Click on the Activities Tab and Search for AzXPowerShellActivity. Drag and drop the Activity to the designer window.
   

   

5. Select the Activity, click on the Properties tab and change the Name to reflect your activity purpose. In this example, we are naming the Activity CallGetTeamsCmdlet and using the same text for the description.
   

   

   
   

6. Right-click on the Activity and select Edit Get/Set Data logic in the context menu.
   

   

7. Add a using reference to the PowerShell library.
   

   Code Block
   using PS = TheDotNetFactory.Framework.PowerShell;

8. Paste the code for the SetDataCode method. Please ensure the following important property values are correctly set for the code to work.

   • PSServiceType : Set the value of PSServiceType to AzPowerShellType.MSTeams to make the AzXPowerShellActivity work with Microsoft Teams Powershell.

   • AccountStoreID: Set the value to the right account store so that the current user executing the PowerShell commands can be authenticated from the account store.

     Code Block

     public virtual void SetDataCode(uni.WorkflowExecutor context, uni.IActivity activity) { //TODO: Set activity properties here. try { PS.PSCommand cmd = new PS.PSCommand(); cmd.IsScript = true; cmd.CommandText = " Get-TeamUser -GroupId 06f979d3-78be-455c-8bb1-335788a92928 | ConvertTo-Json"; var commands = new List<PS.PSCommand>(); commands.Add(cmd); this.CurrentWorkflow.CallGetTeamsCmdlet.PSServiceType = AzPowerShellType.MSTeams; this.CurrentWorkflow.CallGetTeamsCmdlet.AccountStoreID = 2615; this.CurrentWorkflow.CallGetTeamsCmdlet.Commands = commands; this.CurrentWorkflow.CallGetTeamsCmdlet.RestrictDelayToSameServer = true; this.CurrentWorkflow.CallGetTeamsCmdlet.EnablePassiveResultsHandling = false; this.CurrentWorkflow.CallGetTeamsCmdlet.MaxWaitLoopCount = 10; TdnfTrace.Current.TraceData(TraceEventType.Verbose, 411, "!!!!!######Starting to execute the command: " + cmd.CommandText); } catch(Exception ex) { TdnfTrace.Current.TraceData(TraceEventType.Verbose, 411, "!!!!!######Something blew up executing the command"); } }

9. Now, add another activity to receive the results from the PowerShell commands. Search for DynamicPowershellResultsGrid in the Activities tab and drag-drop the Activity to the designer.
   

   

10. Select the DynamicPowershellResultsGrid Activity, click on the Properties tab and change the Name to something meaningful. In this example, we renamed it to ShowUserResults and used the same text for the description.

11. Select the AzXPowerShellActivity in the workflow or GetCallMsOnlineCmdlet Activity in this example. Right-click on the Activity and select Edit Get/Set Data logic in the context menu. Paste the code into the GetDataCode method.
    

    Code Block
    public virtual void SetDataCode(uni.WorkflowExecutor context, uni.IActivity activity) { this.CurrentWorkflow.ShowUserResults.Result = this.CurrentWorkflow.CallGetTeamsCmdlet.Results; }

12. Please ensure all the activities are connected and the necessary codes are included in the methods as instructed above.
    

    

13. Click on the Compile icon to compile the Workflow code.
    

    

...

We are all set to publish the Workflow. Please follow the instruction, You can find the instructions and information about publishing the workflow items can be found here.

Verify the Workflow is Working

1. Log in to your EmpowerID portal.

2. Navigate to Object Administration → Workflows.
   

   

3. Search the Workflow published earlier and click on the workflow name in the Run column to execute the Workflow.
   

   

4. You should be able to see the Grid that populates all group members from MSTeams with the given ID into the gridGrid.
   

   

...