Dichiarazione di variabili per i servizi con interazione dell'utente lato client

Per ogni servizio con interazione dell'utente lato client creato, dichiarare le variabili per catturare i dati che i passi o le attività in tale servizio con interazione dell'utente utilizzano.

Informazioni su questa attività

Puoi aggiungere le seguenti variabili al servizio con interazione dell'utente lato client.

Tabella 1. Variabili disponibili per l'aggiunta ai servizi con interazione dell'utente lato client
Variabile Descrizione
Immissione Variabili che rappresentano i dati di input che vengono passati al servizio umano lato client corrente
Output Le variabili che rappresentano i dati di output che il servizio con interazione dell'utente lato client corrente restituisce al proprio chiamante
Privato Variabili locali utilizzate solo all'interno del servizio con interazione dell'utente lato client
Valori processo esposto I valori di processo esposti (EPV) possono essere collegati e utilizzati da un servizio con interazione dell'utente lato client
Variabili di ambiente Le variabili di ambiente possono essere collegate e utilizzate da un servizio con interazione dell'utente lato client
Valori variabili predefiniti
Per le variabili di input e private che definisci per i servizi umani lato client root o nidificati, puoi specificare i valori predefiniti che diventano effettivi al runtime. Per i valori predefiniti, è possibile specificare sia valori semplici che complessi, nonché array per gli elenchi. A seconda di come viene utilizzato il servizio con interazione dell'utente lato client, i valori predefiniti hanno effetto come segue:
  • Quando il servizio con interazione dell'utente lato client viene implementato come un'attività e l'istanza del processo specifica i valori delle variabili per l'attività tramite l'associazione di input, i valori specificati diventano effettivi al runtime. Se una variabile associata dal processo non viene inizializzata, viene utilizzato il relativo valore null associato. Se non viene specificato alcun valore di variabile (nessuna associazione), i valori predefiniti diventano effettivi al runtime. Consultare anche Creazione e avvio di un'attività del servizio umano lato client in un processo.
  • Quando un servizio umano lato client è implementato come servizio avviabile o come URL, ad esempio, se ci sono valori di variabili di input specificati come parametri dell URL, i valori specificati hanno effetto in fase di esecuzione. In caso contrario, i valori predefiniti diventano effettivi.
  • Quando un servizio con interazione dell'utente lato client nidificato viene richiamato da un servizio con interazione dell'utente lato client parent e l'elemento parent specifica i valori della variabile tramite l'associazione di input, i valori specificati diventano effettivi al runtime. Se non è presente alcuna associazione, il servizio nidificato utilizza i valori predefiniti. Se è presente un'associazione, l'input nidificato utilizza il valore della variabile principale, anche se non è inizializzato.
  • Quando le variabili vengono dichiarate all'interno di un gestore eventi di tipo errore o modifica dati, i valori predefiniti diventano effettivi la prima volta che il gestore eventi viene eseguito nell'istanza corrente del servizio nidificato che contiene il gestore eventi. Se si esce dal servizio con interazione dell'utente lato client che contiene il gestore eventi e lo si immette nuovamente, tutte le variabili, incluse quelle del gestore eventi, vengono reimpostate.
Suggerimento: nei servizi con interazione dell'utente lato client implementati come interfacce utente dei dettagli dell'istanza, solo le variabili private possono avere valori predefiniti.
Variabili di processo esposte (EPV) e variabili di ambiente
È possibile collegarsi ai valori di processo esposti (EPV) e alle variabili di ambiente esistenti nella vista Variabili di un servizio con interazione dell'utente lato client, in modo da poter accedere alle variabili tramite gli script definiti per il proprio servizio con interazione dell'utente lato client. È possibile fare riferimento al nome delle variabili nel modo seguente:
  • tw.epv.[epv_name].[epv_variable_name]
  • tw.env.[env_variable_name]
