Desenvolvimento de modelos de processo para o Jitterbit Integration Studio

Introdução

Os modelos de processo do Integration Studio, disponíveis através do Jitterbit Marketplace, são casos de uso de integração pré-construídos que executam um processo de negócios específico usando objetos em múltiplas aplicações ou sistemas.

Um modelo de processo consiste em um ou mais projetos utilizando múltiplos endpoints. Pode incluir arquivos de personalização e vem com sua própria documentação em formato PDF.

Preparação do Projeto

Antes de exportar um projeto do Integration Studio, revise o projeto cuidadosamente e assegure-se de que não há informações que não deveriam estar nele. Inspecione todos os campos de senha quanto aos seus valores. Verifique quaisquer esquemas utilizados nos mapeamentos de transformação quanto à presença de informações confidenciais ou pessoalmente identificáveis (PII) ou informações de saúde protegidas (PHI).

Uma vez que um projeto tenha sido exportado, busque no arquivo JSON exportado para confirmar que não há informações que você não gostaria que fossem divulgadas, como endereços de email. Metadados extras podem estar presentes em projetos que foram criados e exportados de versões anteriores do Integration Studio.

Requisitos de Submissão

Para cada modelo de processo, os seguintes itens são necessários para a submissão:

• Um ou mais projetos exportados do Harmony Integration Studio necessários para o modelo de processo.

• Um arquivo de manifesto de metadados em formato YAML descrevendo o modelo de processo e fornecendo os detalhes que são utilizados no Jitterbit Marketplace quando o modelo é exibido. O nome do arquivo de manifesto deve ser o mesmo nome do modelo de processo com a extensão yaml.

• Um arquivo PDF documentando o modelo de processo, sua configuração, sua operação e informações necessárias para usar o modelo de processo. Este arquivo será listado na entrada DOCUMENTAÇÃO no manifesto.

• Quaisquer arquivos de personalização que são necessários para a configuração do modelo de processo. Embora vários arquivos de personalização sejam suportados no Marketplace, recomendamos, para facilitar o uso por todos (para você como desenvolvedor, para a Jitterbit como um provedor de serviços e, mais importante, para o usuário do modelo de processo) que as personalizações necessárias sejam combinadas em um único arquivo ZIP. Um arquivo README apropriado com quaisquer instruções deve ser colocado no arquivo compactado com as personalizações necessárias.

  Ao ter um único arquivo ZIP na etapa Baixar Personalizações da inicialização de um modelo de processo, um usuário tem apenas um item para baixar. Ele pode então passar isso (com o PDF de documentação, descrito acima) para a parte encarregada de configurar o endpoint.

  Este pacote será listado na entrada PACKAGES no manifesto.

Arquivo de manifesto

Um arquivo de manifesto de metadados, no formato YAML, é necessário para fornecer detalhes sobre o modelo de processo e seus constituintes. Este exemplo mostra os campos que precisam ser preenchidos:

# Process Template Manifest File

NAME: Salesforce-NetSuite CPQ-to-Billing Process Template

TYPE: template

# Description can be multi-line or multi-paragraph
# Indent each succeeding line or paragraph
DESCRIPTION: This process template automatically process your orders and
  invoices in Salesforce CPQ and Billing and NetSuite. Synchronizes contacts,
  products, price books, orders, and invoices between systems.

AUTHOR: Jitterbit, Inc.

# A list of the projects included in the process template
PROJECTS:
- Salesforce_NetSuite_Contacts_Accounts_Bidirectional.json
- Sync_NetSuite_Inventory-Items_to_Salesforce_Price-Book-Entry.json
- Sync_NetSuite_Inventory-Items_to_Salesforce_Products.json
- Sync_Salesforce_Invoices_to_NetSuite_Invoices.json
- Sync_Salesforce_Orders_to_NetSuite_Sales-Orders.json

# A list of all the documents in the process template
# Currently, a single PDF is supported
DOCUMENTATION:
- Jitterbit Salesforce-NetSuite CPQ-to-Billing Process Template.pdf

