{"id":26718,"date":"2021-02-10T10:52:05","date_gmt":"2021-02-10T10:52:05","guid":{"rendered":"https:\/\/www.inogic.com\/blog\/?p=26718"},"modified":"2021-02-10T10:58:19","modified_gmt":"2021-02-10T10:58:19","slug":"using-environment-variables-in-dynamics-365-crm-part-2","status":"publish","type":"post","link":"https:\/\/www.inogic.com\/blog\/2021\/02\/using-environment-variables-in-dynamics-365-crm-part-2\/","title":{"rendered":"Using Environment Variables in Dynamics 365 CRM \u2013 Part 2"},"content":{"rendered":"

Introduction<\/strong><\/h2>\n

In our previous blog<\/a>, we understood the background and the purpose of the Environment Variable.<\/p>\n

In this blog we will see how to use it in our day to day solutions.<\/p>\n

As we make use of Plugins, Workflows, Scripts, Power Automate, etc. in our day-to-day solutions, let\u2019s see how to access and use the environment variables in each one of them.<\/p>\n

Plugins\/Workflows<\/u><\/strong><\/h2>\n

In our previous blog<\/a>, we created an Environment Variable with the schema name ‘new_apiurl’. Now, there could be Plugins and Workflows where we might need to use the value stored. Using the below methods we can get the value from the environment variable:<\/p>\n

\/\/\/<summary><\/p>\n

\/\/\/This method will be used to get the details of<\/p>\n

\/\/\/ Environment Variable Definition with the schema name new_apiurl<\/p>\n

\/\/\/<\/summary><\/p>\n

\/\/\/<param name=”service”><\/param><\/p>\n

\/\/\/<param name=”context”><\/param><\/p>\n

\/\/\/<param name=”tracing”><\/param><\/p>\n

\/\/\/<returns><\/returns><\/p>\n

privatestringGetEnvironmentVariableDefinition(IOrganizationService service,ITracingService tracing)<\/p>\n

{<\/p>\n

#region (*Local Variable*)<\/p>\n

stringfunctionName = “GetVariableDefinition”;<\/p>\n

stringfetchXml = string.Empty;<\/p>\n

EntityCollection definition = null;<\/p>\n

string value = string.Empty;<\/p>\n

#endregion<\/p>\n

try<\/p>\n

{<\/p>\n

\/\/Trace<\/p>\n

tracing.Trace(“Inside ” + functionName);<\/p>\n

\/\/Create the fetch xml query<\/p>\n

fetchXml = “<fetch version=’1.0′ output-format=’xml-platform’ mapping=’logical’ distinct=’false’>” +<\/p>\n

“<entity name=’environmentvariabledefinition’>” +<\/p>\n

“<attribute name=’environmentvariabledefinitionid’ \/>” +<\/p>\n

“<attribute name=’schemaname’ \/>” +<\/p>\n

“<attribute name=’createdon’ \/>” +<\/p>\n

“<order attribute=’schemaname’ descending=’false’ \/>” +<\/p>\n

“<filter type=’and’>” +<\/p>\n

“<condition attribute=’schemaname’ operator=’eq’ value=’new_apiurl’ \/>” +<\/p>\n

“<\/filter>” +<\/p>\n

“<\/entity>” +<\/p>\n

“<\/fetch>”;<\/p>\n

\/\/Retrieve the Environment Variable Definition with schemaname = new_apiurl<\/p>\n

definition = service.RetrieveMultiple(newFetchExpression(fetchXml));<\/p>\n

\/\/If the definition is found<\/p>\n

if (definiton != null&&definiton.Entities.Count> 0)<\/p>\n

{<\/p>\n

\/\/Call the method to get the Current Value associated to the Environment Variable Definition<\/p>\n

value = GetEnvironmentVariableValue(definiton.Entities[0], service, context, tracing);<\/p>\n

}<\/p>\n

}<\/p>\n

catch (InvalidPluginExecutionExceptionipex)<\/p>\n

{<\/p>\n

thrownewInvalidPluginExecutionException(functionName + ipex.Message);<\/p>\n

}<\/p>\n

catch (FaultExceptionfex)<\/p>\n

{<\/p>\n

thrownewFaultException(functionName + fex.Message);<\/p>\n

}<\/p>\n

catch (Exception ex)<\/p>\n

{<\/p>\n

thrownewException(functionName + ex.Message);<\/p>\n

}<\/p>\n

return value;<\/p>\n

}<\/p>\n

\/\/\/<summary><\/p>\n

\/\/\/This method will be used to get the Current value<\/p>\n

\/\/\/ associated to the environment definition<\/p>\n

\/\/\/<\/summary><\/p>\n

\/\/\/<param name=”entityDefinition”><\/param><\/p>\n

\/\/\/<param name=”service”><\/param><\/p>\n

\/\/\/<param name=”context”><\/param><\/p>\n

\/\/\/<param name=”tracing”><\/param><\/p>\n

\/\/\/<returns><\/returns><\/p>\n

privatestringGetEnvironmentVariableValue(EntityentityDefinition, IOrganizationService service, ITracingService tracing)<\/p>\n

{<\/p>\n

#region (*Local Variable*)<\/p>\n

stringfunctionName = “GetEvValue”;<\/p>\n

stringfetchXml = string.Empty;<\/p>\n

EntityCollection values = null;<\/p>\n

stringcurrentValue = string.Empty;<\/p>\n

#endregion<\/p>\n

try<\/p>\n

{<\/p>\n

\/\/Create the fetch xml query<\/p>\n

fetchXml = “<fetch version=’1.0′ output-format=’xml-platform’ mapping=’logical’ distinct=’false’>” +<\/p>\n

“<entity name=’environmentvariablevalue’>” +<\/p>\n

“<attribute name=’environmentvariablevalueid’ \/>” +<\/p>\n

“<attribute name=’value’ \/>” +<\/p>\n

“<attribute name=’createdon’ \/>” +<\/p>\n

“<attribute name=’schemaname’ \/>” +<\/p>\n

“<attribute name=’environmentvariabledefinitionid’ \/>” +<\/p>\n

“<order attribute=’createdon’ descending=’true’ \/>” +<\/p>\n

“<filter type=’and’>” +<\/p>\n

“<condition attribute=’environmentvariabledefinitionid’ operator=’eq’ value='” + entityDefinition.Id + “‘ \/>” +<\/p>\n

“<\/filter>” +<\/p>\n

“<\/entity>” +<\/p>\n

“<\/fetch>”;<\/p>\n

\/\/Retrieve the Environment Variable value associated to the Environment Variable Definition<\/p>\n

values = service.RetrieveMultiple(newFetchExpression(fetchXml));<\/p>\n

if (values != null&&values.Entities.Count> 0)<\/p>\n

{<\/p>\n

\/\/Get the Current Value associated to the Environment Variable Definition<\/p>\n

currentValue = values.Entities[0].GetAttributeValue<string>(“value”);<\/p>\n

}<\/p>\n

}<\/p>\n

catch (InvalidPluginExecutionExceptionipex)<\/p>\n

{<\/p>\n

thrownewInvalidPluginExecutionException(functionName + ipex.Message);<\/p>\n

}<\/p>\n

catch (FaultExceptionfex)<\/p>\n

{<\/p>\n

thrownewFaultException(functionName + fex.Message);<\/p>\n

}<\/p>\n

catch (Exception ex)<\/p>\n

{<\/p>\n

thrownewException(functionName + ex.Message);<\/p>\n

}<\/p>\n

returncurrentValue;<\/p>\n

}<\/p>\n

Scripts<\/u><\/strong><\/h2>\n

Similarly, we can also query the value of environment variable in a script as shown below -here, we have created a method where we are using the OData query to query the Environment Variable records.<\/p>\n

getValue = (executionContext: Xrm.Events.EventContext): void => {<\/p>\n

\/\/Local Variables<\/p>\n

letfunctionName: string = “onLoad”;<\/p>\n

let query: string = “”;<\/p>\n

letenvValue: string = “”;<\/p>\n

letalertStrings: any = null;<\/p>\n

letalertOptions: any = null;<\/p>\n

try {<\/p>\n

\/\/Create the query to get the Environment Variable Definition with schemaname “new_apiurl”<\/p>\n

query = “?$filter=schemanameeq ‘new_apiurl'”;<\/p>\n

\/\/Retrieve the Environment Variable Definition with schemaname “new_apiurl”<\/p>\n

Xrm.WebApi.retrieveMultipleRecords(“environmentvariabledefinition”, query).then(<\/p>\n

function (definition) {<\/p>\n

\/\/Create the query to get the Environment Variable Value associated to the definition with schemaname “new_apiurl”<\/p>\n

query = “?$filter=_environmentvariabledefinitionid_valueeq ‘” + definition.entities[0][“environmentvariabledefinitionid”] + “‘”;<\/p>\n

Xrm.WebApi.retrieveMultipleRecords(“environmentvariablevalue”, query).then(<\/p>\n

function (value) {<\/p>\n

envValue = value.entities[0][“value”];<\/p>\n

},<\/p>\n

function (error) {<\/p>\n

alertStrings = { text: functionName + ” :: ” + ex.message };<\/p>\n

Xrm.Navigation.openAlertDialog(alertStrings);<\/p>\n

});<\/p>\n

},<\/p>\n

function (error) {<\/p>\n

alertStrings = { text: functionName + ” :: ” + ex.message };<\/p>\n

Xrm.Navigation.openAlertDialog(alertStrings);<\/p>\n

});<\/p>\n

}<\/p>\n

catch (ex) {<\/p>\n

alertStrings = { text: functionName + ” :: ” + ex.message };<\/p>\n

Xrm.Navigation.openAlertDialog(alertStrings);<\/p>\n

}<\/p>\n

}<\/p>\n

Power Automate<\/u><\/strong><\/h2>\n

We can even use the Environment Variables in the Power Automate as below.<\/p>\n