Developer Guide (API Reference) > ProxyWebService > Parameters |
ProxyWebService supports following list of REST API parameters:
proxyserver |
Prizm Proxy Server service REST API hostname:port. Can be used when Prizm Proxy Server REST API listens on other than default hostnameme:port. Example: Default = http://localhost:18680/ Values = URI where REST API listens |
||||||||||||
source | Source file path. | ||||||||||||
target | Target directory or target file path. If target is empty, the result is saved to the source directory. | ||||||||||||
thumbnail | Specifies thumbnail image width and height (e.g., 150x200). Only used for creating thumbnails of document pages in PNG format. | ||||||||||||
log |
Log file path. If not specified, all logging goes to a terminal.
|
||||||||||||
pages |
Indicates the range of pages to be printed. Ranges are separated by semicolons. Examples:
|
||||||||||||
openpass |
Password that allows the user to open the PDF file. Enclose the value in double-quotes if using spaces. Examples:
|
||||||||||||
srcencoding |
Specifies the text import filter parameters for text files (used only for .txt and .text files) as follows: character-set,paragraph-break,font,lang-culture-name Where:
Example: Let’s have a plain text document in Korean language written in Notepad on Windows. To convert this text into SWF, srcencoding parameter should be used on REST API call as follows:
Where: EUC_KR is the character set encoding CRLF is the paragraph break (Windows default) Times New Roman is the default font used ko-KR is the language culture name
REST API Call Examples: java -jar c:\prizm\convert2swfclient.jar source=c:\temp\korean.txt target=c:\temp\korean.swf srcencoding="EUC_KR,CRLF,Times New Roman,ko-KR" |
||||||||||||
totalpages | Returns the number of pages in the document. Returns an accurate total number of pages, but requires more processing time. | ||||||||||||
fastpgcnt | Returns the number of the pages in document based on properties (faster, but may not be accurate; use totalpages for actual page count). | ||||||||||||
enterprise |
Specifies the mode for converting vector documents to SWF.
Default = 0 Values = 0, 1, 2, or 3 |
||||||||||||
convtimeout |
Maximum time to wait for the conversion to be done (in seconds), used for large files. Use 0 to wait infinitely. Default = 660 Values = 0, 1, … |
||||||||||||
additional_format |
This parameter can be used to generate output pages in the specified format for vector documents in addition to SVG pages. Default = none
|
optimize |
Specifies the optimization level (0, 1, 2). Each optimization level uses a different rendering algorithm for SWF and adds more compression.
Default = 1 Values = 0, 1, 2 |
||||||||
embedfonts |
Embed fonts in SWF for a better search in SWF. Default = 1 (means fonts are embedded) Values = 0 or 1 |
||||||||
ignoreswferrors |
SWF conversion may at times result in errors. This flag forces SWF conversions even there have been some errors reported. Default = 1 (means ignore swf errors) Values = 0 or 1 |
||||||||
pagesize |
Used when converting tiff image. Default = a4 Values = a4, letter, original
|
||||||||
modulesdir | Directory to be used for modules and inter-process communication. By default this directory exists in the installation directory. | ||||||||
pagetype |
Used when converting multi-page tiff images. Default = original Values = a4, letter, original
|
||||||||
dpi | For specifying depth per index ratio of output SWF and image files. |
||||||||
pdfdensity |
Defines the Resolution (Dots per Inch or DPI) of the output raster image when converting PDF files to a raster image, such as TIFF, PNG or JPEG. Converting a standard Letter sized PDF (8.5x11 inches) to raster image with a PDFDensity value of 300, will result in a raster image with dimensions of 2550x3300 pixels. The higher the PDF density the more detail will be visible in the raster output. As the PDFDensity value increased so does the size of the output raster file. Default = 150 (dots per inch) Values = 11 – 4799 (dots per inch) |
||||||||
fidelity |
This parameter has been deprecated and will be removed from the API in a future release. The factor which will make .docx, .xlsx, and .pptx documents appear exactly the same as the original; setting fidelity as 'high' means more time is spent for conversion. Setting as 'low' means no pre-processing. Default = high Values = low, high |
||||||||
xlsfidelity |
Enables the XLS pre-processing of one page per sheet. Setting 'high' means more pre-processing. Setting as 'low' mean no pre-processing. Default = low Values = low, high |
||||||||
monochrome |
Creates grayscale TIFF images when monochrome=1. Default = 0 (means TIFF images have colors) Values = 0, 1 |
linktownd |
Use 1 to open the hyperlink in the same window of the browser where the Flash viewer is located. Use 0 to open the hyperlink in the new window. Default = 0 Values = 0 or 1 |
linktarget | Sets the target window name of a hyperlink. |
linkcolor |
Sets the color of a hyperlink button. Format = RRGGBBTT where:
|
linkdisable |
Use 1 to disable hyperlinks in SWF. Use 0 to enable links in SWF. Default = 0 (means document links are enabled in Flash viewer) Values = 0 or 1 |
flashver |
Sets the flash version of the converted SWF (Viewer supports only 9+). Default = 10 Values = 9, 10 |
wtmtext |
Watermark text. Adds watermark on each page.
|
||
wtmfont |
Watermark font. Default = Helvetica Values = font name (or font alias) installed on the server |
||
wtmsize |
Watermark size in points. Default = 130 Value = 1, 2, … |
||
wtmalpha |
Watermark opacity. The higher the number is - more visible is the watermark text. The lower the number is - more transparent is the watermark text. Default = 10 Values = 1 - 100 |
getattachments |
Creates attachment list for E-mail MSG and EML file format when getattachments=1. Note: the attachment file name support is limited to US-ASCII characters. Default = 0 (means no list is created) Values = 0, 1 |
extractattachments |
Extracts attachments from E-mail MSG and EML file format when extractattachments=1. Note: the attachment file name support is limited to US-ASCII characters. Default = 0 (means no extraction is done) Values = 0, 1 |
The CSV File import is controlled by following optional parameters:
If any of the the parameters below are not specified, the default value is used. |
csvFirstLine |
Number of the first line to convert, the first line in the file has the number 1. Default = 1 |
csvFieldSeparator |
Field separator. Default = , |
csvTextDelimiter |
The text delimiter. Default = " |
generatexml |
Using this parameter on a REST API call means, the text is extracted from the source file into the data structure. Refer to the gettextdata parameter description to see how to retrieve the extracted text data. The text extraction feature is supported for the following file formats: Office documents (Word, Excel and PowerPoint), TXT files, and PDF files. To get this feature working, the enterprise=3 parameter is also required.
Example: Create text extraction data from c:\temp\Sample.doc java -jar c:\prizm\convert2swfclient.jar source=c:\temp\Sample.doc target=c:\temp\Sample.svg enterprise=3 generatexml=1 Default = 0 (means no text data is extracted) Values = 0, 1 |
||
gettextdata |
Use this parameter on REST API call to retrieve the text extraction data created by the previous call of generatexml for the respective source document. To get this feature working, also the pages=M-N parameter is required. The values M,N limits the response as follows:
Note M should be less or equal to N and the page counter starts from 1. The call may return empty data for the given page if the data is not available for the respective page. Returning empty data for respective page could also be caused by the fact that the enterprise=3 conversion is still in progress (in the other conversion thread) and the given page data was not extracted yet. The response of this call depends on the target parameter:
Example: Save text extraction data beginning from page 1 until page 3 into the c:\temp\Sample.data file Default = 0 (means no text extraction are retrieved) Values = 0, 1 |
solution | Solution name. |
licensekey | Application license key. |
To convert sample.doc to sample.swf:
http://localhost:18680/convert2SWF?source=c:\temp\sample.doc&target=c:\temp\sample.swf
To convert page 1 only of sample.doc to sample.swf:
http://localhost:18680/convert2SWF?source=c:\temp\sample.doc&pages=1
To convert pages 1,5,7 only of sample.doc to sample.swf:
http://localhost:18680/convert2SWF?source=c:\temp\sample.doc&target= c:\temp\sample.swf&pages=1,5,7
To get total pages in sample.doc:
http://localhost:18680/convert2SWF?source=c:\temp\sample.doc&totalpages
To get fast page count in sample.doc:
http://localhost:18680/convert2SWF?source=c:\temp\sample.doc&fastpgcnt
fastpgcnt – gets total pages in the document quickly but might not be as accurate as totalpages
To convert sample.doc to sample.swf with http_port set to 1111 and SSL enabled:
https://localhost:1111/convert2SWF?source=c:\temp\sample.doc&pages=1
Watermark feature requires full license key. |
To convert sample.doc to sample.swf and add watermark “Confidential”:
To create a thumbnail of page 1 of sample.doc:
http://localhost:18680/convert2SWF?source=c:\temp\sample.doc&thumbnail=100x100&pages=1
To create a thumbnail of all pages of sample.doc:
http://localhost:18680/convert2SWF?source=c:\temp\sample.doc&thumbnail=100x150
Watermark feature requires full license key. |
To create a thumbnail of page 6 of sample.doc, specify target location, and add watermark “Approved” on each thumbnail:
To convert sample.doc to independent SWF pages and place files in a specific location:
http://localhost:18680/convert2SWF?source=c:\temp\sample.doc&target=c:\temp\&enterprise=1
To convert sample.doc to independent SWF pages and place files in a source location:
http://localhost:18680/convert2SWF?source=c:\temp\sample.doc&enterprise=1