Personalizar metadados da entidade
Publicado: janeiro de 2017
Aplicável a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Entidades são definidas por metadados. Ao definir ou alterar os metadados da entidade, você pode controlar os recursos de uma entidade. Para exibir os metadados de sua organização, use o navegador de metadados fornecido no pacote do SDK. Baixe o pacote do SDK do Microsoft Dynamics CRM. Para obter mais informações:Procurar os metadados da sua organização
Este tópico aborda como trabalhar com entidades de forma programática. Consulte TechNet: Criar e editar entidades para obter informações sobre como trabalhar com entidades no aplicativo.
Neste tópico
Opções disponíveis quando você cria uma entidade personalizada
Habilitar recursos da entidade
Propriedades da entidade editáveis
Mensagens de metadados da entidade
Mensagens suportadas por entidades personalizadas
Opções disponíveis quando você cria uma entidade personalizada
A tabela a seguir lista as opções disponíveis durante a criação de uma entidade personalizada. Só é possível definir essas propriedades durante a criação de uma entidade personalizada.
Opção |
Descrição |
|---|---|
Criar como atividade personalizada |
É possível criar uma entidade que seja uma atividade, definindo a propriedade EntityMetadata.IsActivity. Para obter mais informações, consulte Atividades personalizadas. |
Nomes de entidade |
Há dois tipos de nomes e ambos devem ter um prefixo de personalização:
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 para o Publisher da solução. Quando uma entidade é criada de forma programática, é possível definir o prefixo de personalização para uma cadeia de caracteres que tenha entre dois e oito caracteres de comprimento, todos caracteres alfanuméricos, e ela deve começar com uma letra. Não pode começar com “mscrm”. A ação recomendável é usar o prefixo de personalização definido pelo editor ao qual a solução está associada, mas isso não é um requisito. Um caractere sublinhado deve ser incluído entre o prefixo de personalização e o nome lógico ou o nome do esquema. |
Propriedade |
Use a propriedade EntityMetadata.OwnershipType para definir isso. Use a enumeração OwnershipTypes 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 8597998f-764f-4c73-b63d-9f5e02c78061#EntityOwnership. |
Atributo Principal |
Use CreateEntityRequest.PrimaryAttribute para definir isso. Cada entidade tem um atributo StringAttributeMetadata que usa StringFormat.Text como o atributo principal. O valor desse atributo é o que é exibido em uma pesquisa das entidades relacionadas. Portanto, o valor do campo deve representar um nome para o registro da entidade. |
Habilitar recursos da entidade
A tabela a seguir lista os recursos da entidade. Você pode definir esses recursos ao criar uma entidade ou pode habilitá-los posteriormente. Depois de habilitados, esses recursos não podem ser desabilitados.
Recurso |
Descrição |
|---|---|
Fluxos do processo empresarial |
Defina EntityMetadata. Defina IsBusinessProcessEnabled para verdadeiro para habilitar a entidade para os fluxos do processo empresarial. |
Observações |
Use a propriedade CreateEntityRequest ou UpdateEntityRequest.HasNotes para criar um relacionamento entre entidades com a entidade Annotation e habilite a inclusão de uma área de Anotações no formulário da entidade. Incluindo Anotações, você também pode adicionar anexos aos registros. |
Atividades |
Use a propriedade CreateEntityRequest ou UpdateEntityRequest.HasActivities para criar um relacionamento entre entidades com a entidade ActivityPointer de forma que todas as entidades do tipo de atividade podem ser associadas a essa entidade. |
Conexões |
Defina a propriedade EntityMetadata.IsConnectionsEnabled para permitir a criação de registros de conexão para associar essa entidade a outras entidades de conexão. |
Filas |
Use a propriedade EntityMetadata.IsValidForQueue para adicionar suporte para filas. Ao habilitar essa opção, você também pode definir a propriedade EntityMetadata.AutoRouteToOwnerQueue para mover automaticamente os registros para a fila padrão do proprietário quando um registro desse tipo for criado ou atribuído. |
Defina a propriedade EntityMetadata.IsActivityParty de modo que você possa enviar emails para um endereço de email nesse tipo de registro. |
Propriedades da entidade editáveis
A tabela a seguir lista as propriedades da entidade que você pode editar. A menos que uma propriedade gerenciada não permita essas opções, você pode atualizá-las a qualquer momento.
Propriedade |
Descrição |
|---|---|
Permitir Criação Rápida |
Use EntityMetadata.IsQuickCreateEnabled para habilitar formulários de criação rápida para a entidade. Para poder usar formulários de criação rápida, primeiro você deve criar e publicar um formulário de criação rápida. Observação Entidades de atividade não oferecem suporte aos formulários de criação rápida. |
Equipes de Acesso |
Use EntityMetadata.AutoCreateAccessTeams para habilitar a entidade para equipes de acesso. Consulte Ajuda e Treinamento: Sobre modelos de equipespara obter mais informações. |
Imagem Principal |
Se uma entidade tiver um atributo de imagem, você poderá habilitar ou desabilitar a exibição da imagem no aplicativo usando PrimaryImageAttribute. Para obter mais informações, consulte 8597998f-764f-4c73-b63d-9f5e02c78061#BKMK_EntityImages. |
Alterar texto de exibição |
A propriedade gerenciada EntityMetadata.IsRenameable impede que o nome de exibição seja alterado no aplicativo. Você ainda pode alterar os rótulos de forma programática, atualizando as propriedades EntityMetadata.DisplayName e EntityMetadata.DisplayCollectionName. |
Editar a descrição da entidade |
A propriedade gerenciada EntityMetadata.IsRenameable impede que a descrição da entidade seja alterada no aplicativo. Você ainda pode alterar os rótulos de forma programática, atualizando a propriedade EntityMetadata.Description. |
Habilitar para uso offline |
Use EntityMetadata.IsAvailableOffline para habilitar ou desabilitar a capacidade de os usuários do Microsoft Dynamics 365 para Microsoft Office Outlook com Acesso Offline de colocarem os dados dessa entidade offline. |
Habilitar o painel de leitura do Outlook |
Observação A propriedade EntityMetadata.IsReadingPaneEnabled é Somente para uso interno. Para habilitar ou desabilitar a capacidade de os usuários do Microsoft Dynamics 365 para Outlook de exibir os dados dessa entidade, use o painel de leitura do Microsoft Outlook. Você deve definir essa propriedade no aplicativo. |
Habilitar mala direta |
Use EntityMetadata.IsMailMergeEnabled para habilitar ou desabilitar a capacidade de gerar documentos mesclados do Microsoft Office Word que utilizam dados a partir desta entidade. |
Habilitar Detecção de Duplicidades |
Use EntityMetadata.IsDuplicateDetectionEnabled para habilitar ou desabilitar a detecção de duplicidades para a entidade. Para obter mais informações, consulte Detectar dados duplicados. |
Habilitar integração do SharePoint |
Use EntityMetadata.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 Dynamics 365 para telefones |
Use EntityMetadata.IsVisibleInMobile para habilitar ou desabilitar a capacidade de os usuários do Microsoft Dynamics 365 para telefones de verem os dados dessa entidade. |
Dynamics 365 para tablets |
Use EntityMetadata.IsVisibleInMobileClient para habilitar ou desabilitar a capacidade de os usuários do Microsoft Dynamics 365 para Tablets de verem os dados dessa entidade. Se a entidade estiver disponível para o Dynamics 365 para tablets, você poderá usar o EntityMetadata.IsReadOnlyInMobileClient para especificar que os dados para o registro são somente leitura. |
Habilitar auditoria |
Use EntityMetadata.IsAuditEnabled para habilitar ou desabilitar a auditoria para a entidade. Para obter mais informações, consulte Configurar entidades e atributos para auditoria. |
Áreas de alteração que exibem a entidade |
Você pode controlar onde as grades da entidade aparecem no painel de navegação do aplicativo. Isso é controlado pelo SiteMap. Para obter mais informações, consulte Editar o mapa do site. |
Adicionar ou remover atributos |
Desde que a propriedade gerenciada EntityMetadata.CanCreateAttributes permita a criação de atributos, você pode usar a mensagem CreateAttributeRequest para adicionar atributos. Para obter mais informações, consulte Personalizar metadados do atributo de entidades. |
Adicionar ou remover exibições |
Desde que a propriedade gerenciada EntityMetadata.CanCreateViews permita a criação de exibições, você pode usar a entidade SavedQuery para criar exibições para uma entidade. |
Adicionar ou remover gráficos |
Desde que a propriedade gerenciada EntityMetadata.CanCreateCharts permita a criação de gráficos e de que a propriedade da entidade EntityMetadata.IsEnabledForCharts seja verdadeira, você pode usar o SavedQueryVisualization para criar gráficos para uma entidade. Para obter mais informações, consulte Exibir dados com visualizações (gráficos). |
Adicionar ou remover relacionamentos entre entidades |
Há diversas propriedades gerenciadas que controlam os tipos de relacionamentos entre entidades que podem ser criados para uma entidade. Para obter mais informações, consulte Personalizar metadados do relacionamento entre entidades. |
Alterar ícones |
É possível alterar os ícones usados para entidades personalizadas. Para obter mais informações, consulte Modificar os ícones para uma entidade. |
Usar ajuda personalizada |
O EntityMetadata.EntityHelpUrlEnabled controla se a ajuda personalizada está habilitada para a entidade.Para obter mais informações:Adicionar conteúdo de ajuda personalizado. |
URL da Ajuda |
EntityMetadata.EntityHelpUrl controla qual recurso é exibidos para conteúdo da ajuda para a entidade se a ajuda personalizada estiver habilitada.Para obter mais informações:Adicionar conteúdo de ajuda personalizado. |
Pode Mudar de Relacionamento Hierárquico |
EntityMetadata.CanChangeHierarchicalRelationship controla se o estado hierárquico das relacionamentos de entidades incluídos em suas soluções gerenciadas podem ser alteradas.Para obter mais informações: |
Mensagens de metadados da entidade
A tabela a seguir lista as mensagens que você pode usar para criar, recuperar, atualizar e excluir metadados da entidade.
Nome da mensagem |
Descrição |
|---|---|
Cria uma entidade personalizada. |
|
Exclui uma entidade personalizada. |
|
Recupera os metadados de todas as entidades. |
|
Recupera os metadados de uma entidade. |
|
Atualiza os metadados de uma entidade. |
|
Usado com objetos no namespace Microsoft.Xrm.Sdk.Metadata.Query para criar uma consulta para recuperar de forma eficiente e detectar alterações nos metadados específicos.Para obter mais informações:Recuperar e detectar alterações nos metadados. |
Mensagens suportadas por entidades personalizadas
Entidades personalizadas oferecem suporte para as mesmas mensagens de base que as entidades do sistema. O conjunto de mensagens disponíveis depende se a entidade personalizada pertence ao usuário ou à organização. Para obter mais informações, consulte 8597998f-764f-4c73-b63d-9f5e02c78061#ActionsOnEntityRecords.
Confira Também
Usar o serviço da Organização com metadados do Dynamics 365
Introdução às entidades no Microsoft Dynamics 365
Procurar os metadados da sua organização
Personalizar metadados do atributo de entidades
Personalizar metadados do relacionamento entre entidades
Detectar dados duplicados
Habilitar o gerenciamento de documentos para entidades
Configurar entidades e atributos para auditoria
Editar o mapa do site
Exibir dados com visualizações (gráficos)
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 e-mail
Criar uma entidade de atividade personalizada
Modificar os ícones para uma entidade
Modificar as mensagens para uma entidade
Amostra: Criar e atualizar metadados da entidade
Exemplo: Criar uma entidade personalizada de atividade
Exemplo: Criar e atualizar uma entidade com suporte para email
Exemplo: Despejar metadados da entidade em um arquivo
Exemplo: despejar informações de privilégio de entidade em um arquivo
Microsoft Dynamics 365
© 2017 Microsoft. Todos os direitos reservados. Direitos autorais