A seconda che il tuo servizio con interazione dell'utente lato client venga eseguito nel contesto di un' automazione del flusso di lavoro parent o come parte di un toolkit dipendente, è possibile accedere alle sue variabili in modo diverso:
  • Se una variabile con lo stesso nome esiste già nell' automazione del flusso di lavoroparent, viene utilizzato il valore dell'automazione del flusso di lavoro , indipendentemente dalla struttura o dalle proprietà.
  • Se una variabile con lo stesso nome esiste nel toolkit dipendente ma non esiste nell'applicazione del processoautomazione del flusso di lavoro, viene utilizzato il valore del toolkit.
Quando un EPV o una variabile di ambiente con lo stesso nome esiste sia nell' automazione del flusso di lavoro parent che nel toolkit dipendente, il formato specificato negli script determina quale valore di variabile viene utilizzato.
  • Se si desidera utilizzare il valore dell' automazione del flusso di lavoro, utilizzare il nome breve della variabile negli script, ad esempio,tw.epv.[epv_name]oppuretw.env.
  • Se vuoi utilizzare il valore del toolkit, indipendentemente dai nomi che si sovrappongono, utilizza il formato tw.epv.toolkit o tw.env.toolkit nei tuoi script.
Nota: la dichiarazione della variabile deve essere una dipendenza diretta del contesto in cui è eseguito il servizio con interazione dell'utente lato client. Le dichiarazioni nei toolkit nidificati non verranno risolte al runtime. Pertanto, quando la variabile viene dichiarata in un toolkit, l' automazione del workflow deve dipendere da tale toolkit.
I valori della variabile sono disponibili quando si esegue il servizio con interazione dell'utente lato client e vengono richiamati solo quando il servizio con interazione dell'utente lato client viene avviato. Per modificare i valori in modo programmatico, utilizzare un servizio richiamato che implementa una chiamata della funzione API JavaScript lato server. Ad esempio:tw.epv.[epv_name].[epv_variable_name].update(<value>, <date>).
Il nuovo valore non verrà richiamato automaticamente dal servizio con interazione dell'utente lato client. I servizi umani lato client appena avviati vedranno il nuovo valore dopo l'ora pianificata.
Per ulteriori informazioni su EPV e variabili di ambiente, vedi Creazione di EPV (valori di processo esposti) e Impostazione delle variabili di ambiente.
Confronto tra creazione e avvio di un'attività del servizio umano lato client in un processo
Il seguente comportamento previsto si verifica quando si utilizza un'attività di servizio con interazione dell'utente lato client in un processo o si richiama un'API di attività o processo REST Business Automation Workflow . A seconda dell'istanza dell'attività utilizzata per il richiamo dei dati, Process Inspector potrebbe mostrare dati non sincronizzati per l'attività, come riportato di seguito:
  • Quando l'attività viene creata, i dati vengono richiamati dall'istanza del processo al momento della creazione.
  • In seguito, quando un utente avvia l'attività, i dati vengono recuperati dall'istanza del processo in esecuzione, che potrebbe essere diversa da quella creata al momento della creazione dell'attività.
Pertanto, Process Inspector e l'API REST del Business Automation Workflow potrebbero mostrare che i dati dell'attività non sono sincronizzati finché l'attività non viene avviata dall'utente.
Il comportamento descritto non viene osservato quando si utilizzano i servizi umani Heritage, che non richiamano automaticamente i dati dall'istanza del processo di runtime quando un utente avvia l'attività.
Esposizione dei dati aziendali a livello di attività dell'utente per l'uso nelle API di ricerca
È ora possibile esporre i dati aziendali a livello di attività, oltre alle variabili di tipo semplice e non a elenco a livello di processo. Ciò significa che i dati sono disponibili per la ricerca quando le istanze dei task dell'utente sono in esecuzione o sono state completate, consentendo di recuperare efficacemente le informazioni pertinenti. Inoltre, è possibile definire alias per le variabili esposte e utilizzarle insieme ai metadati dell'attività e del processo nelle API di ricerca delle attività.

Per gli sviluppatori dell'interfaccia utente, le ricerche sui dati aziendali forniscono il controllo sui dati delle attività ricercabili, esponendo solo le informazioni rilevanti. Per gli utenti aziendali, aiuta a costruire e raffinare le ricerche sulle attività in Workplace utilizzando valori di dati specifici durante e dopo il completamento delle attività.

