Categories

In this document, you will learn four ways to trigger a workflow in CoreView.

 

There are four ways to trigger a new workflow:

1. Schedule Workflow via CSV

2. Trigger an Event Under Audit Log 

3. Schedule Report

4. Open API

4a. How to Obtain your API Key

4b. How to Obtain your Companyid and Environment

4c. Setting up Postman 

4d. Use your API Key to get a JWT token 

4e. Run your Workflow 

 

1. Schedule Workflow via CSV

 

You can import the source file using:

  • URL
  • FTP
  • FTPS
  • SFTP


 

Then, you map the inputs in the specified .csv file to the names of the workflow execution inputs. Then, you can choose the scheduling options.

 

Note: You should ensure that all expected column names in the specified .csv source are matched exactly to the names of the workflow execution inputs. Still, if some of the column names do not match, the workflow can be run based on the input names that match CSV column names, but it could fail or not be executed correctly. 

 


If the workflow was run against multiple entries, then there will be several workflows performed (jobs here), and each will have its own id. Once all workflow(s) (jobs) are executed, the original CSV file will be substituted with the file that has the aggregation id added at the end of the original name file that is generated using the date and time the workflow was performed plus aggregation id for all jobs performed by workflow. So, the aggregation id is generated to combine the results from the multiple jobs performed.

 

2. Trigger an Event Under Audit Log 

CoreView enables the configuration of automated alerts for any event activity reported in Office 365 log files. The simplified wizard UI makes it easy for IT administrators to choose the available log categories and associated events from available picklists and activities to identify the security risks they want to monitor. The wizard UI walks the administrator through a step-by-step process to identify the log event and select the recipients to alert or the workflow to execute. These alert notifications are generated from the audit activities performed by CoreView on an almost real-time basis. When a preconfigured security watchdog setting matches a known compliance breach, an alert message is sent via e-mail to a specified distribution list or triggers the workflow.

 

To create, edit or delete an Event Alert, go to Audit – Alerts Reports – Manage Alerts.

An alert can be set for the following workloads:

  • Azure Active Directory
  • CRM
  • Exchange
  • Microsoft Flow
  • Microsoft Forms
  • Microsoft Stream
  • Microsoft Teams
  • OneDrive
  • PowerApps
  • Power BI
  • Project
  • Security Compliance Center
  • SharePoint
  • Sway
  • Threat Intelligence
  • Yammer

 

Then, you can choose the event (operation) to trigger and an option to send just an alert or start a workflow. So, the workflow will be performed on the triggered event in near real-time.

 

3. Schedule Report

You can schedule most of the reports available on our portal and set the workflow to be run under the 'Actions' section based on the chosen schedule settings.

 

Once you select the workflow, you have to auto map the inputs to ensure that they will be run correctly against the chosen report. Assure that you have chosen 'Send when' and 'is not empty' under schedule settings so that there will be input to run the workflow.

 

Note: it could be that the scheduled report always includes the same results, and the workflow will be run each time against the same user, 'disable user', for example, but you need to run the workflow just once against this user. You can then apply the tag to the user by adding the relative action 'Add tag' at the end of the workflow. You will modify your scheduled report settings by adding the report or column filter on' tags' does not contain 'tag added to the user at the end of the workflow' to avoid running this workflow against the users with the specific tag. 

 

Editing the workflow by adding 'Add tags' at the end of the workflow

  1. Editing the workflow by adding ‘Add tags’ at the end of the workflow



  1. Editing current settings of scheduled report by adding a report/column filter on ’tags’ does not contain ‘Your tag’.

 

 


4. Open API

To get started, you will need your API key, CompanyId, and the Workflow public API URL to call the Workflow public API.  

 

4a. How to Obtain your API Key

  1. You will click on your name avatar and select "Manage API Keys". 

 

Graphical user interface, application Description automatically generated 

You will be on the "Manage API Keys" page.

 

  1. Click "Manage", then "Add new App". This action will open a dialog box "ADD NEW APP".


Graphical user interface, application Description automatically generated


 

  1. You will add an 'App Name' (in this example, we have called ours "Workflow"), an "Expiration date" (defaults to one year), and any comments that you want to put in the "Notes" field.
  2. Click the blue checkmark in the top right of the dialog box to save.


 

