Vai al contenuto principale

​
Utilizzo dei Registration Parameter

I parametri di registrazione della Transaction e dei file sono parametri costituiti da coppie chiave-valore di tipo string progettati per fornire informazioni aggiuntive sull’utente (ad esempio, nome del cliente, tipo di documento e informazioni sulla fonte del file). Vengono passati per l’elaborazione insieme alla Transaction o ai documenti della Transaction. Questi parametri sono disponibili per tutti i worker e possono essere utilizzati in vari scenari di produzione:
  • Un programma che utilizza ABBYY Vantage contrassegna ogni transaction utilizzando un attributo del cliente finale ai fini della compilazione di report e della creazione di procedure di elaborazione personalizzate (ad es. filtrando i cataloghi di dati delle controparti in base al cliente).
  • Un client di Scanning Station (o un’altra origine per le transaction) può passare i Parameter di registrazione di un batch di documenti (ad esempio un ID di correlazione esterno).
I Parameter di registrazione possono essere impostati utilizzando la Vantage API:
  1. Quando si crea una transaction vuota o si inizializza una transaction utilizzando il metodo launch. Per farlo, inviare una richiesta POST alla risorsa transactions come nell’esempio seguente:
o Nel corpo della richiesta, specificare i parametri di registrazione ed eseguire il comando seguente:
  1. Per caricare file in una transaction o in un documento, inviare una richiesta POST alla risorsa transactions/<transaction-id>/files come nell’esempio seguente:
Nel corpo della richiesta, specificare i parametri di registrazione ed eseguire il comando seguente:
Importante! È possibile definire al massimo 10 Parameter di tipo chiave-valore, in cui il Parameter della chiave può contenere fino a 128 caratteri e il Parameter del valore fino a 256 caratteri. I valori di questi Parameter non possono essere modificati una volta impostati.
I valori dei parametri di registrazione possono essere letti:
  • negli script delle attività personalizzate,
  • negli script di esportazione esterna dell’attività Output,
  • nelle regole aziendali.
È possibile ottenere i valori dei parametri di registrazione utilizzando la Vantage API come segue:
  1. Chiamando il metodo registrationParameters per la risorsa transactions/<transaction-id>/registrationParameters:
La risposta sarà simile alla seguente: 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. Utilizzando una chiamata al metodo download per la risorsa transactions/<transaction-id>/files/<file-id>/download per ottenere i valori in formato JSON insieme al file caricato:

​
Utilizzo degli Skill Parameters

Oltre ai Parameter di registrazione, è possibile passare gli Skill Parameters quando si creano o si avviano le transaction. Gli Skill Parameters sono coppie chiave-valore di tipo string che definiscono come una Skill elabora la transaction. Gli Skill Parameters possono essere impostati quando si crea una transaction o quando si utilizza il metodo launch:
Importante! È possibile avere un massimo di 10 skill Parameter per transazione.
È possibile recuperare i valori degli skill Parameter tramite la Vantage API chiamando il metodo skillParameters: La risposta sarà simile alla seguente: 
[
  {
    "key": "parameterName",
    "value": "parameterValue",
    "type": "string"
  }
]