Desarrollo de plantillas de proceso para Jitterbit Integration Studio

Introducción

Las plantillas de proceso de Integration Studio, disponibles a través de Jitterbit Marketplace, son casos de uso de integración preconstruidos que ejecutan un proceso comercial específico utilizando objetos a través de múltiples aplicaciones o sistemas.

Una plantilla de proceso consiste en uno o más proyectos que utilizan múltiples puntos finales. Puede incluir archivos de personalización y viene con su propia documentación en formato PDF.

Plantilla de Proceso de Integration Studio en Marketplace

Preparación del Proyecto

Antes de exportar un proyecto de Integration Studio, revise el proyecto cuidadosamente y asegúrese de que no haya información que no deba estar allí. Inspeccione todos los campos de contraseña por sus valores. Verifique cualquier esquema utilizado en los mapeos de transformación en busca de información confidencial o información personal identificable (PII) o información de salud protegida (PHI).

Una vez que se ha exportado un proyecto, busque en el archivo JSON exportado para confirmar que no hay información que no desee que se divulgue, como direcciones de correo electrónico. Puede haber metadatos adicionales en proyectos que fueron creados y exportados de versiones anteriores de Integration Studio.

Requisitos de envío

Para cada plantilla de proceso, se requieren los siguientes elementos para el envío:

Uno o más proyectos exportados de Harmony Integration Studio requeridos para la plantilla de proceso.
Un archivo de manifiesto de metadatos en formato YAML que describa la plantilla de proceso y proporcione los detalles que se utilizan en Jitterbit Marketplace cuando se muestra la plantilla. El nombre del archivo de manifiesto debe ser el mismo que el de la plantilla de proceso con la extensión yaml.
Un archivo PDF que documente la plantilla de proceso, su configuración, su operación y la información necesaria para utilizar la plantilla de proceso. Este archivo se enumerará en la entrada DOCUMENTATION en el manifiesto.
Cualquier archivo de personalización que sea necesario para la configuración de la plantilla de proceso. Aunque se admiten múltiples archivos de personalización en Marketplace, recomendamos, para facilitar el uso por parte de todos (tanto para ti como desarrollador, como para Jitterbit como proveedor de servicios, y lo más importante, para el usuario de la plantilla de proceso) que las personalizaciones requeridas se combinen en un solo archivo ZIP. Un archivo README apropiado con cualquier instrucción debe colocarse en el archivo comprimido junto con las personalizaciones requeridas.

Al tener un solo archivo ZIP en el paso de Descargar Personalizaciones de la inicialización de una plantilla de proceso, un usuario solo tiene un elemento de descarga con el que lidiar. Luego puede pasar eso (junto con el PDF de documentación, descrito anteriormente) a la parte encargada de configurar el endpoint.

Este paquete se listará en la entrada PACKAGES en el manifiesto.

Archivo de manifiesto

Se requiere un archivo de manifiesto de metadatos, en formato YAML, para proporcionar detalles de la plantilla de proceso y sus componentes. Este ejemplo muestra los campos que deben completarse:

# 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

Los endpoints especificados en una receta de integración o en una plantilla de proceso se utilizan para filtrar los activos mostrados en Marketplace. La lista de endpoints mostrados en Marketplace no es fija, sino que se construye a partir de aquellos utilizados por los activos en Marketplace. Se recomienda utilizar los endpoints existentes siempre que sea posible, aunque se tiene la libertad de agregar endpoints adicionales según sea necesario o apropiado.

Si se agregan nuevos endpoints, se debe tener en cuenta que los nombres similares o derivados no se agrupan. Para que una colección de activos distintos aparezca bajo el mismo endpoint, todos deben utilizar un nombre de endpoint idéntico. Los endpoints se enumeran en orden del número de activos en cada endpoint particular. Dado que los cinco principales endpoints (según el número de activos con ese endpoint) son los que aparecen cuando se carga Marketplace, los endpoints adicionales no son visibles hasta que el usuario haga clic en el botón Mostrar más.

Categorías

Las categorías adjuntas a una receta de integración o a una plantilla de proceso se utilizan para filtrar los activos mostrados en Marketplace. La lista de categorías mostradas en Marketplace no es fija, sino que se construye a partir de aquellas utilizadas por los activos en Marketplace. Se recomienda utilizar las categorías existentes siempre que sea posible, aunque se tiene la libertad de agregar categorías adicionales según sea necesario o apropiado.

Las categorías se enumeran en orden del número de activos en cada categoría particular. Dado que las cinco principales categorías (según el número de activos en una categoría) son las que aparecen cuando se carga Marketplace, las categorías adicionales no son visibles hasta que el usuario haga clic en el botón Mostrar más.

Iconos

Muchos iconos de endpoint estándar están disponibles en Jitterbit Marketplace y se emparejan utilizando los nombres en el campo ENDPOINTS del archivo YAML del manifiesto. Para determinar si un icono está disponible, utilice los filtros de endpoint de Marketplace para ver los nombres disponibles.

El ícono debe ser legible y reconocible en un tamaño pequeño, como 40 por 40 píxeles.

Si actualmente no hay un ícono de punto final disponible, envíe el ícono como una imagen en formato SVG cuadrado. Todos los íconos son un logo blanco sobre un fondo de degradado de color que va desde el color principal de la marca en la parte superior hasta un tono más oscuro del mismo color en la parte inferior. Si el color principal de la marca es tal que un degradado no funcionaría o no está permitido, use un color sólido del color principal en lugar de un degradado.

Una alternativa de envío es una imagen SVG cuadrada blanca con el color especificado ya sea como un solo color o como un par de colores (superior e inferior) para el degradado de fondo.

El ícono enviado, una vez verificado como aceptable e instalado en una versión del Marketplace, estará disponible para su uso. Hasta entonces, sustituiremos un ícono en blanco en su lugar.