openForm (Referencia de API JavaScript) para Marco de integración de canal de Dynamics 365 1.0

Abre un formulario de entidad o un formulario de creación rápida.

Sintaxis

Microsoft.CIFramework.openForm(entityFormOptions,formParameters).then(successCallback,errorCallback);

Parámetros

Name	Type	Obligatorio	Descripción
entityFormOptions	Objeto JSON	Sí	Opciones de formulario de entidad para abrir el formulario. El objeto contiene los siguientes atributos: - cmdbar - createFromEntity - entityId - entityName - formId - height - navBar - openInNewWindow - windowPosition - processId - processInstanceId - relationship - selectStageId - useQuickCreateForm - width Consulte la entityFormOptions tabla de objetos para obtener información sobre los atributos.
formParameters	Objecto	No	Un objeto de diccionario que pasa parámetros adicionales al formulario. Los parámetros no válidos provocarán un error. Para obtener información acerca de cómo pasar parámetros a un formulario, consulte Establecer valores de campo mediante parámetros que se pasan a un formulario y Configurar un formulario para aceptar parámetros de cadena de consulta personalizada.
successCallback	Function	No	Una función que se ejecuta cuando la operación es correcta.
errorCallback	Function	No	Función que se ejecuta cuando la operación produce un error.

Atributos del objeto entityFormOptions

La siguiente tabla describe los atributos del parámetro entityFormOptions.

Nota

Los atributos son opcionales.

Attribute name	Type	Descripción
cmdBar	Booleana	Indica si se muestra la barra de comandos. Si no especifica este parámetro, la barra de comandos se muestra de forma predeterminada.
createFromEntity	Lookup	Indica un registro que proporcionará valores predeterminados según los valores de atributo asignados. El objeto de búsqueda tiene las siguientes propiedades del tipo de cadena: entityType, id y name (opcional).
entityId	String	Identificador del registro de entidad para el que se va a mostrar el formulario.
entityName	String	Nombre lógico de la entidad para la que se va a mostrar el formulario.
formId	String	Identificador de la instancia del formulario que se mostrará.
altura	Number	Alto de la ventana de formulario que se mostrará, en píxeles.
navBar	String	Controla si la barra de navegación se muestra y si la navegación por la aplicación está disponible mediante las áreas y subáreas definidas en el mapa del sitio. Los valores válidos son: on: se muestra la barra de navegación. Este es el comportamiento predeterminado si el parámetro navBar no se usa. off: no se muestra la barra de navegación. El usuario puede navegar usando otros elementos de la interfaz de usuario o los botones adelante y atrás. entity: en un formulario de entidad, solo están disponibles las opciones de navegación de entidades relacionadas. Después de navegar a una entidad relacionada, se muestra un botón atrás en la barra de navegación para permitir volver al registro original.
openInNewWindow	Booleana	Indica si se debe mostrar el formulario en una nueva ventana.
windowPosition	Number	Indica la posición del formulario en la ventana. Los valores válidos son: 1 para la posición central y 2 para la posición lateral.
processId	String	Identificador de los procesos de negocio que se muestran en el formulario.
processInstanceId	String	Identificador de la instancia de proceso de negocio que se muestra en el formulario.
relationship	Objeto JSON	Indica un objeto de relación para mostrar los registros relacionados en el formulario. Consulte la relationship tabla de objetos para obtener información sobre los atributos.
selectStageId	String	Identificador de la fase seleccionada en la instancia de proceso de negocio.
useQuickCreateForm	Number	Ancho de la ventana de formulario que se mostrará, en píxeles.

Atributos del objeto relationship

La siguiente tabla describe los atributos del atributo del objeto de relationship del parámetro entityFormOptions.

Nota

Los atributos son opcionales.

Attribute name	Type	Descripción
attributeName	String	Nombre del atributo usado para la relación.
name	String	Nombre de la relación.
navigationProperty	String	Nombre de la propiedad de navegación de la relación.
relationshipType	Number	Tipo de relación. Los valores válidos son: 0 para relaciones de uno a varios y 1 para relaciones de varios a varios.
roleType	Number	Tipo de rol en la relación. Los valores válidos son: 1 para referencia y 2 para AssociationEntity.

Valor de retorno

En caso de éxito, devuelve un objeto Promise que contiene una cadena.

Ejemplo

El siguiente código de ejemplo abre un nuevo formulario de incidentes con valores rellenados previamente para ciertos campos, como ID de contacto y descripción.

var id = "5af02e2a-d0d1-e811-8158-000d3af97055"
var title = "Sample Case Form"
var entityFormOptions = {};
    entityFormOptions["entityName"] = "incident";
    
var formParameters = {};
    //pre-populate some fields based on the context
    formParameters["title"] = title;
    formParameters["customerid"] = id;
    formParameters["customeridtype"] = "contact";
    formParameters["caseorigincode"] = 1;
    formParameters["description"] = "Opened the form with pre-populated details like title, contact id, and description.";

//Open the form
Microsoft.CIFramework.openForm(JSON.stringify(entityFormOptions), JSON.stringify(formParameters)).then(
      function (success) {
        console.log(success);
    },
    function (error) {
        console.log(error);
    }
  );