Obtener o actualizar un valor de la configuración mediante la API del cliente
Artículo
Las configuraciones son componentes de la solución que permiten a los desarrolladores configurar rápidamente aplicaciones para brindar una experiencia personalizada. La configuración se puede utilizar para habilitar o deshabilitar funciones o configurar el comportamiento de las funciones para una sola aplicación o para todas las aplicaciones dentro de un entorno. Más información: Utilizar la configuración para proporcionar experiencias de aplicaciones personalizadas
Las siguientes funciones se pueden utilizar para obtener o actualizar un valor de configuración mediante la API del cliente.
getCurrentAppSetting
Obtiene el valor de una configuración para la aplicación actual.
Sintaxis
var settingValue = Xrm.Utility.getGlobalContext().getCurrentAppSetting(settingName);
Parámetros
Name
Type
Obligatorio
Description
settingName
String
Sí
El nombre del ajuste para el que se va a obtener el valor.
Valor de retorno
Tipo: igual que el tipo de configuración: Número, Cadena o Sí/No
Descripción:
Si la configuración es Anulable:
Cuando Valor se puede anular se establece en Entorno y aplicación, se devuelve el valor de configuración de la aplicación.
Si no existe un valor de la aplicación de configuración, se devuelve el valor del entorno de configuración.
Si no existe un valor de entorno de configuración, se devuelve el valor predeterminado especificado en la definición de configuración.
Cuando Valor se puede anular se establece en Solo entorno, se devuelve el valor de la configuración del entorno.
Si no existe un valor de entorno de configuración, se devuelve el valor predeterminado especificado en la definición de configuración.
Cuando Valor se puede anular se establece en Solo aplicación, se devuelve el valor de configuración de la aplicación.
Si no existe un valor de aplicación de configuración, se devuelve el valor predeterminado especificado en la definición de configuración.
Si la configuración no es Anulable, se devuelve el valor predeterminado especificado en la definición de configuración.
Si el nombre de la configuración es incorrecto o no se pudo encontrar la configuración, el valor de retorno es NULL.
saveSettingValue
Agrega o actualiza el valor de la aplicación de configuración para la aplicación actual o el valor del entorno de configuración para el entorno actual.
Sintaxis
var appOverrideScope = 2; // Add or update a setting app value
var saveSettingOptions = {overrideScope: appOverrideScope, solutionUniqueName: mySolutionName};
Xrm.Utility.getGlobalContext().saveSettingValue(settingName, value, saveSettingOptions).then(successCallback, errorCallback);
Parámetros
Name
Type
Obligatorio
Description
settingName
String
Sí
El nombre del ajuste para el que se va a actualizar el valor.
value
Número, Cadena o Sí/No
Sí
El valor del ajuste al que se va a actualizar.
saveSettingOptions
String
No
Opciones al actualizar el valor. Incluye dos parámetros
overrideScope
Usar 1 para agregar o actualizar un valor de entorno de configuración
Usar 2 para agregar o actualizar un valor de aplicación de configuración
Si no se especifica, se establece en entorno.
solutionUniqueName
La solución a la que se debe agregar el valor del entorno de configuración o el valor de la aplicación de configuración.
Si no se especifica, se usa la solución predeterminada.
successCallback
String
Sí
Una función para llamar si la actualización es exitosa.
errorCallback
String
Sí
Una función para llamar si la actualización tiene error.
Valor de retorno
En caso de éxito, devuelve un objeto de promesa.
API web
También puede utilizar las siguientes API web para obtener o actualizar un valor de configuración
Los administradores usan la configuración para ajustar el comportamiento de la aplicación, establecer valores predeterminados de marketing, comprobar cuotas, administrar configuraciones de marketing principales y mucho más.