13 SDK di Processo Action Standard: Descrizione e Utilizzo

13.1 SDK Action: Set entity reference
Questa funzione SDK permette di forzare un determinato record all'interno di un'entità (dello stesso modulo) coinvolta nel processo.
Viene utilizzata, principalmente, per poter eseguire una qualsiasi tipo di azione standard anche sui record che sono stati inseriti all'interno di campi "Relazionato a" di una form dinamica.
Come primo parametro va passato il metaid (l'id che identifica univocamente l'istanza di un modulo all'interno di un processo) dell'istanza sulla quale si vuole forzare il record.
Invece, come secondo parametro, va passato il crmid del record da forzare.
ESEMPIO DI UTILIZZO
Per comprenderne al meglio il funzionamento, qui di seguito viene riportato l'esempio di utilizzo della funzione SDK Set entity reference() per la gestione dell'azienda esistente all'interno del processo BPMN standard di conversione del lead.
Nella form dinamica del process helper (configurata nella User Task "Request details"), viene data la possibilità all'utente di creare una nuova azienda oppure di selezionarne una esistente.
Nello specifico, il crmid dell'azienda esistente viene storicizzato in un campo di tipo "Relazionato a" presente all'interno della form dinamica (Figura 1)
Figura 1 (cliccare sull'immagine per una risoluzione grafica maggiore)
Questa tipologia di campo non stabilisce una vera e propria relazione, di conseguenza non viene visto come un'istanza completa del modulo Aziende.
Infatti, non possiede alcun metaid (ossia l'id che identifica univocamente l'istanza di un modulo all'interno di un processo).
Per questo, le azioni eseguibili sul record contenuto nel campo di relazione sono limitate.
Al contrario, l'entità istanziata dall'azione di Crea entità (configurata nella Action Task "Create account") possiede un proprio metaid (ovvero 61), questo perché è stata coinvolta a tutti gli effetti all'interno del processo (Figura 2)
Figura 2
Nel caso del processo di conversione del lead, non è possibile coinvolgere all'interno dell'azione standard "Trasferisci relazioni" l'azienda contenuta all'interno del campo di relazione.
Per risolvere questo problema, è possibile ricorrere all'utilizzo della funzione SDK Set entity reference() per forzare il record dell'azienda esistente (presente nel campo di relazione) all'interno dell'istanza del modulo Azienda coinvolta tramite l'azione di Crea entità (quindi dell'azienda creata direttamente nel processo).
In questo modo, potranno essere eseguite tutte le azioni necessarie senza limitazioni.
Quindi, all'interno dell'Action Task "Use existing account" è stata configurata un'azione di tipo "Funzioni SDK" nella quale è stata richiamata l'SDK Set entity reference().
Come primo parametro è stato passato il metaid dell'istanza dell'azienda creata, ovvero 61 (Figura 3)
Figura 3 (cliccare sull'immagine per una risoluzione grafica maggiore)
Come secondo parametro è stato passato il contenuto del campo di relazione contenente l'azienda esistente (Figura 4)
Figura 4 (cliccare sull'immagine per una risoluzione grafica maggiore)
In questo modo, per entrambe le casistiche (azienda creata o esistente), nell'Action Task "Transfer relations to account" è stato sufficiente configurare un'unica azione di Trasferisci relazioni. (Figura 5)
Figura 5 (cliccare sull'immagine per una risoluzione grafica maggiore)

13.2 SDK Action: Add comment to ticket
Questa funzione SDK permette di generare un commento che verrà inserito nella sezione "Commenti" del modulo Assistenza Clienti.
Come primo parametro, andrà passato il crmid del ticket sul quale si vuole aggiungere il commento.
Come secondo parametro, andrà passato il testo del commento da inserire.
Come terzo parametro, andrà inserito l'id dell'utente o del contatto che dovrà figurare come autore del commento.
Nel caso in cui, come terzo parametro, si passi l'id di un utente crm, come quarto parametro si dovrà passare la voce fissa "user".
Invece nel caso in cui, come terzo parametro, si passi l'id di un record del modulo Contatti, come quarto parametro si dovrà passare la voce fissa "customer".
Come quinto parametro, andrà passato il valore fisso "true" nel caso in cui si voglia inviare anche la mail automatica di avviso contenente il testo del commento e un link diretto per accedere rapidamente al dettaglio del ticket (come già avviene di default verso gli utenti portali nel momento in cui un utente crm scrive un commento).
In caso contrario, andrà passato il valore fisso "false".
ESEMPIO DI UTILIZZO
Per comprenderne al meglio il funzionamento, qui di seguito viene riportato l'esempio di utilizzo della funzione SDK Add comment to ticket() per inserire in automatico un commento contenente il seguente testo:
"Gentile cliente, prenderemo in carico la sua richiesta il prima possibile."
All'interno di un'Action Task procediamo con la configurazione di un'azione di tipo "Funzioni SDK" nella quale richiamiamo l'SDK Add comment to ticket().
Come primo parametro passiamo il crmid del ticket sul quale si vuole aggiungere il commento, nel nostro caso $44-crmid (Figura 1)
Figura 1 (cliccare sull'immagine per una risoluzione grafica maggiore)
Come secondo parametro passiamo il testo del commento da inserire, ovvero "Gentile cliente, prenderemo in carico la sua richiesta il prima possibile." (Figura 2)
Figura 2 (cliccare sull'immagine per una risoluzione grafica maggiore)
Come terzo parametro passiamo lo userid fisso dell'utente amministratore, in questo modo figurerà sempre come autore del commento (Figura 3)
Figura 3 (cliccare sull'immagine per una risoluzione grafica maggiore)
Come quarto parametro passiamo il valore fisso "user" (Figura 4)
Figura 4 (cliccare sull'immagine per una risoluzione grafica maggiore)
Come quinto parametro passiamo il valore fisso "true" per mandare la mail automatica di avviso al contatto con utenza portale attiva collegato al ticket (Figura 5)
Figura 5 (cliccare sull'immagine per una risoluzione grafica maggiore)
Il risultato finale sarà come quello mostrato in Figura 6
Figura 6 (cliccare sull'immagine per una risoluzione grafica maggiore)
La mail automatica inviata al contatto con utenza portale attiva collegato al ticket sarà come quello mostrato in Figura 7
Figura 7 (cliccare sull'immagine per una risoluzione grafica maggiore)

13.3 SDK Action: Update ModLight row
Questa funzione SDK permette di eseguire un aggiornamento delle righe esistenti di un campo tabella presente su un determinato modulo.
Come primo parametro va passato l'ID della riga, ossia il parametro chiave che permette di identificare in maniera univoca una specifica riga esistente nel campo tabella.
Come secondo parametro va passato il nome a Data Base della colonna del campo tabella che si vuole aggiornare.
Come ultimo parametro va passato il valore che si vuole inserire all'interno della colonna definita come secondo parametro.
ESEMPIO DI UTILIZZO
Per comprenderne al meglio il funzionamento, qui di seguito viene riportato l'esempio di utilizzo della funzione SDK Update ModLight row() per aggiornare in automatico a "si" il valore della colonna "Processata" per tutte le righe esistenti del campo tabella "Operazioni" presente nel modulo Commessa. (Figura 1)
Figura 1
All'interno di un'Action Task procediamo con la configurazione di un'azione di tipo cicla righe sul campo tabella "Operazioni" e per ogni riga "Funzioni SDK" nella quale richiamiamo l'SDK Update ModLight row(). (Figura 2)
Figura 2
Come primo parametro inseriamo il valore corrente della variabile "ID" del campo tabella "Operazioni" (sul quale stiamo eseguendo il ciclo), quindi nel nostro caso "$28-ml3::crmid:curr". (Figura 3)
NOTA BENE: si tratta di un dato che non è presente tra le colonne della tabella ma che viene proposto in automatico come variabile all'interno del processo
Come secondo parametro inseriamo il nome a Data Base della colonna "Processata", quindi nel nostro caso "f8". (Figura 3)
Come ultimo parametro inseriamo il valore "si" che in questo caso, essendo la colonna "Processata" di tipologia checkbox, a Data Base corrisponde al valore "1". (Figura 3)
Figura 3

13.4 SDK Action: Update DynaForm table row
Questa funzione SDK permette di eseguire un aggiornamento delle righe esistenti di un campo tabella presente su una form dinamica di un process helper.
Come primo parametro va passato il metaid, ossia l'ID che identifica univocamente una specifica form dinamica all'interno del processo.
NOTA BENE: va passato il numero senza il prefisso DF, quindi se ad esempio l'ID è DF9 va inserito solamente 9.
Come secondo parametro va passato il nome a Data Base del campo tabella presente sulla form dinamica del process helper.
Come terzo parametro va passata la sequenza della tabella, ossia il parametro chiave che viene utilizzato per identificare le righe da aggiornare.
Come quarto parametro va passato il nome a Data Base della colonna del campo tabella che si vuole aggiornare.
Come ultima parametro  va passato il valore che si vuole inserire all'interno della colonna definita come quarto parametro.
ESEMPIO DI UTILIZZO
Per comprenderne al meglio il funzionamento, qui di seguito viene riportato l'esempio di utilizzo della funzione SDK Update DynaForm table row() per aggiornare in automatico a "si" il valore della colonna "Processata" pet tutte le righe del campo tabella "Operazioni" presente su una form dinamica. (Figura 1)
Figura 1
All'interno di un'Action Task procediamo con la configurazione di un'azione di tipo cicla righe sul campo tabella "Operazioni" e per ogni riga "Funzioni SDK" nella quale richiamiamo l'SDK Update DynaForm table row(). (Figura 2)
Figura 2
Come primo parametro inseriamo il il metaid, ossia l'ID che identifica univocamente una specifica form dinamica all'interno del processo senza il prefisso DF, quindi nel nostro caso 3. (Figura 3)
Come secondo parametro inseriamo il nome a Data Base del campo tabella presente sulla form dinamica del process helper, quindi nel nostro caso "vcf_8". (Figura 3)
Come terzo parametro inseriamo il valore corrente della variabile "Sequenza", quindi nel nostro caso "$DF3-vcf_8::index:curr". (Figura 3)
Come quarto parametro inseriamo il nome a Data Base della colonna "Processata", quindi nel nostro caso "vcf_10". (Figura 3)
Come ultimo parametro inseriamo il valore "si" che in questo caso, essendo la colonna "Processata" di tipologia checkbox, a Data Base corrisponde al valore "1". (Figura 3)
Figura 3

13.5 SDK Action: Gestisci Ricezione Newsletter
Questa funzione SDK permette di abilitare o disabilitare la ricezione delle newsletter sull'indirizzo mail associato ad un Lead, Contatto o Azienza pilotando il campo checkbox "Ricevi Newsletter".
Come primo parametro, andrà passato il crmid del record sul quale si vuole aggiornare il valore del campo "Ricevi Newsletter".
Come secondo parametro andrà passato il valore fisso "lock" nel caso in cui si voglia impostare a "no" il campo "Ricevi Newsletter", invece per impostarlo a "si" andrà passato il valore fisso "unlock".
ESEMPIO DI UTILIZZO
Per comprenderne al meglio il funzionamento, qui di seguito viene riportato l'esempio di utilizzo della funzione SDK Set receiving newsletter per disabilitare la ricezione delle newsletter per un Lead.
Come primo parametro passiamo il crmid del lead sul quale si vuole aggiornare il valore del campo "Ricevi Newsletter", nel nostro caso $1-crmid (Figura 1)
Come secondo parametro passiamo il valore fisso "lock" (Figura 1)
Figura 1 (cliccare sull'immagine per una risoluzione grafica maggiore)