Partilhar via

openForm (Referência da API JavaScript) para Dynamics 365 Channel Integration Framework 1.0

Abre um formulário de entidade ou um formulário de criação rápida.

Sintaxe

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

Parâmetros

Nome Tipo Obrigatório Description
entityFormOptions Objeto JSON Yes Opções de formulário de entidade para abrir o formulário. O objeto contém os seguintes atributos:
- CMDBar
- createFromEntity
- entityId
- nome_da_entidade
- formId
- altura
- NavBar
- openInNewWindow
- windowPosition
- processId
- processInstanceId
- relacionamento
- selecionarStageId
- useQuickCreateForm
-Largura
Consulte a tabela deentityFormOptions objetos para obter informações sobre os atributos.
formParameters Objeto Não Um objeto de dicionário que passa parâmetros extras para o formulário. Parâmetros inválidos causarão um erro.
Para obter informações sobre como passar parâmetros para um formulário, consulte Definir valores de campo usando parâmetros passados para um formulário e Configurar um formulário para aceitar parâmetros querystring personalizados.
successCallback Função Não Uma função a ser executada quando a operação for bem-sucedida.
errorCallback Função Não Uma função a ser executada quando a operação falha.

entityFormOptions Atributos do objeto

A tabela a entityFormOptions seguir descreve os atributos do parâmetro.

Observação

Os atributos são opcionais.

Nome do atributo Tipo Description
cmdBar booleano Indica se a barra de comandos deve ser exibida. Se você não especificar esse parâmetro, a barra de comandos será exibida por padrão.
createFromEntity Lookup Indica um registro que fornecerá valores padrão com base em valores de atributos mapeados. O objeto de pesquisa tem as seguintes propriedades do tipo String: entityType, ide name (opcional).
entityId Cordão Identificador do registro de entidade para o qual exibir o formulário.
entityName Cordão Nome lógico da entidade para a qual exibir o formulário.
formId Cordão Identificador da instância do formulário a ser exibida.
altura Número Altura da janela do formulário a ser exibida em pixels.
navBar [en] Cordão Controla se a barra de navegação é exibida e se a navegação do aplicativo está disponível usando as áreas e subáreas definidas no mapa do site. Os valores válidos são:
on: A barra de navegação é exibida. Este é o comportamento padrão se o navBar parâmetro não for usado.
off: A barra de navegação não é exibida. O usuário pode navegar usando outros elementos da interface do usuário ou os botões voltar e avançar.
entity: Em um formulário de entidade, apenas as opções de navegação para entidades relacionadas estão disponíveis. Depois de navegar para uma entidade relacionada, um botão Voltar é exibido na barra de navegação para permitir o retorno ao registro original.
openInNewWindow booleano Indica se o formulário deve ser exibido em uma nova janela.
windowPosition Número Indica a posição do formulário na janela. Os valores válidos são: 1 para a posição central e 2 para a posição lateral.
processId Cordão Identificador do processo comercial a ser exibido no formulário.
processInstanceId Cordão Identificador da instância do processo comercial a ser exibida no formulário.
relação Objeto JSON Indica um objeto de relacionamento para exibir os registros relacionados no formulário. Consulte a tabela derelationship objetos para obter informações sobre os atributos.
selecionarStageId Cordão Identificador do estágio selecionado na instância do processo de negócios.
useQuickCreateForm Número Largura da janela do formulário a ser exibida em pixels.

relationship Atributos do objeto

A tabela a seguir descreve os atributos do relationship atributo object do entityFormOptions parâmetro.

Observação

Os atributos são opcionais.

Nome do atributo Tipo Description
attributeName Cordão Nome do atributo usado para relacionamento.
nome Cordão Nome da relação.
navigationPropriedade Cordão Nome da propriedade de navegação para a relação.
relationshipType Número Tipo de relação. Os valores válidos são: 0 para relacionamento um-para-muitos e 1 para relacionamento muitos-para-muitos.
tipo de função Número Tipo de função na relação. Os valores válidos são: 1 para referenciação e 2 para AssociationEntity.

Valor de retorno

Quando for bem-sucedido, retorna um objeto Promise que contém cadeia de caracteres.

Example

O código de exemplo a seguir abre um novo formulário de incidente com valores pré-preenchidos para determinados campos, como ID de contato e descrição.

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);
    }
  );
  • Last updated on