Vai al contenuto principale
Un oggetto globale che fornisce accesso al documento, ai suoi field e ai Parameter della transaction in cui il documento viene elaborato. Assegna l’esito del controllo alla proprietà CheckSucceeded.

​
Proprietà

NomeTipoLivello di accessoDescrizione
CheckSucceededboolLettura/scritturaIndica se la condizione della regola è soddisfatta. Il valore predefinito è true. Lo script dovrebbe impostarla su false se la condizione non è soddisfatta. In tal caso, verrà mostrato all’operatore il messaggio di errore predefinito: “Error in the rule <rule_name>: <field_name>”. Se preferisci un messaggio diverso, impostalo usando la proprietà ErrorMessage. Importante: un errore viene generato solo se CheckSucceeded è impostata su false. Se lo script non ha cambiato il valore di CheckSucceeded su false, non verrà visualizzato alcun messaggio di errore anche se le condizioni non sono state soddisfatte.
CurrentFieldFieldSola letturaIl field verificato dalla regola. Per i field ripetuti verificati da regole ripetute: l’istanza specifica del field verificata dalla chiamata corrente. Se la regola fa riferimento al documento nel suo insieme, restituisce un valore null.
DocumentDocumentSola letturaIl documento per cui viene eseguita la regola.
ErrorMessagestringLettura/scritturaMessaggio definito dall’utente da visualizzare se lo script ha impostato CheckSucceeded su false. Se non imposti questa proprietà, il messaggio visualizzato in caso di errore sarà “Error in the rule <rule_name>: <field_name>”.
TransactionTransactionSola letturaLa Transaction corrente.

​
Metodi

NameDescription
Field GetField(string fieldName);Ottiene il Field per nome o identificatore. Importante! Passare direttamente a questo metodo il nome del Field come stringa: una variabile con lo stesso valore stringa non funzionerà. Il preprocessore che analizza il codice dello script prima dell’esecuzione sostituirà il nome del Field con il suo identificatore, ma non sarà in grado di elaborare una variabile. Utilizzare il percorso completo per indirizzare i Field contenuti in un gruppo di Field, ad esempio BusinessUnit/Address. Quando utilizzato in una regola ripetuta, questo metodo restituirà in sequenza ogni istanza di Field elaborata. In caso contrario, restituisce la prima istanza di un Field ripetuto quando viene fatto riferimento a tale Field.
Field[] GetFields(string fieldName);Restituisce un elenco di Field che hanno il nome specificato. Questo metodo può essere utilizzato per ottenere tutte le istanze di un Field ripetuto, incluse tutte le celle in una colonna di tabella. Questo metodo semplifica l’accesso ai Field ripetuti quando si utilizzano i loop. Importante! Passare direttamente a questo metodo il nome del Field come stringa: una variabile con lo stesso valore stringa non funzionerà. Il preprocessore che analizza il codice dello script prima dell’esecuzione sostituirà il nome del Field con il suo identificatore, ma non sarà in grado di elaborare una variabile.
Record GetCatalogRecord(string catalogId, string externalId);Ottiene un record da un catalogo (database esterno). Utilizzare questo metodo per ottenere informazioni da un catalogo e confrontare i valori dei Field nel documento con i valori dei Field nel catalogo. Il nome del catalogo (catalogId) e l’identificatore del record di catalogo (externalId) vengono passati come argomenti. Questo metodo può essere utilizzato solo se nel catalogo è stato configurato l’identificatore appropriato (ad es. l’identificatore del Fornitore).
SkillParameter SkillParameter(string ParameterName);Ottiene un valore dal parametro della Skill. Questo metodo può essere utilizzato solo se il Document skill ha almeno un parametro.