Melhores Práticas de Modelo de Processo¶

Introdução¶

Esta página fornece orientações e recomendações de práticas recomendadas para criar modelos de processo do Cloud Studio para ser carregado no Harmony Marketplace. Este documento não é abrangente e não abrange todos os cenários.

Para melhores práticas gerais para Harmony e Cloud Studio, consulte Harmony Best Practices.

Melhores Práticas¶

As seções a seguir fornecem uma visão geral das práticas recomendadas de modelo de processo:

Projetos
Operações
Scripts
Nomenclatura de projeto e componente
Estrutura do Modelo de Processo

Projetos¶

Estas são diretrizes gerais para projetos:

Use variáveis do projeto para valores que mudam de usuário para usuário, como nomes de usuário e senhas. Além disso, ao criar variáveis de projeto, é uma prática recomendada prefixar variáveis de projeto para que sejam fáceis de procurar. Por exemplo, uma variável de projeto org_netsuite_auth_username é primeiro prefixado com org, então netsuite, etc. para organizá-lo efetivamente em uma lista entre outras variáveis do projeto.
Excluir componentes não utilizados do projeto.
Remova qualquer auto-gerado -Copy sufixos de componentes do projeto e renomeá-los logicamente.

Operações¶

Estas são diretrizes gerais para operações:

Use um conector de aplicativo sobre o HTTP ou HTTP v2 (Beta) quando possível.
Configurar todas as operações para tratamento de erros. Para as melhores práticas de tratamento de erros, consulte Error Handling Best Practices Tech Talk.

Scripts¶

Estas são diretrizes gerais para scripts:

Sempre que possível, use recursos prontos para uso em vez de scripts.
Evite chamar operações dentro de scripts.
Evite chamar operações ou incluir lógica de script em transformações.

Nomenclatura de Projetos e Componentes¶

Estas são as recomendações sobre como nomear projetos e seus componentes:

Componente	Padrão	Exemplo
Projeto	`<action>` + `<endpoint>` + `<object>` para `<endpoint>` + `<object>`	`Sync Salesforce Contacts to SAP Contacts`
Operação	`<action>` + `<endpoint>` + `<object>`	`Get Salesforce Contacts`
Endpoint	`<endpoint>`	`Salesforce`
Atividade de Endpoint	`<action>` + `<object>`	`Upsert Contacts`
Transformação	`<action>` + `<object>` + `Request/Response`	`Upsert Salesforce Contacts Request`
Script	`<action>` + `<object>`	`Send Error Email`
Variáveis do Projeto	`<endpoint>_<element>`	`Salesforce_Security_Token`
Variáveis Globais	Use caso de camelo	`errorMessage`

Além disso, o nome do projeto, a descrição e o workflow devem ter nomes correspondentes.

Nota

Certifique-se de que não haja erros de ortografia ao nomear projetos e seus componentes.

Estrutura do Modelo de Processo¶

A estrutura a seguir descreve como cada operação deve funcionar dentro de um fluxo de trabalho cadeia de operação:

Operação 1: A primeira operação é usada para configurar variáveis comuns para o registro de informações, como contagem de sucesso, contagem de falha, resumo de sucesso e nomes de arquivos. Usando variáveis comuns, você pode gravar os arquivos de sucesso e falha e imprimir um log de resumo contendo os valores para os quais as variáveis estão definidas. Depois de configurados, você pode configurar uma notificação e-mail que entrega essas informações ao destinatário que você definir.
Operação 2: A segunda operação recupera dados do endpoint de origem.
Operação 3: Quando um conector não oferece suporte à paginação, a terceira operação é usada para paginar os dados para endpoints de destino que oferecem suporte apenas a um número limitado de registros.
Operação 4: A quarta operação implementa a lógica restante necessária para executar uma ação no endpoint de destino.
Operação 5: A operação final é configurada para enviar uma única notificação e-mail que entrega uma compilação de mensagens de erro (de qualquer uma das operações) ao destinatário que você definir.