Personalizar metadados de entidade

As entidades são definidas por metadados. Ao definir ou alterar os metadados de entidade, você pode controlar os recursos de uma entidade. Para exibir os metadados da sua organização, use o navegador de metadados. Baixe o navegador de metadados.

Mais informações: Procurar os metadados para sua organização

Este tópico é sobre como trabalhar com entidades programaticamente. Consulte Criar ou editar entidades (tipos de registro) para obter informações sobre como trabalhar com entidades no aplicativo.

As entidades podem ser criadas usando o serviço Organização ou a API Web. As informações a seguir podem ser aplicadas a ambos.

Operações de metadados de entidade

Como você trabalha com metadados de entidade depende de qual serviço você usa.

Como a API Web é um ponto de extremidade RESTful, ela usa uma maneira diferente de criar, recuperar, atualizar e excluir metadados. Use POST, GETe PUTverbos DELETE HTTP para trabalhar com tipos de entidade de metadados. Mais informações: criar e atualizar definições de entidade usando a API Web.

Uma exceção a isso é que a Função RetrieveMetadataChanges fornece uma maneira de compor uma consulta de metadados e acompanhar as alterações ao longo do tempo.

Se estiver trabalhando com o Serviço da Organização, use RetrieveMetadataChangesRequest a classe. Essa classe contém os dados necessários para recuperar uma coleção de registros de metadados que atendam aos critérios especificados. O RetrieveMetadataChangesResponse retorna um valor de carimbo de data/hora que pode ser usado com essa solicitação posteriormente para retornar informações sobre como os metadados foram alterados desde a última solicitação.

Message Web API Montagem do SDK
CreateEntity Use uma solicitação POST para enviar dados para criar uma entidade. CreateEntityRequest
DeleteEntity Use uma solicitação DELETE para excluir uma entidade. DeleteEntityRequest
RetrieveAllEntities Use a solicitação GET para recuperar dados de entidade. RetrieveAllEntitiesRequest
RetrieveEntity Função RetrieveEntity RetrieveEntityRequest
UpdateEntity Use uma solicitação PUT para atualizar uma entidade. UpdateEntityRequest
RetrieveMetadataChanges
Usado junto com objetos no Microsoft.Xrm.Sdk.Metadata.Query namespace para criar uma consulta para recuperar e detectar alterações com eficiência em metadados específicos. Para obter mais informações: Recuperar e detectar alterações em metadados.		 Função RetrieveMetadataChanges RetrieveMetadataChangesRequest

Opções disponíveis ao criar uma entidade personalizada

A tabela a seguir lista as opções disponíveis ao criar uma entidade personalizada. Você só pode definir essas propriedades ao criar uma entidade personalizada.

Opção Description
Criar como atividade personalizada Você pode criar uma entidade que é uma atividade definindo a IsActivity propriedade ao usar o serviço da organização ou a API Web, respectivamente. Para obter mais informações, consulte Atividades Personalizadas no Dynamics 365 Customer Engagement (local).
Nomes de entidade Há dois tipos de nomes e ambos devem ter um prefixo de personalização:

LogicalName: nome que é a versão do nome da entidade definida em todas as letras minúsculas.

SchemaName: nome que será usado para criar as tabelas de banco de dados para a entidade. Esse nome pode ser maiúsculas de minúsculas. A caixa que você usa define o nome do objeto gerado para programação com tipos fortes ou quando você usa o ponto de extremidade REST.

Observação: se o nome lógico for diferente do nome do esquema, o nome do esquema substituirá o valor definido para o nome lógico.

Quando uma entidade é criada no aplicativo no contexto de uma solução específica, o prefixo de personalização usado é o único conjunto para a Publisher solução. Quando uma entidade é criada programaticamente, você pode definir o prefixo de personalização para uma cadeia de caracteres que tem entre dois e oito caracteres de comprimento, todos os caracteres alfanuméricos e deve começar com uma letra. Ele não pode começar com "mscrm". A melhor prática é usar o prefixo de personalização definido pelo editor ao qual a solução está associada, mas isso não é um requisito. Um caractere de sublinhado deve ser incluído entre o prefixo de personalização e o nome lógico ou de esquema.
Propriedade Use a OwnershipType propriedade para definir isso. Use a OwnershipTypes enumeração ou OwnershipTypes enumType para definir o tipo de propriedade da entidade. Os únicos valores válidos para entidades personalizadas são OrgOwned ou UserOwned. Para obter mais informações, consulte Entity Ownership.
Atributo Primário Com o serviço Organização, use CreateEntityRequesta propriedade .PrimaryAttribute para definir isso.