Graphical user interface, application Description automatically generated 


 

Your unique API key is now created. 


Graphical user interface, text, application Description automatically generated 

 

 

  1. Copy the generated API key and save it in a secure place. It is displayed only once, and you cannot see it a second time.  

 

4b. How to Obtain your Companyid and Environment

For your CompanyId and your environment, please contact the CoreView Support Team and use the API URL below based on your environment.

 

 Location

Workflow API URLs

Auth API URLs

Europe

https://wfeuapi.coreview.com  

https://login02.coreview.com/api/auth    

Canada

https://wfcaapi.coreview.com  

https://login02.coreview.com/api/auth

East US

https://wfusapi.coreview.com  

https://login02.coreview.com/api/auth     

Gov US

https://wfus2api.coreview.com  

https://uslogin.coreview.com/api/auth

 

 

 

4c. Setting up Postman 

  1. Import the postman script into your Postman. 

 

Graphical user interface, text, application, email Description automatically generated 

 

  1. Set up your environment variables as follows 


Table Description automatically generated 

 

 

 

4d. Use your API Key to get a JWT token 

The API Key generated in the previous step does not allow you to run a Workflow directly.  This API Key allows you to call the CoreView Central Authentication API to get a JWT token, which you can use to trigger a Workflow.

 

Use the following URL based on your environment:

 

 Location

Auth API URLs

Europehttps://login02.coreview.com/api/auth
Canadahttps://login02.coreview.com/api/auth
East UShttps://login02.coreview.com/api/auth
Gov UShttps://uslogin.coreview.com/api/auth

 

Please refer to the "Get JWT Token" request on the attached Postman collection document for reference. 

  

You need to use your API Key as the Bearer Token in the Authorization of the Request.

  

Graphical user interface, text, application, email Description automatically generated 

 

Calling this API will give you this JSON output: 

 

 

Graphical user interface, text, application, email Description automatically generated 

 

  

{ 

    "userId": "123456", 

    "sessionId": "dflkgdfklgjdlkfgjpfg", 

    "userName": "username", 

    "displayName": " displayName ", 

    "bearerToken": "eyJ0exxxxxxxxxxxxxxx", 

    "refreshToken": "eyJ0eXAxxxxxxxxxxxx", 

    "profileUrl": "xxxxxxxxx", 

    "roles": [ 

        "Service" 

    ], 

    "permissions": [], 

    "responseStatus": {} 

} 

  

Keep the bearerToken value (your JWT token) you received so that you can reuse it to trigger your workflow. You can also save the refreshToken to ask for a new JWT token if this one expires. 

 

4e. Run your Workflow 

The CoreFlow API can now be called using the JWT token obtained in the previous step to start a workflow. 

 

Looking to the Postman collection, check the "Start Manual Executions" request.

 

To trigger your workflow, identify your workflow Id from your workflow definition details in CoreView (see screenshot below): 

 

 

Graphical user interface, application Description automatically generated 

 

Make sure in your request that: 

  • The JWT token you got from the previous call is set as your Bearer Token in this request, 
  • Your workflowId parameter is set as part of the request URL, 
  • Your companyId is set into the "x-scompany" header. 

 

Graphical user interface, text, application, email Description automatically generated 

 

 

Lastly, identify the required properties of your workflow input, looking into your workflow definition (Editing your workflow and clicking on the "Configure Execution Inputs"): 

 

Graphical user interface, text, application Description automatically generated 

Required inputs need to be sent in the request body as properties from the JSON (see the example below in Postman highlighting how to set input properties): 

 

Graphical user interface, text, application, email Description automatically generated 

  

As per supported values types (string, number, or boolean), values set as properties in the request follow the definition of those types in JSON.

  

Let's recap all steps for this request to be ready: 

  • Set the Bearer token to the JWT value you got from the previous call, 
  • Set the workflowId you want to run in the REST API path, 
  • Set the HTTP header "x-scompany" to your companyId value, 
  • Set the required inputs from your workflow into the request body. 

 

 

 

From that point, send your request, and your workflow will be on its way! 

 

Happy workflows! 


Open API Attachment json: 

Attachments (1)

json

CoreFlow Pub....json
6.71 KB