Compartilhar 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
- entityName
- FormId
-altura
- barra de navegação
- openInNewWindow
- windowPosition
- ID do processo
- processInstanceId
-relação
- selectStageId
- useQuickCreateForm
-Largura
Consulte a tabela deentityFormOptions objetos para obter informações sobre os atributos.
formParameters Object 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 de querystring personalizados.
sucessoRetorno de chamada Função Não Uma função a ser executada quando a operação for bem-sucedida.
erroRetorno de chamada Função Não Uma função a ser executada quando a operação falhar.

entityFormOptions Atributos do objeto

A tabela a seguir descreve os atributos do entityFormOptions 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 Busca Indica um registro que fornecerá valores padrão com base em valores de atributo mapeados. O objeto de pesquisa tem as seguintes propriedades do tipo String: entityType, ide name (opcional).
entityId String Identificador do registro de entidade para o qual exibir o formulário.
entityName String Nome lógico da entidade para a qual exibir o formulário.
formId String Identificador da instância do formulário a ser exibida.
height Número Altura da janela do formulário a ser exibida em pixels.
barra de navegação String 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. Esse é 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, somente 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.
ID do processo String Identificador do processo empresarial a ser exibido no formulário.
processInstanceId String Identificador da instância do processo empresarial a ser exibida no formulário.
relação Objeto JSON Indica um objeto de relação para exibir os registros relacionados no formulário. Consulte a tabela derelationship objetos para obter informações sobre os atributos.
Identificação do estágio selecionado String Identificador do estágio selecionado na instância do processo empresarial.
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 de objeto do entityFormOptions parâmetro.

Observação

Os atributos são opcionais.

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

Valor de retorno

Em caso de êxito, retorna um objeto Promise contendo 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 do 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