<< Fare clic per visualizzazione il sommario >> Percorso: API di piattaforma > Servizi Core > Jamio Sending > StartSimpleSending |
Avvia il tracciamento, tramite una risorsa Dati, di un processo di business di invio di un'informazione da Jamio openwork a uno o più corrispondenti. Il metodo crea tutti i percorsi di spedizione (SendingPath) richiesti a partire dagli indirizzi specificati.
Metodo
JamioSending/StartSending
Input |
|||
Nome |
Descrizione |
Tipo |
Opzionale |
serverAddress |
Indirizzo del server per domini esterni (o "" per il dominio corrente). |
String |
Y |
token |
Il token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto). |
String |
Y |
resource |
Riferimento della risorsa che deve tracciare la spedizione che si sta avviando. |
Reference |
|
addresses |
Lista dei riferimenti dei corrispondenti e degli indirizzi a cui inviare un'informazione.La lista deve essere popolata con almeno un elemento utile al metodo a reperire le informazioni relative al corrispondente e l'indirizzo della spedizione. Opzionalmente il collegamento della lista può essere di tipo Collegamento esteso e contenere nella sua definizione i campi che rappresentano il corrispondente e l'indirizzo. Per ulteriori dettagli consultare l'argomento Logica risoluzione Addresses. |
List of reference or List of extended reference |
|
correspondentField |
Nome del campo del collegamento esteso, di addresses, da utilizzare come corrispondente; se vuoto sono utilizzate le proprietà del collegamento (Name,Type e URL) del collegamento esteso. |
String |
Y |
addressField |
Nome del campo del collegamento esteso, di addresses, da utilizzare come indirizzo; se vuoto sono utilizzate le proprietà del collegamento (Name,Type e URL) del collegamento esteso. |
String |
Y |
transport |
Tipo di trasporto. |
|
|
carrier |
Riferimento del vettore per la spedizione. In assenza di una Risorsa Jamio openwork che individua il Carrier, è possibile specificare un collegamento con valorizzata solo la proprietà Name. |
Reference |
|
leadTime |
Tempo massimo per il completamento di ogni percorso di spedizione, trascorso il quale, in caso di mancato completamento, viene generato un evento di timeout percorso spedizione. |
Y |
|
targetSendingStatus |
Stato per cui ogni percorso di spedizione (SendingPath) può ritenersi completato; deve essere uno stato uguale o superiore a sent. |
|
Descrizione
Il metodo è utile ad ad avviare la spedizione di un'informazione da Jamio ad uno o più corrispondenti in uno scenario semplificato rispetto a quello previsto dal metodo StartSending. Il metodo prevede in input:
•il riferimento della risorsa Dati che deve tracciare la spedizione che si sta avviando;
•la lista dei corrispondenti e degli indirizzi della spedizione specificati come lista di collegamenti o collegamenti estesi. Per ulteriori dettagli consultare l'argomento Logica risoluzione Addresses;
•il tipo di trasporto;
•il vettore della spedizione;
•il tempo massimo per il completamento di ogni percorso di spedizione;
•lo stato per cui ogni percorso di spedizione può ritenersi completato
Il metodo imposta sulla imposta sulla risorsa Dati che traccia la spedizione:
•lo stato della spedizione (proprietà SendingStatus) da none a pending, ad indicare che la trasmissione è stata avviata ed è in attesa di essere gestita;
•la percentuale di completamento della spedizione (proprietàSendingProgress) pari a zero;
•la direzione della spedizione (proprietà SendingDirection) pari a 2, ovvero spedizione in uscita.
Il metodo crea:
•un corrispondente (con relative informazioni di CorrespondentInfo) per ogni elemento estratto dalla lista addresses secondo una logica di risoluzione. Lo stato dei corrispondenti (SendingStatus) è impostato a pending. Per ogni corrispondente inserisce nella lista dei percorsi di spedizione un percorso di spedizione (SendingPath) con obiettivo specificato nel parametro targetSendingStatus. Eventuali corrispondenti duplicati (ovvero collegamenti con proprietà Name e URL uguali) saranno riportati in lista una sola volta. Se nella lista dei corrispondenti sono specificati collegamenti che possiedono la stessa URL ma con proprietà Name distinte, il metodo genera un'errore.
L'esecuzione del metodo avvia una spedizione pertanto genera:
•un evento su spedizione con proprietà action uguale a StartSend;
•un evento su percorso di spedizione per ogni percorso creato.
Autorizzazioni
Per eseguire il metodo è necessario possedere il permesso di modifica sulla risorsa Dati che traccia la spedizione.
Stato della risorsa
Il metodo può essere eseguito se la proprietà SendingStatus della risorsa Dati che traccia la spedizione è uguale a None, diversamente il metodo restituisce un errore.