Script PowerShell

Abstract

• Dove conservare gli script Powershell?
• Oggetto JSON che eLegere fornisce al PowerShell
• Oggetto JSON con i dati della risposta
  • Codici di ritorno
• Come aggiungere parametri aggiuntivi
• Tipi di azioni e comportamento eLegere

La sezione Script PowerShell spiega:

• In quale cartella conservare gli script PowerShell.
• Quale oggetto JSON eLegere fornisce allo script PowerShell e la sua struttura.
• Qual è la struttura dell'oggetto JSON con il risultato del PowerShell.
• Come specificare parametri addizionali e valori.
• Differenze nel comportamento degli script PowerShell secondo il contesto d'utilizzo.

Dove conservare gli script Powershell?

eLegere immagazzina tutti gli script PowerShell in una cartella che gli amministratori dell'installazione hanno configurato.

Contatta i tuoi amministratori eLegere per inserire i tuoi script PowerShell in un folder dedicato sulla macchina.

Oggetto JSON che eLegere fornisce al PowerShell

Impara la struttura dell'oggetto JSON con le informazione delle righe che eLegere fornisce allo script PowerShell per eseguire le proprie operazioni.

Il tuo script PowerShell deve avere il parametro @ActionContext per ricevere l'oggetto JSON da eLegere.

@ActionContext riceve come valore una stringa contenente dei dati JSON come valore. L'oggetto JSON nella stringa ha la seguente struttura:

{
  "Items": {
    "956cdabb-b752-4dea-9dc7-317bc45e202e": {
      "NewItem": {},
      "OldItem": {} | null
    },
    "e6eeb3ac-91c6-43dc-a1f2-58705ecbe06e": {
      "NewItem": {},
      "OldItem": {} | null
    }
  },
  "UserId": "j.doe@vesenda.com",
  "TimezoneMsOffset": 7200000.0
}

Segue una spiegazione delle chiavi dell'oggetto JSON:

• La chiave Items elenca tutti gli oggetti delle righe da registrare o modificare nel database.
  • Il GUID identifica ciascuno Storage. Questo oggetto contiene due ulteriori oggetti:
    • La chiave NewItem è l'oggetto JSON che contiene la riga con gli ultimi cambiamenti.
    • La chiave OldItem è l'oggetto JSON contenente le informazioni della riga prima dei cambiamenti.
• La chiave UserId è lo username del logon.
• La chiave TimezoneMsOffset sta per la differenza di tempo fra UTC e il client locale che sta eseguendo l'azione. Il valore è espresso in millisecondi.

Oggetto JSON con i dati della risposta

Segue la spiegazione dell'oggetto contenente il messaggio con le informazione e il resultato dell'operazione che puoi incorporare nel tuo script PowerShell.

Il tuo script PowerShell può opzionalmente ritornare informazioni all'utente riguardo l'azione. eLegere mostra nel client un messaggio di errore specifico e il risultato secondo i valori delle chiavi (se aggiunti al PowerShell).

{
  "Message": "",
  "ReturnCode": ""
}

• Message: Una stringa che contiene il messaggio da mostrare nel client all'utente.
• ReturnCode: Il valore della chiave specifica come eLegere deve comportarsi dopo l'esecuzione del PowerShell e quale risultato riportare. Se non specificato e lasciato vuoto, il valore passato è 000200 (corrispondente a un successo per l'operazione). Consulta Codici di ritorno per la lista dei comportamenti.

Codici di ritorno

Ciascun codice specifica un risultato differente da comunicare all'utente.

Codice	Nome	Comportamento
000500	Fallito	eLegere blocca l'intera transazione del database e ripristina lo stato precedente della tabella. Mostra un messaggio di errore.
000200	Successo	eLegere mostra un messaggio di "Successo". (Questo è il valore predefinito per il parametro ReturnCode.)

Come aggiungere parametri aggiuntivi

Impara come aggiungere parametri aggiuntivi al PowerShell in eLegere.

Info

Consulta Come incorporare script PowerShell nella tua applicazione nella Guida Designer per imparare come creare una Custom Action in eLegere. Scegli Invoke PowerShell dal menù a tendina.

Puoi specificare parametri aggiuntivi e chiavi per un PowerShell. Clicca su New nelle impostazioni Parameters della Custom Action. L'azione permette di aggiungere una nuova coppia di parametri e valori.

Tipi di azioni e comportamento eLegere

Impara quali valori lo script PowerShell riceve tramite l'oggetto JSON di eLegere in base all'azione.

• Custom Action con innesco Event: L'oggetto JSON che eLegere fornisce ha Items valorizzato con le informazioni della riga.
• Custom Action con innesco Manuale: L'oggetto JSON che eLegere fornisce ha Items valorizzato con le informazioni della riga.
• Job Schedulato: Lo script PowerShell funziona al di fuori di un'applicazione, quindi le chiavi di Items non hanno valore.

Azione	Parametro Items
Custom Action con innesco Event
Custom Action con innesco Manuale
Job Schedulato

Versione di PowerShell e Tipi di azioni

Considera quale versione di PowerShell viene utilizzata per ciascuna azione eLegere quando prepari lo script:

• Se scrivi uno script PowerShell per lo Scheduler, lo script funzionerà usando una versione self-hosted di PowerShell 7.
• Se scrivi uno script PowerShell per le Custom Actions, lo script funzionerà usando la versione di PowerShell installata con la tua installazione eLegere.