Com a API Web, o JSON que define a entidade deve incluir um StringAttributeMetadata com a IsPrimaryName propriedade definida como true.

Em ambos os casos, o atributo de cadeia de caracteres deve ser formatado como Text. O valor desse atributo é o que é mostrado em uma pesquisa de entidades relacionadas. Portanto, o valor do campo deve representar um nome para o registro de entidade.

Habilitar recursos de entidade

A tabela a seguir lista os recursos de entidade. Você pode definir esses recursos ao criar uma entidade ou habilitá-las posteriormente. Depois de habilitados, esses recursos não podem ser desabilitados.

Capability Description
Fluxos de processo empresarial Defina IsBusinessProcessEnabled como true para habilitar a entidade para fluxos de processo empresarial.
Notes Para criar uma relação de entidade com a Annotation entidade e habilitar a inclusão de uma área de Anotações no formulário de entidade. Ao incluir Anotações, você também pode adicionar anexos aos registros.

Com o serviço Organização, use a propriedade ou CreateEntityRequestUpdateEntityRequest a HasNotes propriedade

Com a API Web, defina o EntityMetadata. HasNotes propriedade.
Atividades Para criar uma relação de entidade com a ActivityPointer entidade para que todas as entidades de tipo de atividade possam ser associadas a essa entidade.

Com o serviço organização, use a propriedade ou CreateEntityRequestUpdateEntityRequest a HasActivities propriedade.

Com a API Web, defina o EntityMetadata. HasActivities propriedade.
Conexões Para habilitar a criação de registros de conexão para associar essa entidade a outras entidades de conexão, defina o valor da IsConnectionsEnabled.Value propriedade como true.
Filas Use a IsValidForQueue propriedade para adicionar suporte para filas. Ao habilitar essa opção, você também pode definir a AutoRouteToOwnerQueue propriedade para mover automaticamente os registros para a fila padrão do proprietário quando um registro desse tipo é criado ou atribuído.
Email Defina a IsActivityParty propriedade para que você possa enviar email para um endereço de email nesse tipo de registro.

Propriedades de entidade editável

A tabela a seguir lista as propriedades de entidade que você pode editar. A menos que uma propriedade gerenciada desautorize essas opções, você poderá atualizá-las a qualquer momento.

Propriedade Description
Permitir Criação Rápida Use IsQuickCreateEnabled para habilitar formulários de criação rápida para a entidade. Antes de poder usar formulários de criação rápida, você deve primeiro criar e publicar um formulário de criação rápida.
Note:
As entidades de atividade não dão suporte a formulários de criação rápida.
Acessar o Teams Use AutoCreateAccessTeams para habilitar a entidade para equipes de acesso. Consulte sobre modelos de equipe para obter mais informações.
Imagem primária Se uma entidade tiver um atributo de imagem, você poderá habilitar ou desabilitar a exibição dessa imagem no aplicativo usando PrimaryImageAttribute. Para obter mais informações, consulte Imagens de Entidade.
Alterar texto de exibição A propriedade gerenciada IsRenameable impede que o nome de exibição seja alterado no aplicativo. Você ainda pode alterar os rótulos programaticamente atualizando as propriedades e DisplayName as DisplayCollectionName propriedades.
Editar a descrição da entidade A propriedade gerenciada IsRenameable impede que a descrição da entidade seja alterada no aplicativo. Você ainda pode alterar os rótulos programaticamente atualizando a Description propriedade.
Habilitar para uso enquanto estiver offline Use IsAvailableOffline para habilitar ou desabilitar a capacidade do Dynamics 365 para o Microsoft Office Outlook com usuários do Offline Access para colocar os dados dessa entidade offline.
Habilitar o Painel de Leitura do Outlook Note:

A IsReadingPaneEnabled propriedade é somente para uso interno.

