PrexView Shift

Shift is a binary application that can be used to look at folder content in order to read and convert any file.

This application is also useful for processing hundreds or thousands of files without needing to supervise.


Download binary

Mac
macOS 10.12.3 x64
Windows
Windows 64bit
Linux
Ubuntu 16.04.2 x64
Debian 8.7 x64
CentOS 7.3.1611 x64
Fedora 25 x64


Usage

1
2
3
4
5
6
7
8
9
10
11
12
13
14
Usage: pxv <watch_folder> <output_folder> [processed_files_folder] [options]
Options:
-h, --help output usage information
-V, --version output the version number
-t, --token PrexView private token
-f, --format Type of files to watch xml or json
-f, --force-login Clean login cache and force login once again
-s, --standard-output Standard output can be plain, console or silent (default plain)
--design The design name to use
--design-backup A backup design to use if the primary design is not available
--output File output it can be html, pdf, png or jpg
--note Additional note

Example

Generate PDF files from XML files, so we are going to read files inside tmp/in and the result will be saved in tmp/out, any proccessed XML file will be moved to tmp/done

Generate PDF files from XML files We will read files in tmp/in and the result will be saved in tmp/out, and any processed XML file will be moved to tmp/done

1
2
3
4
5
6
7
8
9
# Mac or Linux
./pxv tmp/in tmp/out tmp/done \
--design="invoice" \
--output="pdf"
# Windows
.\pxv.exe tmp\in tmp\out tmp\done `
--design="invoice" `
--output="pdf"

Options

 
--format
Type: string Required: Yes

Data to use for the document creation, must be xml or json.

 
--design
Type: string Required: Yes

Design’s name to use.

You can use json sintax here to access data and have dynamic design names

Example
format JSON XML
1
2
3
4
5
{
"Data": {
"customer": "123"
}
}
Design name can use any data attribute or text node
1
invoice-customer-{{Data.customer}}
We will translate that to the following
1
invoice-customer-123
1
<Data customer="123"></Data>
Design name can use any data attribute or text node
1
invoice-customer-{{Data._customer}}
We will translate that to the following
1
invoice-customer-123
And finally the service will try to find the design invoice-customer-123 in order to transform the data and generate the document.
 
--output
Type: string Required: Yes

Document response type from the service, it can be html, pdf, png or jpg.

 
--design-backup
Type: string

Design’s name to use to be used if the option design is not available in the service.

 
--note
Type: string

Custom note that can be used to add any information, it’s limit up to 500 chars. This is useful if you want to add metadata such as document, transaction or customer ID.

You can use json syntax to access data and get dynamic design names.

Example
format JSON XML
1
2
3
4
5
{
"Data": {
"customer": "123"
}
}
Notes can use any data attribute or text
1
2
Document: Invoice
Customer: {{Data.customer}}
We will translate that to the following
1
2
Document: Invoice
Customer: 123
1
<Data customer="123"></Data>
Notes can use any data attribute or text
1
2
Document: Invoice
Customer: {{Data._customer}}
We will translate that to the following
1
2
Document: Invoice
Customer: 123