Mejores prácticas de plantilla de proceso¶

Introducción¶

Esta página proporciona orientación y recomendaciones sobre mejores prácticas para diseñar plantillas de proceso de Cloud Studio para ser subido a Harmony Marketplace. Este documento no es completo y no cubre todos los escenarios.

Para conocer las mejores prácticas generales para Harmony y Cloud Studio, consulte Prácticas recomendadas de Harmony.

Mejores prácticas¶

Las siguientes secciones proporcionan una descripción general de las mejores prácticas de la modelo de proceso:

Proyectos
Operaciones
Secuencias de Comandos
Nombre de proyecto y componente
Estructura de plantilla de proceso

Proyectos¶

Estas son pautas generales para proyectos:

Usar variables del proyecto para valores que cambian de un usuario a otro, como nombres de usuario y contraseñas. Además, cuando se crean variables de proyecto, es una buena práctica agregar un prefijo a las variables de proyecto para que sean fáciles de buscar. Por ejemplo, una variable de proyecto org_netsuite_auth_username primero tiene el prefijo org, entonces netsuite, etc. para organizarlo de manera efectiva en una lista entre otras variables del proyecto.
Borrar componentes no utilizados del proyecto.
Eliminar cualquier generado automáticamente -Copy sufijos de los componentes del proyecto y cambiarles el nombre lógicamente.

Operaciones¶

Estas son pautas generales para operaciones:

Usar un conector de aplicación a través del HTTP o HTTP v2 (Beta) conectores cuando sea posible.
Configurar todas las operaciones para manejo de errores. Para conocer las prácticas recomendadas para el manejo de errores, consulte la Charla técnica sobre prácticas recomendadas para el manejo de errores.

Secuencias de comandos¶

Estas son pautas generales para secuencias de comandos:

Utilice funciones listas para usar en lugar de secuencias de comandos siempre que sea posible.
Evite llamar a operaciones dentro de secuencias de comandos.
Evite llamar a operaciones o incluir lógica de secuencias de comandos dentro de transformaciones.

Denominación de proyectos y componentes¶

Estas son las recomendaciones sobre la denominación de proyectos y sus componentes:

Componente	patrón	Ejemplo
Proyecto	`<action>` + `<endpoint>` + `<object>` a `<endpoint>` + `<object>`	`Sync Salesforce Contacts to SAP Contacts`
Operación	`<action>` + `<endpoint>` + `<object>`	`Get Salesforce Contacts`
Extremo	`<endpoint>`	`Salesforce`
Actividad de Extremo	`<action>` + `<object>`	`Upsert Contacts`
Transformación	`<action>` + `<object>` + `Request/Response`	`Upsert Salesforce Contacts Request`
Secuencia de Comandos	`<action>` + `<object>`	`Send Error Email`
Variables del proyecto	`<endpoint>_<element>`	`Salesforce_Security_Token`
Variables globales	Utilice el caso de camello	`errorMessage`

Además, el nombre del proyecto, la descripción y el flujo de trabajo deben tener nombres coincidentes.

Nota

Asegúrese de que no haya errores ortográficos al nombrar los proyectos y sus componentes.

Estructura de la plantilla de proceso¶

La siguiente estructura describe cómo debe funcionar cada operación dentro de la cadena de operación:

Operación 1: La primera operación se usa para configurar variables comunes para el registro de información, como conteo de éxitos, conteo de fallas, resumen de éxitos y nombres de archivos. Usando variables comunes, puede escribir los archivos de éxito y fracaso e imprimir un registro de resumen que contiene los valores en los que se establecen las variables. Una vez configurados, puede configurar una notificación correo que envíe esta información al destinatario que defina.
Operación 2: La segunda operación recupera datos del extremo de origen.
Operación 3: Cuando un conector no admite la paginación, la tercera operación se utiliza para paginar los datos de los extremos de destino que solo admiten una cantidad limitada de registros.
Operación 4: La cuarta operación implementa la lógica restante necesaria para realizar una acción en el extremo de destino.
Operación 5: La operación final está configurada para enviar una única notificación correo que entrega una compilación de mensajes de error (de cualquiera de las operaciones) al destinatario que defina.