Suggerimento: le ricerche di dati aziendali funzionano sia per le ricerche avanzate che per quelle di base. Tuttavia, per le ricerche di base è necessario configurare l'indicizzazione dell'archivio dati federato. Per ulteriori informazioni, vedere Abilitazione e configurazione dell'indicizzazione dell'archivio dati federato Il link esterno apre una nuova finestra o scheda. Per ulteriori informazioni su come utilizzare i dati aziendali esposti nelle ricerche, vedere Ricerche in Workplace Il link esterno apre una nuova finestra o scheda.

È possibile esporre i seguenti tipi di variabili:

Tabella 2. Tipi di variabili che possono essere esposti
Tipo di variabile Disponibile nella ricerca delle attività
Tipo semplice (ad esempio, booleano, stringa, intero) Vero
Non elenco (valore singolo) Vero
Elenco (multi-valore) N
Tipo composito N
Proprietà di tipo semplice degli oggetti aziendali Vero
Per esporre i dati aziendali e definire un alias per essi:
  1. Nel servizio umano lato client, andare alla scheda Variables e selezionare la variabile che si desidera esporre.
  2. Selezionare Esponi negli ambienti di lavoro per rendere disponibili i dati aziendali nell'attività dell'utente.
  3. Nel campo Alias, digitare un nome univoco da assegnare alla variabile esposta.
Nota: Il nome deve essere unico all'interno del servizio umano lato client, a meno che non sia condiviso con una variabile di input o output con lo stesso nome, tipo e cardinalità.

Procedura

Per aggiungere una variabile di input, output, privata o EPV al servizio con interazione dell'utente lato client:

  1. Apri il tuo servizio umano lato cliente.
  2. Passare a Variabili, quindi fare clic sul segno più accanto a Input per aggiungere una nuova variabile di input.
  3. Nella sezione Dettagli :
    1. Specificare il nome della variabile.
      I nomi delle variabili sono sensibili al maiuscolo / minuscolo e devono iniziare con una lettera minuscola, con le parole successive in maiuscolo, ad esempio myVar. Non utilizzare caratteri di sottolineatura o spazi nei nomi delle variabili.
    2. Fare clic su Selezionare accanto a Tipo variabile per selezionare il tipo di variabile dall'elenco Seleziona elemento libreria .
      Vengono elencati anche gli oggetti di business personalizzati creati. Per creare un nuovo oggetto business, fare clic su Nuovo e completare i passi della procedura guidata.
      I servizi con interazione dell'utente lato client non supportano istanze di oggetti di business che fanno riferimento a se stessi. Ad esempio, il seguente JavaScript genera un errore quando viene utilizzato in un servizio con interazione dell'utente lato client:
      tw.local.myVariable= {};
      tw.local.myVariable.pointer= tw.local.myVariable;
    3. Facoltativo: Specificare una descrizione di variabile in Documentazione.
    4. Facoltativo: se si desidera che la variabile sia un array, selezionare È un elenco.
  4. Per specificare un valore predefinito per l'input o la variabile privata che si sta aggiungendo, selezionare Ha valore predefinito in Valore predefinito, quindi immettere il valore predefinito.
    Nota: per oggetti di business complessi, lo script del valore predefinito deve dichiarare una variabile e restituirla specificando l'ultima riga come nome della variabile. Ad esempio:
    var autoObject = <new_instance>; 
    ...
    autoObject
  5. Salvare la configurazione.
  6. Ripetere i passi da 2 a 4 per aggiungere una variabile di output, privata, EPV o di ambiente al servizio con interazione dell'utente lato client.
  7. Fare clic su Salva o Termina modifica.
    Per informazioni dettagliate sulla dichiarazione di variabili per i servizi umani lato client, vedere Dichiarazione di variabili

Cosa fare successivamente

Puoi ora associare le variabili di input e di output che vuoi passare ai passi e alle attività nel tuo servizio con interazione dell'utente lato client. Consultare Associazione dati per i servizi con interazione dell'utente lato client nidificati.