Microsoft Dataverse

learn how to connect microsoft dataverse to engini, enabling efficient integration of your business data and application logic with the dataverse connector, you can access structured data in real time, automate workflows, and unify information across different services effortlessly manage entities, relationships, and custom tables to support business processes and analytics to get started with the microsoft dataverse, create a free account at microsoft or use your organizational microsoft account connecting engini to microsoft dataverse enter your engini account at https //app engini io/ navigate to connections page by clicking on the connections on the left side bar or by clicking https //app engini io/connections click on the “new integration” option located at the top bar choose “microsoft dataverse” option from available applications enter the following details in the “add connection” form connection name – a unique identifier for the connection within engini url of dataverse environment – the url of a dataverse environment is the web address you use to access your specific dataverse workspace, where your data is stored and managed to access this, sign in to your microsoft dataverse account and navigate to settings in the opened menu, select developer resources navigate to the section labeled ‘web api endpoint’ and copy the base url highlighted in the picture to engini microsoft signin – this is the authentication process where users log into their microsoft account to gain access to microsoft services click on the button to sign in to your microsoft account access token & refresh token – automatically populated post connecting to a your microsoft account access token – a temporary security token that allows your application to access protected resources or apis on behalf of the user it serves as proof that the user has granted permission refresh token – a token with an extended lifespan used to request a new access token once the original one expires, without requiring the user to log in again click on the save button to save the connection after you’ve saved the connection, a window will open displaying all available entities and actions from this window, select the entities and actions you want to use note after you’ve saved the connection, you can add additional objects and actions on the right side of the saved connection, you’ll see three dots click on the three dots and then click on “select database objects” a window will open displaying all available entities and actions, just like when you saved your connection from this window, select the new entities and actions you want to use once you’ve finished selecting the additional entities and actions, click save triggers entity event trigger triggers when an event type is activated event type – select the type of event that will trigger the workflow to start common event types include creation, update, or deletion activities create record this activity creates a new record in microsoft dataverse based on yours selected object object type – select the object you want to create (e g , accounts, contacts) after selecting a specific object, you will have the option to populate it’s fields by using “add field” add field by clicking the “add field” button, you can choose how to fill in the various fields in the record you are creating you can add one field to the activity or more fields to the activity definitions, up to the number of fields you have in the selected object the fields vary depending on the selected object choose from the drop down the field you want to fill click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate create records batch this action creates multiple new records in microsoft dataverse in one batch operation object type – select the type of object (table) where the records will be created data list – provide the list of records to be created each item in the list should match the structure of the selected object type after selecting a specific object, you will have the option to populate it’s fields by using “add field” add field by clicking the “add field” button, you can choose how to fill in the various fields in the records you are creating you can add one field to the activity or more fields to the activity definitions, up to the number of fields you have in the selected object the fields vary depending on the selected object choose from the drop down the field you want to fill click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate delete record this action deletes a specific record from microsoft dataverse based on the selected object type object type – select the type of microsoft dataverse object you want to delete (e g , accounts, contacts) after selecting the object type (e g , accounts), provide the unique id of the specific record you want to delete for this object, it’s the account id delete records batch this action removes multiple records from microsoft dataverse in a single batch operation object type – select the type of object from which the records should be deleted data list – provide the list of records to be deleted each item in the list should match the structure of the selected object type after selecting the object type (e g , accounts ), provide the unique id of the specific records you want to delete execute action this action executes an operation from the list you selected during the connection setup action type – click the dropdown and select the specific action to be performed from the list after selecting the action type (e g , send email), provide the necessary details for the action issue send – define when or under what condition the email should be sent add field – by clicking the “add field” button, you can choose how to fill in the various fields for the action being executed you can add one field to the activity or more fields to the activity definitions, up to the number of fields you have in the selected object the fields vary depending on the selected object choose from the drop down the field you want to fill click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate get record this action retrieves a specific record from microsoft dataverse based on the selected object type object type – select the type of microsoft dataverse object you want to retrieve (e g , accounts, contacts) after selecting the object type (e g , accounts ), provide the necessary detail accountid – provide the unique identifier of the record you want to retrieve output fields – specify which fields you want to retrieve from the record get records this action retrieves multiple records from microsoft dataverse based on the selected object type you can optionally apply filters, sorting, and set a limit (top n) on how many records to fetch object type – select the type of object you want to retrieve records from add filters – you can specify which records will be returned from the search results by utilizing the “add filter” button choose from the drop down the field you want to filter by select the condition you want the records to meet for the selected field click on the field to show the tooltip with all the options you can choose you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using functions and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate add sorting you can define your own sort for the records click on the “add sorting” button choose from the drop down the field you want to sort by choose the sorting option descending or ascending you can do a multi sort by choosing to sort more than one field use the arrows on the right to select the field that will be used as the primary sort, secondary, etc top n – you can specify how many records with the same value you want to get click on ‘top n’ and enter the maximum number of values you want to retrieve if you set top n = 1 , a single record will be returned instead of an array if no record is found, the action will fail, allowing you to implement an if condition within the workflow this can be useful for processes where the existence of a record determines the next steps in the workflow get records batch the get records batch action retrieves multiple records from microsoft dataverse in a single call based on a list of ids object type – select the type of object to retrieve records from data list – provide the list of records to be retrived each item in the list should match the structure of the selected object type after selecting the object type (e g , accounts ), provide the unique id of the specific record you want to retrieve update record this action updates an existing record in microsoft dataverse it allows you to change one or more fields within a specified object object type – select the type of object that contains the record you want to update after selecting the object type (e g , accounts ), provide the necessary detail accountid – this field requires the unique identifier (id) of the record you want to update add field – by clicking the “add field” button, you can choose how to fill in the various fields in the records you are updating you can add one field to the activity or more fields to the activity definitions, up to the number of fields you have in the selected object the fields vary depending on the selected object choose from the drop down the field you want to fill click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate update records batch this action updates multiple existing records in microsoft dataverse in one request object type – select the type of object that contains the records you want to update data list – provide a list of records to update after selecting the object type (e g , accounts ), provide the necessary detail accountid – this field requires the unique identifier (id) of the record you want to update add field – by clicking the “add field” button, you can choose how to fill in the various fields in the records you are updating you can add one field to the activity or more fields to the activity definitions, up to the number of fields you have in the selected object the fields vary depending on the selected object choose from the drop down the field you want to fill click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate initialize object array this action initializes an array variable that holds objects of the selected type variable name – enter a name for the array variable that will store the list of objects object item type – select the type of object that each item in the array will represent after selecting a specific object item type, you will have the option to populate it’s fields by using “add field” add field by clicking the “add field” button, you can choose how to fill in the various fields in the object you are creating you can add one field to the activity or more fields to the activity definitions, up to the number of fields you have in the selected object the fields vary depending on the selected object choose from the drop down the field you want to fill click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate append to object array this action adds a new object to an existing object array variable that was initialized earlier in the workflow variable – select the array you initialized in the previous steps after selecting the variable, the “add field” option becomes available add field by clicking the “add field” button, you can choose how to fill in various fields in the object you are creating you can add one field to the activity or more fields to the activity definitions, up to the number of fields you have in the selected object the fields vary depending on the selected object choose from the drop down the field you want to fill click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate map object array the map array activity allows you to transform a list of data items into a new data list based on the object’s properties and values you choose data list – choose a data list that you’ve obtained from previous activities in your workflow this data list typically contains an array of objects that you want to process and transform object name – define the type of objects from the drop down that will be stored within the array add field – by clicking the “add field” button, you can choose how to fill in the various fields when you are mapping choose from the drop down the field you want to fill click on the empty field to the right of the drop down to be shown the tooltip with all the options you can use to fill the field you can populate the field in one of the following options static value – number / string when using strings, you need to surround them with single quotes (‘) property value from a previous activity (using the tooltip that opens when clicking on the field) expression – using functions and/or previous activity properties and/or static values (using the tooltip that opens when clicking on the field) repeat steps 1 3 for all the fields you want to populate send api request this action allows you to send a custom api request directly to the microsoft dataverse api base url – this is the root url of the api you’re sending the request to relative url – you can specify additional path segments or parameters that need to be added to the end of the automatically generated url this allows you to customize the specific request you want to perform method – select the http method (e g , get, post, put, delete, patch) body type – defines the format of the data in the body of your request a commonly used value is application/json , which means the body will contain a json formatted payload body – contains any data that is being sent to the server add headers – additional metadata about the request, such as the type of data that engini can accept, the length of the request body, and authentication information click on the “add headers” button to add a header click on the headers field to enter the key, and on the value field to enter a value each header consists of a key value pair, where the key is the name of the parameter, and the value is the data associated with that parameter click on the “add” button to add more headers add queries – the query refers to the parameters or data that are included in the url of an http request to provide additional information or instructions to the server click on the “add queries” button to add a header click on the queries field to enter the key, and on the value field to enter a value each query consists of a key value pair, where the key is the name of the parameter, and the value is the data associated with that parameter click on the “add” button to add more queries