Flussi di lavoro

​

Definisci un workflow

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: [],
      },
    ],
  },
});

• Il workflow, il relativo trigger e ogni passaggio necessitano del proprio universalIdentifier. Mantienili stabili tra le release: è così che Twenty trova una corrispondenza con il workflow installato all’installazione successiva.
• nextStepIds collega il grafo. Il trigger punta ai primi passaggi e ogni passaggio punta ai passaggi eseguiti dopo di esso.
• Un passaggio legge l’output precedente con {{trigger.\<path>}} o {{\<step universalIdentifier>.\<path>}}.
• La build convalida l’intera definizione: tipi di trigger o passaggio non supportati, collegamenti tra passaggi non validi e riferimenti a passaggi sconosciuti causano l’errore.

​

Riferimento ad altre entità

• Oggetti e campi: quelli dell’app oppure quelli standard tramite STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS. L’esempio precedente presuppone che l’app definisca anche un campo numerico leadScore su Company con defineField(): un passaggio relativo a un record che scrive un campo assente dallo spazio di lavoro causa l’errore di installazione.
• Funzioni logiche: quelle dell’app, esposte come azione del workflow con workflowActionTriggerSettings. L’applicazione Custom dello spazio di lavoro può anche fare riferimento alle azioni dei workflow delle altre app installate nello spazio di lavoro, come possono fare i workflow creati nell’app.
• Agenti: quelli dell’app, da defineAgent().

​

Trigger

​

Passaggi

• I passaggi relativi ai record usano objectUniversalIdentifier anziché un nome di oggetto.
• I filtri e gli ordinamenti puntano ai campi con fieldMetadataUniversalIdentifier.
• I campi del modulo di tipo RECORD denominano il proprio oggetto con settings.objectUniversalIdentifier. I campi di tipo SELECT e MULTI_SELECT offrono le opzioni di un campo esistente dello stesso tipo, denominato con settings.selectedFieldUniversalIdentifier.
• Per eseguire il tuo codice, usa un passaggio LOGIC_FUNCTION. Il passaggio Code del builder non è disponibile.
• I passaggi email e calendario vengono eseguiti solo se il ruolo della tua app dispone del flag di autorizzazione corrispondente: SystemPermissionFlag.SEND_EMAIL_TOOL per SEND_EMAIL e DRAFT_EMAIL, SystemPermissionFlag.CREATE_CALENDAR_EVENT_TOOL per CREATE_CALENDAR_EVENT. Il workspace lo concede installando l’app e il passaggio può quindi usare qualsiasi account connesso nel workspace, come un workflow creato nell’app.
• Gli ID degli account connessi sono locali a ogni spazio di lavoro, quindi non codificarne uno in modo fisso. Passa l’account come variabile. I passaggi Email accettano anche un ID membro dell’area di lavoro, ad esempio {{trigger.properties.after.assigneeId}}, che viene risolto nel primo account di quel membro in grado di inviare.

​

Dopo l’installazione

• Il workflow è attivo non appena l’app viene installata e le relative esecuzioni vengono visualizzate insieme alle altre esecuzioni di workflow dello spazio di lavoro.
• L’installazione di una nuova versione dell’app aggiorna il workflow sul posto.
• Gli utenti non possono modificare un workflow installato. Per personalizzarne uno, lo duplicano: la copia può essere modificata da loro.