# A list of all the customization packages in the process template
PACKAGES:
- Salesforce-NetSuite CPQ-to-Billing Process Template Package.zip

# Endpoints
# Place each endpoint on its own line beginning with a hyphen
# in order of source to target
ENDPOINTS:
- Salesforce
- NetSuite

# Sources: A list of dictionaries, with each source by name
SOURCES:
- NAME: NetSuite
  OBJECTS:
  - Accounts
  - Contacts
  - Customers
  - Inventory Items
- NAME: Salesforce
  OBJECTS:
  - Accounts
  - Contacts
  - Invoices
  - Orders

# Target: A list of dictionaries, with each target by name
TARGETS:
- NAME: NetSuite
  OBJECTS:
  - Accounts
  - Customers
  - Invoices
  - Sales Orders
- NAME: Salesforce
  OBJECTS:
  - Contacts
  - Price Book Entry
  - Products

# Categories
# Place each category on a line beginning with a hyphen
CATEGORIES:
- ERP
- Finance
- Sales & CRM

Endpoints

Os endpoints especificados em uma receita de integração ou em um modelo de processo são usados para filtrar os ativos exibidos no Marketplace. A lista de endpoints mostrada no Marketplace não é fixa, mas é construída a partir dos utilizados pelos ativos no Marketplace. Incentivamos você a usar os endpoints existentes sempre que possível, embora você tenha liberdade para adicionar endpoints adicionais conforme necessário ou apropriado.

Se você adicionar novos endpoints, tenha em mente que nomes semelhantes ou derivados não são agregados. Para que uma coleção de ativos distintos apareça sob o mesmo endpoint, todos devem usar um nome de endpoint idêntico. Os endpoints são listados em ordem do número de ativos em cada endpoint específico. Como os cinco principais endpoints (conforme determinado pelo número de ativos com esse endpoint) são os que aparecem quando o Marketplace é carregado, endpoints adicionais não são visíveis até que o usuário clique no botão Mostrar Mais.

Categorias

As categorias anexadas a uma receita de integração ou a um modelo de processo são usadas para filtrar os ativos exibidos no Marketplace. A lista de categorias mostrada no Marketplace não é fixa, mas é construída a partir das utilizadas pelos ativos no Marketplace. Incentivamos você a usar as categorias existentes sempre que possível, embora você tenha liberdade para adicionar categorias adicionais conforme necessário ou apropriado.

As categorias são listadas em ordem do número de ativos em cada categoria específica. Como as cinco principais categorias (conforme determinado pelo número de ativos em uma categoria) são as que aparecem quando o Marketplace é carregado, categorias adicionais não são visíveis até que o usuário clique no botão Mostrar Mais.

Ícones

Muitos ícones de endpoint padrão estão disponíveis no Jitterbit Marketplace e são correspondidos usando os nomes no campo ENDPOINTS do arquivo YAML do manifesto. Para determinar se um ícone está disponível, use os filtros de endpoint do Marketplace para ver os nomes disponíveis.

O ícone deve ser legível e reconhecível em um tamanho pequeno, como 40 por 40 pixels.

Se um ícone de endpoint não estiver disponível no momento, envie o ícone como uma imagem em formato SVG quadrado. Todos os ícones são um logotipo branco em um fundo de gradiente colorido que vai da cor primária da marca na parte superior para um tom mais escuro da mesma cor na parte inferior. Se a cor primária da marca for tal que um gradiente não funcione ou não seja permitido, use um sólido da cor primária da marca em vez de um gradiente.

Uma submissão alternativa é uma imagem SVG quadrada branca com a cor especificada como uma única cor ou como um par de cores (superior e inferior) para o gradiente de fundo.

O ícone enviado, uma vez verificado como aceitável e instalado em uma versão do Marketplace, estará disponível para uso. Até lá, substituiremos por um ícone em branco em seu lugar.