Best practices and guidance for the Common Data Service (Melhores práticas e orientações sobre o Common Data Service)Best practices and guidance for the Common Data Service

O Common Data Service é uma arquitetura extensível que permite que os programadores criem experiências altamente personalizadas e adaptadas.The Common Data Service is an extensible framework that will allow developers to build highly customized and tailored experiences. Durante a personalização, extensão ou integração com o Common Data Service, o programador deve ter conhecimento das orientações e melhores práticas estabelecidas.While customizing, extending, or integrating with the Common Data Service, a developer should be aware of the established guidance and best practices.

Nesta secção, encontrará detalhes sobre os problemas que identificámos, o respetivo impacto e as orientações para os resolver.Within this section you will learn about the issues we have identified, their impact, and understand the guidance to resolve them. Iremos explicar-lhe por que deverá seguir determinados passos para evitar potenciais problemas no futuro.We will explain the background about why things should be done in a certain way and avoid potential problems in the future. Isto poderá beneficiar a utilização, compatibilidade e desempenho do seu ambiente.This can benefit the usability, supportability, and performance of your environment. A documentação de orientação reforça as informações existentes nos guias de Programação e Administração.The guidance documentation supports the existing information within the Developer and Administration guides.

Tipos de personalização visadosTargeted customization types

A documentação é direcionada aos seguintes tipos de personalização:The documentation targets the following customization types:

  • Atividades e plug-ins de fluxo de trabalho personalizadosCustom workflow activities and plug-ins
  • Trabalhar com dados do Common Data ServiceWorking with Common Data Service data
  • Integrações expansíveis ao Common Data ServiceIntegrations extending Common Data Service

SecçõesSections

Cada artigo de orientação inclui todas ou a maioria das seguintes secções:Each guidance article includes most or all of the following sections:

  • Título – descrição das orientaçõesTitle - description of the guidance
  • Categoria – uma ou mais áreas afetadas por não seguir as orientaçõesCategory - one or more areas impacted by not following the guidance
  • Potencial impacto – o nível de risco (alto, médio ou baixo) de afetar o ambiente por não seguir as orientaçõesImpact potential - the level of risk (high, medium, or low) of affecting the environment by not following the guidance
  • Sintomas – possíveis indicações de que as orientações não foram seguidasSymptoms - possible indications that the guidance has not been followed
  • Orientações – recomendações que também podem incluir exemplosGuidance - recommendations that may also include examples
  • Padrões problemáticos – descrições ou exemplos de não seguimento das orientaçõesProblematic patterns - description or examples of not following the guidance
  • Informações adicionais – detalhes de suporte para obter uma perspetiva mais abrangenteAdditional information - supporting details for a more extensive view
  • Veja também – referências para saber mais sobre algo mencionado no artigoSee also - references to learn more about something mentioned in the article

CategoriasCategories

Todos os artigos de orientações são classificados com uma ou mais das seguintes categorias:Each guidance article is classified with one or more of the following categories:

  • Utilização – utilização imprópria de uma determinada configuração, padrão ou APIUsage – improper usage of a particular API, pattern, or configuration
  • Design – falhas de design na personalizaçãoDesign – design flaws in a customization
  • Desempenho – personalização ou padrão que pode provocar um efeito negativo no desempenho em áreas como a gestão da memória, utilização da CPU, tráfego de rede ou experiência do utilizadorPerformance – customization or pattern that may produce a negative effect on performance in areas such as memory management, CPU utilization, network traffic, or user experience
  • Segurança – potenciais vulnerabilidades numa personalização que podem ser exploradas num ambiente de runtimeSecurity – potential vulnerabilities in a customization that could be exploited in a runtime environment
  • Preparação de Atualizações – personalização ou padrão que pode aumentar o risco de ter uma atualização de versão sem êxitoUpgrade Readiness - customization or pattern that may increase risk of having an unsuccessful version upgrade
  • Migração Online – personalização ou padrão que pode aumentar o risco de ter uma migração online sem êxitoOnline Migration - customization or pattern that may increase risk of having an unsuccessful online migration
  • Manutenção – personalização que aumenta desnecessariamente o esforço necessário para o programador fazer alterações, a frequência das alterações necessárias ou a probabilidade de introduzir regressõesMaintainability – customization that unnecessarily increases the amount of developer effort required to make changes, the frequency of required changes, or the chance of introducing regressions
  • Compatibilidade – personalização ou padrão que não se enquadra nas instruções de compatibilidade publicadas, incluindo a utilização de APIs removidas ou a implementação de técnicas proibidasSupportability – customization or pattern that falls outside the boundaries of published supportability statements, including usage of removed APIs or implementation of forbidden techniques