How to Create & Manage Custom Actions

Modified on Wed, 06 Jul 2022 at 02:38 AM

This article will cover how to create and manage custom actions in CoreView.  
Note: Some knowledge of PowerShell may be required.  


Follow these steps to create a custom action: 


  • Log into the portal 
  • Select the Manage tab 
  • Click on “Manage custom actions” 
  • Click Create

 

  • Add a title and a brief description. 
                                             
  • In the target section you define the Custom Action target, choose one of the available targets from the drop-down list.  

 



Note: The virtual tenant is not applied on a target free custom action (Target None). 

  •  Once you chose a target, you can add columns to the table and also filter them by clicking on the textbox above columns and choosing the filter that you want to apply



     






Note: Operators will perform the custom action won't be able to change these filters set by tenant admin during custom action configuration.


  • In the Input tab you can set the Variables coming from the previous table. They can easily be added or deleted by clicking the icons next to the names. The variables will be automatically embedded in the PowerShell script.


  



  1.  

  • In the Script tab you need to add your Powershell script. Once added, the parameters and variable will be automatically embedded in your script. 

 

When we execute a custom action, it is essential that all the channels of the management session are connected otherwise the custom action will fail. Alternatively, you can specify the channel the custom action needs to its execution.  
 
For example, if a custom action needs only Exchange channel is sufficient to set this tag into the PowerShell script:<# 
Exchange 
#> 
 

These are the possible values: 

  • ActiveDirectoryOnPremises 
  • ExchangeOnPremises 
  • MsOlService 
  • MicrosoftTeams 
  • AzureActiveDirectory 
  • SharePoint 

 

Now, you can save it as a Draft and run a preview of the action. The preview option is available only for the Admin who generates the Custom Action.  

 

 

  • Once you're ready to submit the Custom Action, hit the Submit button.  Our team will review and approve/reject the Custom Actions to verify that they have no security or performance impacts on CoreView platform. 


Once the action has been approved, you can publish it, so, it’ll become available in the wizard within the custom actions category and they are ready to be used in the workflow as well.  

You will be able to manage it in the same way as any other Management Action by using Virtual Tenants and/or Manage Permissions. 

 

Here are connections currently supported: 

  • Exchange Online 
  • Exchange on premises (Hybrid Agent needed) 
  • MsOlService 
  • Active Directory (Hybrid Agent needed) 
  • Azure Active Directory 
  • Microsoft Teams 
  • Skype for Business 
  • Security and Compliance 
  • Sharepoint (Feature Flag needed) 

 

Note: if you need to create a custom action that will perform onpremises exchange commands you need to add the prefix O365. The prefix parameter is essential to avoid name conflicts that may occur when a different module has the same command name. i.e.: Get-Mailbox will become in CoreView Get-O365Mailbox 

 

Required PowerShell Versions 

CoreView only supports specific versions of PowerShell. Please ensure that your script has been tested against the following versions.  

Module 

Version 

AzureAD 

2.0.2.137 

MSOnline 

1.1.183.57 

MicrosoftTeams 

4.4.1 

Microsoft.Graph 

1.9.2 

MSAL.PS 

4.37.0.0   

ExchangeOnlineManagement 

2.0.5 

Microsoft.Online.SharePoint.PowerShell 

16.0.20616.12000 

SharePointPnPPowerShellOnline 

3.26.2010.0 

 

Note: Microsoft has announced it is deprecating AzureAD and MSOnline cmdlets in late 2022. If you are leveraging these, please look to change your scripts to leverage the Graph API instead. Microsoft provides documentation to help assist in mapping current functions to new ones.  

 

 

 

FAQs 

Can I edit or delete a Custom Action? 
At this stage, it is not possible to edit or delete a custom action that was already reviewed. The custom action can be edited or deleted only in Draft status. 
 

What is the role required to create a custom action? 
Only operators with tenant admin role will be able to create a custom action. 
 

I just created a custom action, and it is in a submitted state now. What does it mean? 
It means that the team received the request and within 24 hours will be reviewed for security and performance impacts and approved/rejected. 

 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us how can we improve this article!

Select atleast one of the reasons

Feedback sent

We apprciate your effort and will try to fix the article