SplitPdfByBarcode

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > JamioPlug > JamioPlug Document Automation >

SplitPdfByBarcode

Suddivide un file PDF in n file PDF distinti utilizzando come elemento di interruzione il codice barcode presente in una pagina.

 

Metodo

PlugDocumentAutomation /SplitPdfByBarcode

 

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

pdfResource

Collegamento al file in formato PDF deve essere suddiviso.

Può essere un collegamento ad un Attachment, ad un FileComponent, ad un allegato di processo, ad una risorsa Document o ad un'altra risorsa contenente attachments.

Se la il collegamento è ad una risorsa di tipo Document e contiene più componenti file viene utilizzato:

il componente principale se è di tipo File e contiene un PDF;

in assenza di componente principale, deve esserci un solo componente di tipo File che contiene un PDF.

Se il collegamento è ad una risorsa che contiene una lista di attachments, deve esserci un solo file è di tipo PDF.

Reference

 

barcodeType

Tipo di barcode da riconoscere.

BarcodeType

 

regularExpression

Esprime una espressione regolare che identifica il testo da trovare nel codice barcode per considerare il barcode valido.

String

Y

Output

Nome

Descrizione

Tipo

Opzionale

returnValue

Lista di dati strutturati composti dai seguenti campi:

ExtractedDocument: collegamento allegato di processo che rappresenta il file pdf estratto. Il nome del file è pari al nome del file originael con suffisso il numero di sequenza dell'estrazione, a partire dal numero 1, posto tra parentesi quadre;

Codes: di tipo lista di stringhe rappresenta la lista dei codici dei barcode estratti. I codici estratti possono essere più di uno poichè una pagina può contenere più barcode che rispettano la tipologia specificata e l'espressione regolare;

StartPage: numero della pagina del file PDF iniziale in cui è stato identificato il barcode che ne ha determinato lo split;

EndPage: numero della pagina del file PDF iniziale, a cui corrisponde la fine del file PDF estratto.

List of Dataset

 

 

Commenti

Nella fase di split è sufficiente che in una pagina sia identificato un barcode valido, affinche quella pagina possa essere considerata l'inizio di un nuovo file PDF. Per essere valido il barcode deve rispettare la tipologia di barcode e validare l'espressione regolare se presente. Se il primo barcode riconosciuto è collocato all'ennesima pagina del documento, il primo dato strutturato della lista riporterà il file pdf dalla prima pagina alla pagina n-1.

Se vi sono più barcode dello stesso tipo, il servizio integrato restitusce tutti i barcode che verificano l'espressione regolare.

Se non sono presenti barcode sul file PDF, il metodo restituisce una lista composta da un solo dato strutturato in cui:

oExtractedDocument: è uguale al file pdf fornito in input;

oCodes: è uguale a lista vuota;

oStartPage: è uguale ad 1;

oEndPage: è uguale all'ultima pagina del documento.

Alcuni file pdf forniti in input per lo split, se ottenuti dalla conversione di immagini in formato PDF, potrebbero riportare dei barcode che non vengono correttamente riconosciuti. Questo può accadere poiché il barcode viene suddiviso su più sezioni del file pdf ottenuto con la conversione.