Flujos de trabajo

​

Define un flujo de trabajo

import {
  defineWorkflow,
  STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS,
} from 'twenty-sdk/define';

const COMPANY = STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.universalIdentifier;
const SCORE_COMPANY_FUNCTION = '0f6c0b3e-8a4f-4f0e-9d0a-3c1e5b7a2d41';

const SCORE_NEW_COMPANIES = {
  workflow: 'c2a4e6f8-1b3d-4f5a-8c7e-9d0b2a4c6e81',
  trigger: 'c2a4e6f8-1b3d-4f5a-8c7e-9d0b2a4c6e82',
  score: 'c2a4e6f8-1b3d-4f5a-8c7e-9d0b2a4c6e83',
  save: 'c2a4e6f8-1b3d-4f5a-8c7e-9d0b2a4c6e84',
};

export default defineWorkflow({
  universalIdentifier: SCORE_NEW_COMPANIES.workflow,
  name: 'Score new companies',
  version: {
    trigger: {
      universalIdentifier: SCORE_NEW_COMPANIES.trigger,
      type: 'DATABASE_EVENT',
      settings: {
        objectUniversalIdentifier: COMPANY,
        action: 'created',
      },
      nextStepIds: [SCORE_NEW_COMPANIES.score],
    },
    steps: [
      {
        universalIdentifier: SCORE_NEW_COMPANIES.score,
        name: 'Score the company',
        type: 'LOGIC_FUNCTION',
        logicFunctionUniversalIdentifier: SCORE_COMPANY_FUNCTION,
        input: { companyName: '{{trigger.properties.after.name}}' },
        nextStepIds: [SCORE_NEW_COMPANIES.save],
      },
      {
        universalIdentifier: SCORE_NEW_COMPANIES.save,
        name: 'Save the score',
        type: 'UPDATE_RECORD',
        input: {
          objectUniversalIdentifier: COMPANY,
          objectRecordId: '{{trigger.recordId}}',
          objectRecord: { leadScore: `{{${SCORE_NEW_COMPANIES.score}.score}}` },
          fieldsToUpdate: ['leadScore'],
        },
        nextStepIds: [],
      },
    ],
  },
});

• El flujo de trabajo, su desencadenador y cada paso necesitan su propio universalIdentifier. Mantenlos estables entre versiones: así es como Twenty encuentra el flujo de trabajo instalado en la próxima instalación.
• nextStepIds conecta el grafo. El desencadenador apunta a los primeros pasos, y cada paso apunta a los pasos que se ejecutan después de él.
• Un paso lee la salida anterior con {{trigger.\<path>}} o {{\<step universalIdentifier>.\<path>}}.
• La compilación valida toda la definición: los tipos de desencadenador o de paso no compatibles, los enlaces de pasos rotos y las referencias a pasos desconocidos hacen que falle.

​

Referencia a otras entidades

• Objetos y campos: los propios de tu aplicación o los estándar mediante STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS. El ejemplo anterior supone que la aplicación también define un campo numérico leadScore en Company con defineField(): un paso de registro que escribe en un campo que falta en el espacio de trabajo hace que falle la instalación.
• Funciones lógicas: las propias de tu aplicación, expuestas como una acción de flujo de trabajo con workflowActionTriggerSettings. La aplicación Personalizada del espacio de trabajo también puede hacer referencia a las acciones de flujo de trabajo de las otras aplicaciones instaladas en el espacio de trabajo, al igual que los flujos de trabajo creados en la aplicación.
• Agentes: los propios de tu aplicación, de defineAgent().

​

Disparadores

​

Pasos

• Los pasos de registro usan objectUniversalIdentifier en lugar de un nombre de objeto.
• Los filtros y las ordenaciones apuntan a campos con fieldMetadataUniversalIdentifier.
• Los campos de formulario de tipo RECORD nombran su objeto con settings.objectUniversalIdentifier. Los campos de tipo SELECT y MULTI_SELECT ofrecen las opciones de un campo existente del mismo tipo, denominado con settings.selectedFieldUniversalIdentifier.
• Para ejecutar tu propio código, usa un paso LOGIC_FUNCTION. El paso Code del constructor no está disponible.
• Los pasos de correo electrónico y calendario se ejecutan solo si el rol de tu aplicación tiene el indicador de permiso correspondiente: SystemPermissionFlag.SEND_EMAIL_TOOL para SEND_EMAIL y DRAFT_EMAIL, SystemPermissionFlag.CREATE_CALENDAR_EVENT_TOOL para CREATE_CALENDAR_EVENT. El espacio de trabajo lo concede al instalar la aplicación, y el paso puede usar cualquier cuenta conectada en el espacio de trabajo, como un flujo de trabajo creado en la aplicación.
• Los ID de las cuentas conectadas son locales para cada espacio de trabajo, así que no codifiques uno de forma fija. Pase la cuenta como una variable. Los pasos de correo electrónico también aceptan un id de miembro del espacio de trabajo, como {{trigger.properties.after.assigneeId}}, que se resuelve en la primera cuenta de ese miembro que puede enviar.

​

Después de la instalación

• El flujo de trabajo está activo en cuanto se instala la aplicación, y sus ejecuciones aparecen junto con las otras ejecuciones de flujos de trabajo del espacio de trabajo.
• La instalación de una nueva versión de la aplicación actualiza el flujo de trabajo en el mismo lugar.
• Los usuarios no pueden editar un flujo de trabajo instalado. Para personalizar uno, lo duplican: la copia es suya para editarla.