Para habilitar ou desabilitar a capacidade do Dynamics 365 para os usuários do Outlook exibirem dados dessa entidade, use o painel de leitura do Outlook. Você deve definir essa propriedade no aplicativo.
Habilitar Mala Direta Use IsMailMergeEnabled para habilitar ou desabilitar a capacidade de gerar documentos mesclados do Office Word que usam dados dessa entidade.
Habilitar detecção duplicada Use IsDuplicateDetectionEnabled para habilitar ou desabilitar a detecção duplicada para a entidade. Para obter mais informações, consulte Detectar dados duplicados no Dynamics 365 Customer Engagement (local).
Habilitar a integração do SharePoint Use IsDocumentManagementEnabled para habilitar ou desabilitar a integração do SharePoint Server para a entidade. Para obter mais informações, consulte Habilitar o Gerenciamento de Documentos para Entidades.
Habilitar o Dynamics 365 para telefones Use IsVisibleInMobile para habilitar ou desabilitar a capacidade do Dynamics 365 para os usuários de telefones verem dados dessa entidade.
Dynamics 365 para tablets Use IsVisibleInMobileClient para habilitar ou desabilitar a capacidade do Dynamics 365 para os usuários de tablets verem dados dessa entidade.

Se a entidade estiver disponível para o Dynamics 365 para tablets, você poderá usar IsReadOnlyInMobileClient para especificar que os dados do registro são somente leitura.
Habilitar Auditoria Use IsAuditEnabled para habilitar ou desabilitar a auditoria para a entidade. Para obter mais informações, consulte Configurar entidades e atributos para auditoria.
Alterar áreas que exibem a entidade Você pode controlar onde as grades de entidade aparecem no Painel de Navegação do aplicativo. Isso é controlado pelo SiteMap.
Adicionar ou remover atributos Desde que a propriedade CanCreateAttributes.Value gerenciada permita a criação de atributos, você pode adicionar atributos à entidade. Para obter mais informações, consulte Personalizar metadados de atributo de entidade.
Adicionar ou remover exibições Desde que a propriedade CanCreateViews.Value gerenciada permita a criação de exibições, você pode usar a SavedQuery entidade para criar exibições para uma entidade.
Adicionar ou remover gráficos Desde que a propriedade CanCreateCharts.Value gerenciada permita a criação de gráficos e a IsEnabledForCharts propriedade da entidade seja verdadeira, você pode usar a Entidade SavedQueryVisualization para criar gráficos para uma entidade. Para obter mais informações, consulte Exibir Dados com Visualizações (Gráficos).
Adicionar ou remover relações de entidade Há várias propriedades gerenciadas que controlam os tipos de relações de entidade que você pode criar para uma entidade. Para obter mais informações, consulte Personalizar metadados de relação de entidade.
Alterar ícones Você pode alterar os ícones usados para entidades personalizadas. Para obter mais informações, consulte Modificar ícones de entidade.
Pode alterar a relação hierárquica CanChangeHierarchicalRelationship.Value controla se o estado hierárquico das relações de entidade incluídas em suas soluções gerenciadas pode ser alterado. Mais informações:

Mensagens com suporte por entidades personalizadas

Entidades personalizadas dão suporte às mesmas mensagens base que as entidades do sistema. O conjunto de mensagens disponíveis depende se a entidade personalizada é de propriedade do usuário ou da organização. Para obter mais informações, consulte Ações em Registros de Entidade.

Consulte também

Estender o modelo de metadados para o Dynamics 365 Customer Engagement (local)
Introdução às entidades no Dynamics 365 Customer Engagement (local)
Procurar os metadados para sua organização
Personalizar metadados de atributo de entidade
Metadados de relação de entidade
Detectar dados duplicados no Dynamics 365 Customer Engagement (local)
Habilitar o Gerenciamento de Documentos para Entidades
Configurar entidades e atributos para auditoria
Exibir dados usando gráficos (visualizações)
Quais entidades são personalizáveis?
Criar uma entidade personalizada
Recuperar, atualizar e excluir entidades
Criar e atualizar uma entidade que pode ser enviada por email
Criar uma entidade de atividade personalizada
Modificar ícones de entidade
Modificar mensagens de entidade
Exemplo: Criar e atualizar metadados de entidade
Exemplo: criar uma entidade de atividade personalizada
Exemplo: criar e atualizar uma entidade que pode ser enviada por email
Exemplo: Despejar metadados de entidade em um arquivo
Exemplo: despejar informações de privilégio de entidade em um arquivo

  • Last updated on