Konverze souboru do PDF či PDF/A

Webová služba ConvertFileEx umožňuje na serveru konvertovat soubor do formátu PDF, či PDF/A podle definovaných požadavků v konfigurační struktuře požadavku. Je možné nastavit úroveň souladu se specifikací PDF/A, opatření dokumentu elektronickou pečetí, kvalifikovaným časovým razítkem, vodotiskem a další nastavení.

Pro provedení úspěšné konverze na serveru je nutné mít aplikaci, která umí přečíst formát konvertovaného souboru – například pro dokumenty formátu *.docx aplikace Microsoft Word nebo Open Office, popřípadě se musí jednat o nativně podporovaný formát. Více informací o požadavcích na konverzi a možnosti nastavení pro konverzní služby najdete v kapitole Konverzní formáty a jejich konfigurace.

Výkonnost OCR je závislá na několika faktorech, včetně použitých konverzních parametrů a hlavně hardware prostředků.

Popis služby ConvertFileEx včetně WSDL schématu a příklad požadavku a odpovědi pro SOAP 1.1 a SOAP 1.2 je k dispozici na http://localhost/ltd/ltd.asmx?op=ConvertFileEx.

Parametr "localhost" je název používaný pro lokální počítač; namísto něj zapište jméno/IP adresu LTD serveru (dle nastavení v IIS).

Požadavek

POST /ltd/ltd.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://software602.com/longtermdocs/ConvertFileEx"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ConvertFileEx xmlns="http://software602.com/longtermdocs/">
      <Input>base64Binary</Input>
      <FileName>string</FileName>
      <Options>
        <RemoveEmptyPages>boolean</RemoveEmptyPages>
        <ReportLanguage>string</ReportLanguage>
        <OCRLanguage>string</OCRLanguage>
        <OCRRecognitionDpi>int</OCRRecognitionDpi>
        <ForceShell>string</ForceShell>
        <PdfFormat>PDF or PDF_A_1b or PDF_A_1a or PDF_A_2b or PDF_A_2a or PDF_A_2u or PDF_A_3b or PDF_A_3a or PDF_A_3u or PDF_X_1 or PDF_X_3 or PDF_X_4 or PDF_X_5</PdfFormat>
        <ForcePDFVersion>string</ForcePDFVersion>
        <BarcodeInfo>
          <PosX>double</PosX>
          <PosY>double</PosY>
          <Width>double</Width>
          <Height>double</Height>
          <Type>Barcode_1D_UPCVersionA or Barcode_1D_UPCVersionE or Barcode_1D_UPCSupplemental2Digit or Barcode_1D_UPCSupplemental5Digit or Barcode_1D_EAN13 or Barcode_1D_EAN8 or Barcode_1D_Interleaved2of5 or Barcode_1D_Standard2of5 or Barcode_1D_Industrial2of5 or Barcode_1D_Code39 or Barcode_1D_Code39Extended or Barcode_1D_Codabar or Barcode_1D_PostNet or Barcode_1D_Bookland or Barcode_1D_ISBN or Barcode_1D_JAN13 or Barcode_1D_MSIMod10 or Barcode_1D_MSI2Mod10 or Barcode_1D_MSIMod11 or Barcode_1D_MSIMod11Mod10 or Barcode_1D_ModifiedPlessey or Barcode_1D_Code11 or Barcode_1D_USD8 or Barcode_1D_UCC12 or Barcode_1D_UCC13 or Barcode_1D_LOGMARS or Barcode_1D_Code128 or Barcode_1D_Code128A or Barcode_1D_Code128B or Barcode_1D_Code128C or Barcode_1D_ITF14 or Barcode_1D_Code93 or Barcode_1D_TelePen or Barcode_PDF417 or Barcode_QR or Barcode_DataMatrix</Type>
          <Data>string</Data>
          <Description>string</Description>
          <Pages>string</Pages>
        </BarcodeInfo>
        <ZFO>
          <AttSettings>
            <ConversionHandling>IGNORE_ATTACHMENTS or ATTACH_WITHOUT_CONVERSION or CONVERT_FAILURE_END or CONVERT_FAILURE_SKIP or CONVERT_FAILURE_ATTACH_ORIGINAL or CONVERT_ALWAYS_ATTACH_ORIGINAL or CONCAT_FAILURE_END or CONCAT_FAILURE_SKIP or CONCAT_FAILURE_ATTACH_ORIGINAL or CONCAT_FAILURE_ATTACH_ERR_PAGE_AND_ORIGINAL</ConversionHandling>
            <AllowedFiletypes>string</AllowedFiletypes>
          </AttSettings>
          <ConvertDZ>boolean</ConvertDZ>
        </ZFO>
        <EML>
          <AttSettings>
            <ConversionHandling>IGNORE_ATTACHMENTS or ATTACH_WITHOUT_CONVERSION or CONVERT_FAILURE_END or CONVERT_FAILURE_SKIP or CONVERT_FAILURE_ATTACH_ORIGINAL or CONVERT_ALWAYS_ATTACH_ORIGINAL or CONCAT_FAILURE_END or CONCAT_FAILURE_SKIP or CONCAT_FAILURE_ATTACH_ORIGINAL or CONCAT_FAILURE_ATTACH_ERR_PAGE_AND_ORIGINAL</ConversionHandling>
            <AllowedFiletypes>string</AllowedFiletypes>
          </AttSettings>
          <CertificatePath>string</CertificatePath>
          <Decrypt>boolean</Decrypt>
          <ExportSignature>boolean</ExportSignature>
          <HeaderLanguage>string</HeaderLanguage>
        </EML>
        <HTML>
          <Header>string</Header>
          <AvoidTextBreak>boolean</AvoidTextBreak>
          <AvoidImageBreak>boolean</AvoidImageBreak>
          <ArchiveHeaderLanguage>string</ArchiveHeaderLanguage>
          <HeaderHeight>int</HeaderHeight>
          <Footer>string</Footer>
          <FooterHeight>int</FooterHeight>
          <PageEncoding>string</PageEncoding>
          <AutoDetectEncoding>boolean</AutoDetectEncoding>
          <BaseURL>string</BaseURL>
          <DownloadReferencedFiles>boolean</DownloadReferencedFiles>
          <DoArchive>boolean</DoArchive>
          <FitWidth>boolean</FitWidth>
          <MarginAll>int</MarginAll>
          <FitHeight>boolean</FitHeight>
          <AutoSize>boolean</AutoSize>
          <CustomPageHeight>int</CustomPageHeight>
          <CustomPageWidth>int</CustomPageWidth>
        </HTML>
        <AllowAnnotations>boolean</AllowAnnotations>
        <Annotations>
          <PDF_Annotation>
            <Format>Points or Relative</Format>
            <Pos_X>int</Pos_X>
            <Pos_Y>int</Pos_Y>
            <Size_X>int</Size_X>
            <Size_Y>int</Size_Y>
            <Text>string</Text>
            <Page>int</Page>
          </PDF_Annotation>
          <PDF_Annotation>
            <Format>Points or Relative</Format>
            <Pos_X>int</Pos_X>
            <Pos_Y>int</Pos_Y>
            <Size_X>int</Size_X>
            <Size_Y>int</Size_Y>
            <Text>string</Text>
            <Page>int</Page>
          </PDF_Annotation>
        </Annotations>
        <Header>
          <Text>string</Text>
          <Height>int</Height>
          <HorizontalAlignment>Left or Center or Right</HorizontalAlignment>
          <VerticalAlignment>Top or Center or Bottom</VerticalAlignment>
          <Mode>FirstPage or AllPages or LastPage or UserDefined</Mode>
          <Pages>string</Pages>
          <FontName>string</FontName>
          <FontSize>int</FontSize>
          <Transparency>int</Transparency>
        </Header>
        <Footer>
          <Text>string</Text>
          <Height>int</Height>
          <HorizontalAlignment>Left or Center or Right</HorizontalAlignment>
          <VerticalAlignment>Top or Center or Bottom</VerticalAlignment>
          <Mode>FirstPage or AllPages or LastPage or UserDefined</Mode>
          <Pages>string</Pages>
          <FontName>string</FontName>
          <FontSize>int</FontSize>
          <Transparency>int</Transparency>
        </Footer>
        <PageFormat>Custom or A0 or A1 or A10 or A2 or A3 or A4 or A5 or A6 or A7 or A8 or A9 or ArchA or ArchB or ArchC or ArchD or ArchE or B0 or B1 or B2 or B3 or B4 or B5 or Flsa or HalfLetter or Ledger or Legal or Letter or Letter11x17 or Note</PageFormat>
        <PageOrientation>Portrait or Landscape</PageOrientation>
        <UsePageCompression>boolean</UsePageCompression>
        <Metadata>
          <Title>string</Title>
          <Subject>string</Subject>
          <Author>string</Author>
          <Keywords>string</Keywords>
       	<Custom>
            <Property xsi:nil="true" />
            <Property xsi:nil="true" />
       	</Custom>
        </Metadata>
        <UseImageCompression>boolean</UseImageCompression>
        <UsePDFCompression>boolean</UsePDFCompression>
        <DownsizeResolution>int</DownsizeResolution>
        <CompressMethod>int</CompressMethod>
        <JpegQuality>int</JpegQuality>
        <ConvertToCMYK>boolean</ConvertToCMYK>
        <RemoveDuplicateImages>boolean</RemoveDuplicateImages>
        <ConversionTimeout>int</ConversionTimeout>
        <AddWatermark>boolean</AddWatermark>
        <Watermark>
          <Mode>FirstPage or AllPages or LastPage or UserDefined</Mode>
          <Pages>string</Pages>
          <Angle>int</Angle>
          <Strength>int</Strength>
          <FontSize>int</FontSize>
          <Text>string</Text>
          <Font>string</Font>
          <Layer>Top or Bottom</Layer>
        </Watermark>
        <AddStamp>boolean</AddStamp>
        <Stamp>
          <Mode>FirstPage or AllPages or LastPage or UserDefined</Mode>
          <Path>string</Path>
          <Pages>string</Pages>
          <PosX>int</PosX>
          <PosY>int</PosY>
          <Width>float</Width>
          <Height>float</Height>
          <AutoPlacement>boolean</AutoPlacement>
          <AutoPosHorizontal>Left or Center or Right</AutoPosHorizontal>
          <AutoPosVertical>Top or Center or Bottom</AutoPosVertical>
          <Layer>Top or Bottom</Layer>
          <ResampleImage>boolean</ResampleImage>
        </Stamp>
        <AddAttachements>boolean</AddAttachements>
        <AttachementList>
          <string>string</string>
          <string>string</string>
        </AttachementList>
        <AppendFilesAtEnd>
          <string>string</string>
          <string>string</string>
        </AppendFilesAtEnd>
        <EnableMerge>boolean</EnableMerge>
        <Merge>
          <Mode>Overwrite or Begin or End</Mode>
          <SaveCopyOnMerge>boolean</SaveCopyOnMerge>
        </Merge>
        <AddSecurity>boolean</AddSecurity>
        <Security>
          <EncryptionAlgorithm>PdfEncryptionNone or PdfEncryption40BitRC4 or PdfEncryption128BitRC4 or PdfEncryption128BitAES or PdfEncryption256BitAES</EncryptionAlgorithm>
          <UserPasswordCrypted>string</UserPasswordCrypted>
          <UserPasswordPlaintext>string</UserPasswordPlaintext>
          <OwnerPasswordCrypted>string</OwnerPasswordCrypted>
          <OwnerPasswordPlaintext>string</OwnerPasswordPlaintext>
          <OpenPasswordPlaintext>string</OpenPasswordPlaintext>
          <Permissions>
            <CanPrint>boolean</CanPrint>
            <CanCopy>boolean</CanCopy>
            <CanModify>boolean</CanModify>
            <CanAddNotes>boolean</CanAddNotes>
            <CanFillFields>boolean</CanFillFields>
            <CanCopyAccess>boolean</CanCopyAccess>
            <CanAssemble>boolean</CanAssemble>
            <CanPrintFull>boolean</CanPrintFull>
          </Permissions>
        </Security>
        <AddSignature>boolean</AddSignature>
        <Signature>
          <CertificateID>string</CertificateID>
          <PrivateKeyPIN>string</PrivateKeyPIN>
          <AddTimeStamp>boolean</AddTimeStamp>
          <CreateBES>boolean</CreateBES>
          <CreateEmpty>boolean</CreateEmpty>
          <AutoPlacement>boolean</AutoPlacement>
          <AutoPlacementOptions>
            <SearchText>string</SearchText>
            <NumOfSigFields>int</NumOfSigFields>
            <HorizontalSpacing>int</HorizontalSpacing>
            <SizeInPDFPoints>boolean</SizeInPDFPoints>
          </AutoPlacementOptions>
          <ShowValidationStatus>boolean</ShowValidationStatus>
          <Page>int</Page>
          <Text>string</Text>
          <ImagePath>string</ImagePath>
          <PosX>int</PosX>
          <PosY>int</PosY>
          <Width>int</Width>
          <Height>int</Height>
          <LocationInfo>string</LocationInfo>
          <ContactInfo>string</ContactInfo>
          <Reason>string</Reason>
        </Signature>
        <AddTimeStamp>boolean</AddTimeStamp>
        <TimeStamp>
          <LocationInfo>string</LocationInfo>
          <ContactInfo>string</ContactInfo>
          <Reason>string</Reason>
        </TimeStamp>
        <PreserveExistingSignatures>boolean</PreserveExistingSignatures>
        <ConvertSignedPDF>boolean</ConvertSignedPDF>
        <StrictSignedPDFConversion>boolean</StrictSignedPDFConversion>
        <ReturnErrorIfNotModified>boolean</ReturnErrorIfNotModified>
        <XMLReportTemplate>string</XMLReportTemplate>
        <XMLReportSignaturesTemplate>string</XMLReportSignaturesTemplate>
        <AddXMLReportToXMP>boolean</AddXMLReportToXMP>
        <ReturnFullXMPReport>boolean</ReturnFullXMPReport>
        <MaxInputFileSize>int</MaxInputFileSize>
        <AllowedFileTypes>string</AllowedFileTypes>
        <EnableOCR>boolean</EnableOCR>
        <ForceOCR>boolean</ForceOCR>
        <AddSourceAsPDFA3AssociatedFile>boolean</AddSourceAsPDFA3AssociatedFile>
        <AddSourceIfNotChanged>boolean</AddSourceIfNotChanged>
        <ForcePDFAIfErrors>boolean</ForcePDFAIfErrors>
        <ForceImagePDFAIfErrors>boolean</ForceImagePDFAIfErrors>
        <ForceImagePDFAResolution>int</ForceImagePDFAResolution>
        <HttpHeaders>string</HttpHeaders>
      </Options>
      <CustomXMLData>string</CustomXMLData>
    </ConvertFileEx>
  </soap:Body>
</soap:Envelope>

<Input>
[povinný element]

Vstup Popis

Base64Binary

Libovolný dokument v kódování Base64Binary určený ke konverzi do formátu PDF, či PDF/A .

<FileName>
[povinný element]

Vstup Popis

String

Jméno vstupního souboru včetně přípony.

<Options> – Konfigurační struktura konverze
[povinný element]

<RemoveEmptyPages>
[nepovinný element]

Vstup Popis

boolean

Odstraní stránky bez jakéhokoliv textu nebo obrázku.

Výchozí hodnota: false.

<ReportLanguage>
[nepovinný element]

Vstup Popis

String

Slouží pro nastavení jazyka reportu o PDF/A konverzi. Hodnoty:

en – angličtina (výchozí) .

cz – čeština.

<OCRLanguage>
[nepovinný element]

Vstup Popis

string

V případě povoleného OCR definuje jazyk rozpoznávaného textu. Hodnoty:

cz – čeština (výchozí).

en – angličtina.

de – němčina.

sk – slovenština.

<OCRRecognitionDpi>
[nepovinný element]

Vstup Popis

int

Minimální rozlišení OCR skenované stránky. Při vyšším rozlišení zachovává kvalitu obrázku. Výchozí hodnota: 400.

<ForceShell>
[nepovinný element]

Vstup Popis

String

Přípony souborů, které jsou automaticky konvertovány pomocí Shell konverze. Přípony mohou být odděleny pomocí znaků: , ; . nebo mezerou.

<PdfFormat>
[nepovinný element]

Vstup Popis

enum

Definuje požadovanou úroveň souladu výstupního souboru s PDF či PDF/A normou. Hodnoty:

PDF – generované PDF je v souladu s definicí dle ISO 32000-1:2008 (PDF Reference 1.7),

PDF/A-1b – PDF dokument v úrovni souladu 1b dle ISO 19005-1:2005,

PDF/A-1a – PDF dokument v úrovni souladu 1a dle ISO 19005-1:2005,

PDF/A-2b – PDF dokument v úrovni souladu 2b dle ISO 19005-2:2011,

PDF/A-2a – PDF dokument v úrovni souladu 2a dle ISO 19005-2:2011,

PDF/A-2u – PDF dokument v úrovni souladu 2u dle ISO 19005-2:2011,

PDF/A-3b – PDF dokument v úrovni souladu 3b dle ISO 19005-3:2012,

PDF/A-3a – PDF dokument v úrovni souladu 3a dle ISO 19005-3:2012,

PDF/A-3u – PDF dokument v úrovni souladu 3u dle ISO 19005-3:2012,

PDF/X-1 - PDF dokument v úrovni souladu X-1 dle ISO 15930-4:2003,

PDF/X-3 - PDF dokument v úrovni souladu X-3 dle ISO 15930-6:2003,

PDF/X-4 - PDF dokument v úrovni souladu X-4 dle ISO 15930-7:2008,

PDF/X-5 - PDF dokument v úrovni souladu X-5 dle ISO 15930-8:2008.

<ForcePDFVersion>
[nepovinný element]

Vstup Popis

string

Nastaví výstupní verzi PDF souboru. Příklad hodnot: 1.4 nebo 1.7.

<BarCodeInfo>
[nepovinný element]

<PosX>
[nepovinný element]

Vstup Popis

double

Umístění čárového kódu v rámci PDF, X souřadnice od levého spodního rohu v 72DPI.

Výchozí hodnota: 0.

<PosY>
[nepovinný element]

Vstup Popis

double

Umístění čárového kódu v rámci PDF, Y souřadnice od levého spodního rohu v 72DPI.

Výchozí hodnota: 0.

<Width>
[nepovinný element]

Vstup Popis

double

Šířka čárového kódu v 72DPI. Výchozí hodnota: 100.

<Height>
[nepovinný element]

Vstup Popis

double

Výška čárového kódu v 72DPI. Výchozí hodnota: 100.

<Type>
[nepovinný element]

Vstup Popis

enum

Typ čárového kódu. Hodnoty:

Barcode_QR (výchozí)

Barcode_DataMatrix

Barcode_PDF417

Barcode_1D_EAN8

Barcode_1D_EAN13

Barcode_1D_Codabar

Barcode_1D_Code11

Barcode_1D_Code39

Barcode_1D_Code39Extended

Barcode_1D_Code93

Barcode_1D_Code128

Barcode_1D_Code128A

Barcode_1D_Code128B

Barcode_1D_Code128C

Barcode_1D_UPCVersionA

Barcode_1D_UPCVersionE

Barcode_1D_UPCSupplemental2Digit

Barcode_1D_UPCSupplemental5Digit

Barcode_1D_USD8

Barcode_1D_UCC12

Barcode_1D_UCC13

Barcode_1D_Bookland

Barcode_1D_Interleaved2of5

Barcode_1D_Industrial2of5

Barcode_1D_ISBN

Barcode_1D_ITF14

Barcode_1D_JAN13

Barcode_1D_LOGMARS

Barcode_1D_MSIMod10

Barcode_1D_MSI2Mod10

Barcode_1D_MSIMod11

Barcode_1D_MSIMod11Mod10

Barcode_1D_ModifiedPlessey

Barcode_1D_PostNet

Barcode_1D_Standard2of5

Barcode_1D_TelePen.

<Data>
[nepovinný element]

Vstup Popis

string

Obsah čárového kódu.

<Description>
[nepovinný element]

Vstup Popis

string

Text uvedený pod čárovým kódem.

<Pages>
[nepovinný element]

Vstup Popis

string

Čísla stran dokumentu, na které se má umístit čárový kód. Výchozí hodnota: 1.

</BarCodeInfo>

<ZFO>
[nepovinný element]

<AttSettings>
[nepovinný element]

<ConversionHandling>
[nepovinný element]

Vstup Popis

enum

Definuje správné zacházení s přílohou při konverzi nebo připojení. Hodnoty:

IGNORE_ATTACHMENTS – ignorovat (nevkládat) přílohy.

ATTACH_WITHOUT_CONVERSION – připojit přílohy bez konverze.

CONVERT_FAILURE_END – konvertovat přílohy, v případě chyby konverze ukončit požadavek.

CONVERT_FAILURE_SKIP – konvertovat přílohy, v případě chyby konverze přeskočit na další.

CONVERT_FAILURE_ATTACH_ORIGINAL – konvertovat přílohy, v případě chyby připojit originál (Výchozí hodnota).

CONVERT_ALWAYS_ATTACH_ORIGINAL – konvertovat přílohy a vždy připojit i originál.

CONCAT_FAILURE_END – stránky příloh připojit, přílohy, které se nepodaří převést, ukončit.

CONCAT_FAILURE_SKIP – stránky příloh připojit, přílohy, které se nepodaří převést, přeskočit.

CONCAT_FAILURE_ATTACH_ORIGINAL – stránky příloh připojit, přílohy, které se nepodaří převést, připojit v původním tvaru.

CONCAT_FAILURE_ATTACH_ERR_PAGE_AND_ORIGINAL – stránky příloh připojit, přílohy, které se nepodaří převést, připojit v původním tvaru a místo nich dát stránku s chybovou zprávou.

<AllowedFileTypes>
[nepovinný element]

Vstup Popis

String

Typy souborů pro konverzi, pro libovolný dokument nastavte * (hvězdička; výchozí hodnota). Jednotlivé formáty oddělte ; (středníkem).

</AttSettings>

<ConvertDZ>
[nepovinný element]

Vstup Popis

boolean

Nastaví, zda převést soubor .zfo, pokud je to datová zpráva. Výchozí hodnota: true

</ZFO>

<EML>
[nepovinný element]

<AttSettings>
[nepovinný element]

<ConversionHandling>
[nepovinný element]

Vstup Popis

enum

Definuje správné zacházení s přílohou při konverzi nebo připojení. Hodnoty:

IGNORE_ATTACHMENTS – ignorovat (nevkládat) přílohy.

ATTACH_WITHOUT_CONVERSION – připojit přílohy bez konverze.

CONVERT_FAILURE_END – konvertovat přílohy, v případě chyby konverze ukončit požadavek.

CONVERT_FAILURE_SKIP – konvertovat přílohy, v případě chyby konverze přeskočit na další.

CONVERT_FAILURE_ATTACH_ORIGINAL – konvertovat přílohy, v případě chyby připojit v původním tvaru (Výchozí hodnota).

CONVERT_ALWAYS_ATTACH_ORIGINAL – konvertovat přílohy a vždy připojit i v původním tvaru.

CONCAT_FAILURE_END – stránky příloh připojit, přílohy, které se nepodaří převést, ignorovat.

CONCAT_FAILURE_SKIP – stránky příloh připojit, přílohy, které se nepodaří převést, ignorovat.

CONCAT_FAILURE_ATTACH_ORIGINAL – stránky příloh připojit, přílohy, které se nepodaří převést, připojit v původním tvaru.

CONCAT_FAILURE_ATTACH_ERR_PAGE_AND_ORIGINAL – stránky příloh připojit, přílohy, které se nepodaří převést, připojit v původním tvaru a místo nich dát stránku s chybovou zprávou.

<AllowedFileTypes>
[nepovinný element]

Vstup Popis

String

Typy souborů pro konverzi, pro libovolný dokument nastavte * (hvězdička; výchozí hodnota).

Jednotlivé formáty jsou odděleny středníkem.

</AttSettings>

<CertificatePath>
[nepovinný element]

Vstup Popis

string

Cesta k certifikátu pro dešifrování šifrovaného emailu.

<Decrypt>
[nepovinný element]

Vstup Popis

boolean

Definuje, zda se má použít certifikát v případě šifrovaného emailu.

Výchozí hodnota: false.

<ExportSignature>
[nepovinný element]

Vstup Popis

boolean

Zapíše informace o podpisu z emailu do PDF Metadat. Výchozí hodnota: false.

<HeaderLanguage>
[nepovinný element]

Vstup Popis

string

Lokalizace hlavičky emailu. Výchozí hodnota: cz.

</EML>

<HTML>
[nepovinný element]

<Header>
[nepovinný element]

Vstup Popis

string

Hlavička každé konvertované stránky.

<AvoidTextBreak>
[nepovinný element]

Vstup Popis

boolean

Při převodu HTML zabrání rozdělení textu mezi stránkami ve vytvořeném PDF.

Výchozí hodnota: true.

<AvoidImageBreak>
[nepovinný element]

Vstup Popis

boolean

Při převodu HTML zabrání rozdělení obrazu mezi stránkami ve vytvořeném PDF.

Výchozí hodnota: false.

<ArchiveHeaderLanguage>
[nepovinný element]

Vstup Popis

string

V případě stahování zdrojových souborů stránky definuje lokalizaci hlavičky.

Výchozí hodnota: en.

<HeaderHeight>
[nepovinný element]

Vstup Popis

int

Velikost hlavičky konvertované stránky. Výchozí hodnota: 20.

<Footer>
[nepovinný element]

Vstup Popis

string

Zápatí každé konvertované stránky.

<FooterHeight>
[nepovinný element]

Vstup Popis

int

Velikost zápatí konvertované stránky. Výchozí hodnota: 20.

<PageEncoding>
[nepovinný element]

Vstup Popis

string

Kódování stahované stránky.

<AutoDetectEncoding>
[nepovinný element]

Vstup Popis

boolean

Automatická detekce kódování stahované stránky. Výchozí hodnota: true.

<BaseURL>
[nepovinný element]

Vstup Popis

string

Výchozí adresa pro konverzi souborů ležících mimo úrovně webu.

<DownloadReferencedFiles>
[nepovinný element]

Vstup Popis

boolean

Stahuje i specifické formáty souborů odkazovaných na stahované stránce (office, pdf apod.)

Výchozí hodnota: true.

<DoArchive>
[nepovinný element]

Vstup Popis

boolean

Stahuje i zdrojové soubory stahované stránky. Výchozí hodnota: false.

<FitWidth>
[nepovinný element]

Vstup Popis

boolean

V případě, že převedená webová stránka je širší než aktuální šířka PageFormat stránky, zmenší webovou stránku tak, aby se vešla.

Pokud jsou tato volba a AutoSize nastaveny na false, budou webové stránky ořezané na aktuální PageFormat výšce stránky.

Výchozí hodnota: true.

<MarginAll>
[nepovinný element]

Vstup Popis

int

Nastavení odsazení všech okrajů převedené webové stránky.

Lze použít pouze s vlastním PageFormat a CustomPageWidth/CustomPageHeight, nikoliv při AutoSize.

Výchozí hodnota: 20.

<FitHeight>
[nepovinný element]

Vstup Popis

boolean

V případě, že převedená webová stránka je delší než aktuální výška PageFormat stránky, zmenší webovou stránku tak, aby se vešla. Výchozí hodnota: false.

<AutoSize>
[nepovinný element]

Vstup Popis

boolean

Vytvoří vlastní PageFormat, aby se stránka vešla do šíře aktuálně převedené webové stránky. Tento parametr přepíše CustomPageWidth. Výchozí hodnota: false.

<CustomPageHeight>
[nepovinný element]

Vstup Popis

int

Nastaví výšku převedené PDF stránky. Hodnota musí být v 72DPI formátu. Výchozí hodnota: 0.

<CustomPageWidth>
[nepovinný element]

Vstup Popis

int

Nastaví šířku převedené PDF stránky. Hodnota musí být v 72DPI formátu. Výchozí hodnota: 0.

</HTML>

<AllowAnnotations>
[nepovinný element]

Vstup Popis

boolean

Nastavte na true, pokud chcete přidat anotace věty do PDF souboru. Použijte element Annotations pro další nastavení. Výchozí hodnota: false.

<Annotations>
[nepovinný element]

<PDF_Annotation>
[nepovinný element]

<Format>
[nepovinný element]

Vstup Popis

enum

Formát anotace v rámci PDF, může nabývat hodnot: Points (Pixely) nebo Relative (Procenta). Výchozí hodnota: Points.

<Pos_X>
[nepovinný element]

Vstup Popis

int

Umístění anotace v rámci PDF, X souřadnice od levého spodního rohu.

Výchozí hodnota: 0.

<Pos_Y>
[nepovinný element]

Vstup Popis

int

Umístění anotace v rámci PDF, Y souřadnice od levého spodního rohu.

Výchozí hodnota: 0.

<Size_X>
[nepovinný element]

Vstup Popis

int

Velikost anotace v rámci PDF, X souřadnice od levého spodního rohu.

Výchozí hodnota: 0.

<Size_Y>
[nepovinný element]

Vstup Popis

int

Velikost anotace v rámci PDF, Y souřadnice od levého spodního rohu.

Výchozí hodnota: 0.

<Text>
[nepovinný element]

Vstup Popis

string

Text anotace věty.

<Page>
[nepovinný element]

Vstup Popis

int

Číslo stránky, na kterou se má anotace přidat. Výchozí hodnota: 1

</PDF_Annotation>

</Annotations>

<Header>
[nepovinný element]

<Text>
[nepovinný element]

Vstup Popis

string

Text, který se má vložit do záhlaví.

Je možné použít proměnné znaky:

  • &p – pro číslo aktuální stránky,

  • &P – pro celkový počet stránek,

  • \n – pro odřádkování textu v záhlaví*.

* pro více řádků za sebou použijte mezeru mezi jednotlivými znaky.

<Height>
[nepovinný element]

Vstup Popis

int

Výška oblasti záhlaví. Výchozí hodnota: 20.

<HorizontalAlignment>
[nepovinný element]

Vstup Popis

HorizontalPosition

Definuje zarovnání oblasti záhlaví horizontálně. Hodnoty:

  • Left – vlevo.

  • Center – uprostřed (výchozí).

  • Right – vpravo.

<VerticalAlignment>
[nepovinný element]

Vstup Popis

VerticalPosition

Definuje zarovnání oblasti záhlaví vertikálně. Hodnoty:

  • Top – vrchní.

  • Center – uprostřed (výchozí).

  • Bottom – spodní.

<Mode>
[nepovinný element]

Vstup Popis

PlacementMode

Definuje umístění záhlaví ve stránkách. Hodnoty:

  • FirstPage – první stránka.

  • AllPages – všechny stránky (výchozí).

  • LastPage – poslední stránka.

  • UserDefined – uživatelem definované (v Pages).

<Pages>
[nepovinný element]

Vstup Popis

string

Definuje umístění záhlaví na stránku. Pokud je Mode nastaven na UserDefined, obsahuje čárkou oddělená čísla stránek, na které se má záhlaví vložit.

<FontName>
[nepovinný element]

Vstup Popis

string

Jméno fontu nebo cesta k souboru s fontem. Testováno s Arial, Courier, Helvetica, Times New Roman.

Výchozí hodnota: Helvetica

<FontSize>
[nepovinný element]

Vstup Popis

int

Velikost fontu. Výchozí hodnota: 12.

<Transparency>
[nepovinný element]

Vstup Popis

int

Průhlednost textu (v procentech). Hodnoty: 0 až 100.

Výchozí hodnota: 50.

</Header>

<Footer>
[nepovinný element]

<Text>
[nepovinný element]

Vstup Popis

string

Text, který se má vložit do zápatí.

Je možné použít proměnné &p pro číslo aktuální stránky a &P pro celkový počet stránek.

Pro odřádkování textu v zápatí lze použít znak \n.

<Height>
[nepovinný element]

Vstup Popis

int

Výška oblasti zápatí. Výchozí hodnota je 20.

<HorizontalAlignment>
[nepovinný element]

Vstup Popis

HorizontalPosition

Definuje zarovnání oblasti zápatí horizontálně. Hodnoty:

  • Left – vlevo.

  • Center – uprostřed (výchozí).

  • Right – vpravo.

<VerticalAlignment>
[nepovinný element]

Vstup Popis

VerticalPosition

Definuje zarovnání oblasti zápatí vertikálně. Hodnoty:

  • Top – vrchní.

  • Center – uprostřed (výchozí).

  • Bottom – spodní.

<Mode>
[nepovinný element]

Vstup Popis

PlacementMode

Definuje umístění zápatí. Hodnoty:

  • FirstPage – první stránka.

  • AllPages – všechny stránky (výchozí).

  • LastPage – poslední stránka.

  • UserDefined – uživatelem definované (v Pages).

<Pages>
[nepovinný element]

Vstup Popis

string

Definuje umístění zápatí na stránku. Pokud je Mode nastaven na UserDefined, obsahuje čárkou oddělená čísla stránek, na které se má zápatí vložit.

<FontName>
[nepovinný element]

Vstup Popis

string

Jméno fontu nebo cesta k souboru s fontem. Testováno s Arial, Courier, Helvetica, Times New Roman.

Výchozí hodnota: Helvetica.

<FontSize>
[nepovinný element]

Vstup Popis

int

Velikost fontu. Výchozí hodnota: 12.

<Transparency>
[nepovinný element]

Vstup Popis

int

Průhlednost textu (v procentech). Hodnoty: 0 až 100. Výchozí hodnota: 50.

</Footer>

<PageFormat>
[nepovinný element]

Vstup Popis

enum

Definuje velikost a formát stránky výstupního PDF souboru. Výchozí hodnota je A4. Hodnoty: Custom; A0; A1; A10; A2; A3; A4; A5; A6; A7; A8; A9; ArchA; ArchB; ArchC; ArchD; ArchE; B0; B1; B2; B3; B4; B5; Flsa; HalfLetter; Ledger; Legal; Letter; Letter11x17; Note.

Použitelné pouze pro soubory, které nemají formát stránky daný – např. TXT, XML nebo HTML.

Rozměry stránky pro jednotlivé typy velikosti papírů jsou uvedeny například zde:

http://en.wikipedia.org/wiki/Paper_size.

<PageOrientation>
[nepovinný element]

Vstup Popis

enum

Orientace stránky, může mít hodnoty:

  • Portrait – na výšku (výchozí).

  • Landscape – na šířku.

Použitelné pouze pro soubory, které nemají formát stránky daný – např. TXT, XML nebo HTML.

<UsePageCompression>
[nepovinný element]

Vstup Popis

boolean

Logická hodnota určuje, zda má být použita komprese. Výchozí hodnota: true.

<Metadata>

<Title>
[nepovinný element]

Vstup Popis

String

Nastavuje hodnotu metadat dokumentu – Název dokumentu.

<Subject>
[nepovinný element]

Vstup Popis

String

Nastavuje hodnotu metadat dokumentu – Předmět.

<Author>
[nepovinný element]

Vstup Popis

String

Nastavuje hodnotu metadat dokumentu – Autor dokumentu.

<Keywords>
[nepovinný element]

Vstup Popis

String

Nastavuje hodnotu metadat dokumentu – Klíčová slova.

<Custom>
[nepovinný element]

Vstup Popis

Array

Pole pro nastavení páru vlastních hodnot metadat dokumentu:

  • Name (Název).

  • Value (Hodnota).

Podporuje pouze základní alfanumerické znaky a-zA-Z0-9. Další znaky jsou bez záruky – property name se musí speciálně kódovat (není implementované).

</Metadata>

<UseImageCompression>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota nastavuje, zda je povolena komprese obrázků při konverzi.

Výchozí hodnota: false.

<UsePDFCompression>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota nastavuje, zda je povolena komprese PDF při konverzi.

Výchozí hodnota: false.

<DownsizeResolution>
[nepovinný element]

Vstup Popis

Int

Nastavuje rozlišení obrázků v DPI. Hodnota může být nastavena v rozsahu 10 až 600. Akceptován pouze pokud je nastavena hodnota UseImageCompression na true. Tento parametr není v tuto chvíli dostupný.

Výchozí hodnota: 0.

<CompressMethod>
[nepovinný element]

Vstup Popis

Int

Nastavuje metodu komprese obrázků. Je podporována pouze komprese JPEG obrázků. Možné hodnoty: 0 = ZIP, 1 = JPEG, 2 = JPEG2000.

Výchozí hodnota: 0.

<JpegQuality>
[nepovinný element]

Vstup Popis

Int

Nastavuje kvalitu konverze obrázků JPEG (v procentech).

Výchozí hodnota: 100.

<ConvertToCMYK>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota nastavuje konverzi z RGB do CMYK. Tento parametr není v tuto chvíli dostupný. Výchozí hodnota: false.

<RemoveDuplicateImages>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota nastavuje, zda mají být duplicitní obrázky z PDF dokumentu odstraněny. Tento parametr není v tuto chvíli dostupný. Výchozí hodnota: false.

<ConversionTimeout>
[nepovinný element]

Vstup Popis

Int

Timeout pro konverzi, celočíselná hodnota zadává čas v sekundách.

Výchozí hodnota: 300.

<AddWatermark>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota určuje, zda bude použit vodoznak. Výchozí hodnota: false.

<Watermark>

<Mode>
[nepovinný element]

Vstup Popis

enum

Určuje, na které stránce bude umístěn vodoznak. Hodnoty:

  • FirstPage – první stránka.

  • AllPages – všechny stránky (výchozí).

  • LastPage – poslední stránka.

  • UserDefined – uživatelem definované (v Pages).

<Pages>
[nepovinný element]

Vstup Popis

String

Čísla stran dokumentu, na kterých má být umístěn vodoznak. Oddělovač je , ; . nebo mezera.

<Angle>
[nepovinný element]

Vstup Popis

Int

Určuje úhel vodoznaku. Hodnoty:

  • 0 - vodorovně (výchozí).

  • 1 - šikmo dolů zleva doprava.

  • 2 - šikmo nahoru zleva doprava.

  • 3 - svisle shora dolů.

<Strength>
[nepovinný element]

Vstup Popis

Int

Určuje viditelnost (sílu) vodoznaku, pokud je umístěn před textem. Zadává se v procentech průhlednosti. Výchozí hodnota: 50.

<FontSize>
[nepovinný element]

Vstup Popis

Int

Určuje velikost fontu vodoznaku. Výchozí hodnota: 30.

<Text>
[nepovinný element]

Vstup Popis

String

Text vodoznaku.

<Font>
[nepovinný element]

Vstup Popis

String

Jméno fontu použitého pro vodoznak.

<Layer>
[nepovinný element]

Vstup Popis

enum

Určuje umístění vodoznaku vůči textu, hodnoty:

  • Top – před textem.

  • Bottom – za textem.

</Watermark>

<AddStamp>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota povoluje použití obrázku razítka.

<Stamp>

<Mode>
[nepovinný element]

Vstup Popis

enum

Určuje, na které stránce bude umístěn obrázek razítka. Hodnoty:

  • FirstPage – první stránka.

  • AllPages – všechny stránky (výchozí).

  • LastPage – poslední stránka.

  • UserDefined – uživatelem definované (v Pages).

<Path>
[nepovinný element]

Vstup Popis

String

Cesta k souboru s obrázkem razítka.

<Pages>
[nepovinný element]

Vstup Popis

String

Určuje stránku nebo stránky, na které bude umístěn obrázek razítka.

Tento parametr je nadřazený parametru <Mode>.

<PosX>
[nepovinný element]

Vstup Popis

Int

Parametr pozice obrázku razítka, X pozice od dolního levého rohu v rozlišení 300DPI.

Výchozí hodnota: 0.

<PosY>
[nepovinný element]

Vstup Popis

Int

Parametr pozice obrázku razítka, Y pozice od dolního levého rohu v rozlišení 300DPI.

Výchozí hodnota: 0.

<Width>
[nepovinný element]

Vstup Popis

float

Parametr pozice obrázku razítka – šířka, v rozlišení 72DPI.

Výchozí hodnota: 0.

<Height>
[nepovinný element]

Vstup Popis

float

Parametr pozice obrázku razítka – výška, v rozlišení 72DPI.

Výchozí hodnota: 0.

<AutoPlacement>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota určuje, zda bude obrázek razítka umístěn ručně nebo automaticky. Hodnoty:

  • False – ručně (výchozí).

  • True – automaticky.

<AutoPosHorizontal>
[nepovinný element]

Vstup Popis

enum

Parametr horizontální pozice obrázku razítka, hodnoty:

  • Left – vlevo.

  • Center – uprostřed (výchozí).

  • Right – vpravo.

<AutoPosVertical>
[nepovinný element]

Vstup Popis

enum

Parametr vertikální pozice obrázku razítka, hodnoty:

  • Top – nahoře.

  • Center – uprostřed (výchozí).

  • Bottom – dole.

<Layer>
[nepovinný element]

Vstup Popis

enum

Určuje umístění obrázku razítka vůči textu, hodnoty:

  • Top – před textem.

  • Bottom – za textem (výchozí).

<ResampleImage>
[nepovinný element]

Vstup Popis

boolean

Logická hodnota určující upravení vzoru obrázku na 72DPI. Výchozí hodnota: false.

</Stamp>

<AddAttachements>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota povoluje vložení přílohy do dokumentu. Výchozí hodnota: false.

<AttachementList>

<String>
[nepovinný element]

Vstup Popis

String

Pole obsahující cestu k souborům nebo Base64:<data souboru>, který má být součástí konvertovaného dokumentu jako příloha.

</AttachementList>

<AppendFilesAtEnd>

<String>
[nepovinný element]

Vstup Popis

Base64Binary

Pole obsahující Base64:<data souboru>, jejichž stránky se mají připojit na konec převedeného souboru.

</AppendFilesAtEnd>

<EnableMerge>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota povoluje spojování lokálních dokumentů.

Pro spojování PDF dokumentů z jiného umístění využijte metody Concat nebo parametru AppendFilesAtEnd. Pro spojování konvertovaných ZFO nebo EML souborů využijte parametru AttSettings.ConversionHandling.

Výchozí hodnota: false.

<Merge>
[nepovinný element]

<Mode>
[nepovinný element]

Vstup Popis

Enum

Určuje způsob slučování dokumentů. Možné hodnoty:

  • Overwrite – Přepíše původní soubor novým.

  • Begin – Připojí nový soubor na začátek původního.

  • End – Připojí nový soubor na konec původního.

<SaveCopyOnMerge>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota povoluje ukládání kopie původního souboru

</Merge>

<AddSecurity>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota povoluje šifrování. Výchozí hodnota: false.

<Security>
[nepovinný element]

<EncryptionAlgorithm>
[nepovinný element]

Vstup Popis

enum

Určuje, jaký způsob šifrování bude použit. Tento parametr je CaseSensitive. Hodnoty:

  • PdfEncryptionNone – žádné šifrování.

  • PdfEncryption40BitRC4 – šifrování pomocí RC4 40bit.

  • PdfEncryption128BitRC4 – šifrování pomocí RC4 128bit.

  • PdfEncryption128BitAES – šifrování pomocí AES 128bit (výchozí).

  • PdfEncryption256BitAES – šifrování pomocí AES 256bit.

<UserPasswordCrypted>
[nepovinný element]

Vstup Popis

String

Uživatelské heslo k dokumentu, uloženo jako kryptovaný text. Parametr pro heslo zadané jako normální text tento parametr přepíše a opačně.

<UserPasswordPlainText>
[nepovinný element]

Vstup Popis

String

Uživatelské heslo k dokumentu, uloženo jako normální text. Parametr pro heslo zadané jako normální text přepíše heslo zadané jako kryptovaný text a opačně.

<OwnerPasswordCrypted>
[nepovinný element]

Vstup Popis

String

Heslo vlastníka k dokumentu, uloženo jako kryptovaný text. Parametr pro heslo zadané jako normální text tento parametr přepíše a opačně.

<OwnerPasswordPlainText>
[nepovinný element]

Vstup Popis

String

Heslo vlastníka k dokumentu, uloženo jako normální text. Parametr pro heslo zadané jako normální text přepíše heslo zadané jako kryptovaný text a opačně.

<OpenPasswordPlainText>
[nepovinný element]

Vstup Popis

String

Uživatelské heslo pro otevření PDF dokumentu, uloženo jako prostý text.

Tento parametr se používá k otevření heslem chráněného PDF. Pokud si chcete zachovat zabezpečené PDF, využijte parametrů UserPassword nebo OwnerPassword.

<Permissions>
[nepovinný element]

<CanPrint>
[nepovinný element]

Vstup Popis

Boolean

Pokud je dokument šifrován, povoluje práva k dokumentu – tisk.

Výchozí hodnota: false.

<CanCopy>
[nepovinný element]

Vstup Popis

Boolean

Pokud je dokument šifrován, povoluje práva k dokumentu – kopírování.

Výchozí hodnota: false.

<CanModify>
[nepovinný element]

Vstup Popis

Boolean

Pokud je dokument šifrován, povoluje práva k dokumentu – úpravy.

Výchozí hodnota: false.

<CanAddNotes>
[nepovinný element]

Vstup Popis

Boolean

Pokud je dokument šifrován, povoluje práva k dokumentu – poznámky.

Výchozí hodnota: false.

<CanFillFields>
[nepovinný element]

Vstup Popis

Boolean

Pokud je dokument šifrován, povoluje práva k dokumentu – vyplňování polí.

Výchozí hodnota: false.

<CanCopyAccess>
[nepovinný element]

Vstup Popis

Boolean

Pokud je dokument šifrován, povoluje práva k dokumentu. Výchozí hodnota: false.

<CanAssembly>
[nepovinný element]

Vstup Popis

Boolean

Pokud je dokument šifrován, povoluje práva k dokumentu – přiřazení. Výchozí hodnota: false.

<CanPrintFull>
[nepovinný element]

Vstup Popis

Boolean

Pokud je dokument šifrován, povoluje práva k dokumentu – plný tisk. Výchozí hodnota: false

</Permissions>

</Security>

<AddSignature>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota určuje, zda má být dokument podepsán. Certifikát pečeti se specifikuje v elementu Signature. Výchozí hodnota: false.

<Signature>
[nepovinný element]

<CertificateID>
[nepovinný element]

Vstup Popis

String

Identifikátor pečetícího certifikátu. Nabývá jeden z formátů:

"urn:sha:" // Format urn:sha:<Base64_kodovany_sha1_hash >

"urn:hex:" // Format urn:hex:<hexadecimalne_kodovany_sha1_hash>

"PEMfile:" // Format PEMfile:<cesta_k_PEM_souboru_bez_hesla>

"Identity:" // Format Identity:<Base64_kodovany_cert>:<Base64_kodovany_key>

"X509:" // Format X509:<Base64_kodovany_cert>

"PKCS11:alias:" // Format PKCS11:alias:<alias_certifikatu> (přes NSS do PKCS11.dll)

"PK11:alias:" // Format PK11:alias:<alias_certifikatu> (napřímo do PKCS11 dll)

"HStore:" // Format HStore:<alias_certifikatu> (kvalifikovaný prostředek – HSM – služby Vzdáleného podepisování / pečetění).

V případě potřeby pečetění dokumentu certifikátem (klíčem) uloženým v lokálním Hardware Security Modulu (HSM), je třeba pro identifikaci a použití certifikátu uvést jeho alias (CKA_LABEL) do formátu PKCS11, resp. PK11.

Pro rychlejší identifikaci certifikátu je možné do CertificateID za PKCS11, resp. PK11 přidat specifikaci softkarty:

PKCS11:card:<nazev_sofktarty>;alias:<alias_certifikatu> nebo PK11:card:<nazev_sofktarty>;alias:<alias_certifikatu>.

Vyhledání certifikátu přes PK11 by mělo být rychlejší, protože se komunikuje napřímo s PKCS11 knihovnou HSM zařízení, a ne přes NSS (Network Security Services).

Před použitím je však nutné upravit cestu k PKCS#11 modulu, kterou zjistíte v dokumentaci příslušného zařízení. Cesty se upravují v konfiguračních souborech:

InstallDir\Engine\Misc\Configure_PKCS11.bat.

V konfiguračním souboru je přednastavena výchozí cesta ke knihovnám podporovaného HSM od Thales nShield. Po nastavení odpovídající cesty ke knihovnám vašeho zařízení spusťte dávkový soubor.

<PrivateKeyPIN>
[nepovinný element]

Vstup Popis

String

Heslo k privátnímu klíči specifikovaného certifikátu.

<AddTimeStamp>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota určuje, zda bude k pečeti připojeno časové razítko.

Výchozí hodnota: false.

<CreateBES>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota určuje, zda bude elektronická pečeť vytvořena ve formátu BES / EPES.

Výchozí hodnota: true.

<CreateEmpty>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota určuje, zda se má v dokumentu vytvořit prázdné podpisové pole.

<AutoPlacement>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota nastavuje, aby se podpisová pole umisťovala automaticky podle zadaného řetězce.

<AutoPlacementOptions>
[nepovinný element]

<SearchText>
[nepovinný element]

Vstup Popis

string

Hodnota definuje text umisťovacího řetězce, který se má hledat pro vytvoření podpisového pole.

<NumOfSigFields>
[nepovinný element]

Vstup Popis

int

Hodnota určuje počet podpisových polí, která se mají vytvořit. Výchozí hodnota: -1 (počet polí odpovídá počtu nalezených textů umisťovacího řetězce).

<HorizontalSpacing>
[nepovinný element]

Vstup Popis

int

Hodnota určuje rozestup podpisových polí, pokud se vkládá více polí, než je vyhledaných textů umisťovacího řetězce. Výchozí hodnota: 10.

<SizeInPDFPoints>
[nepovinný element]

Vstup Popis

Boolean

Hodnota určuje, zda je Width/Height udáno v PDF bodech nebo v bodech pro 300DPI.

</AutoPlacementOptions>

<ShowValidationStatus>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota určuje, zda bude zobrazena ikona s výsledkem ověření pečeti. Vyžaduje Adobe Reader. Výchozí hodnota: false.

<Page>
[nepovinný element]

Vstup Popis

Int

Číslo stránky, na které je vizualizace pečeti. Pokud je zadané číslo větší než počet stránek dokumentu, bude vizualizace na poslední straně. Výchozí hodnota: 1.

<Text>
[nepovinný element]

Vstup Popis

String

Text vizualizace pečeti.

<ImagePath>
[nepovinný element]

Vstup Popis

String

Cesta k souboru s obrázkem pečeti.

<PosX>
[nepovinný element]

Vstup Popis

Int

Parametr pozice obrázku pečeti, X pozice od dolního levého rohu v rozlišení 300DPI.

Výchozí hodnota: 0.

<PosY>
[nepovinný element]

Vstup Popis

Int

Parametr pozice obrázku pečeti, Y pozice od dolního levého rohu v rozlišení 300DPI.

Výchozí hodnota: 0.

<Width>
[nepovinný element]

Vstup Popis

Int

Parametr pozice obrázku pečeti – šířka, v rozlišení 300DPI. Výchozí hodnota: 0.

<Height>
[nepovinný element]

Vstup Popis

Int

Parametr pozice obrázku pečeti – výška, v rozlišení 300DPI. Výchozí hodnota: 0.

<LocationInfo>
[nepovinný element]

Vstup Popis

String

Určuje polohu, kde byl dokument podepsán.

<ContactInfo>
[nepovinný element]

Vstup Popis

String

Určuje osobu, která podepsala dokument.

<Reason>
[nepovinný element]

Vstup Popis

String

Definuje důvod podepsání dokumentu.

</Signature>

<AddTimeStamp>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota určuje, zda bude k dokumentu připojeno časové razítko.

Výchozí hodnota: false.

<TimeStamp>
[nepovinný element]

<LocationInfo>
[nepovinný element]

Vstup Popis

String

Určuje polohu, kde byl dokument opatřen časovým razítkem.

<ContactInfo>
[nepovinný element]

Vstup Popis

String

Určuje osobu, která opatřila dokument časovým razítkem.

<Reason>
[nepovinný element]

Vstup Popis

String

Definuje důvod opatření dokumentu časovým razítkem.

</TimeStamp>

<PreserveExistingSignature>
[nepovinný element]

Vstup Popis

Boolean

Logická hodnota určuje, zda bude zachován elektronický podpis/pečeť. Pokud je nastaven výstupní formát na PDF/A, není možné zachovat elektronický podpis/pečeť konvertovaného dokumentu.

Výchozí hodnota: true.

<ConvertSignedPDF>
[nepovinný element]

Vstup Popis

Boolean

Při konverzi podepsaného/opečetěného PDF se vytváří PDF/A-3, přikládá se originální soubor jako příloha a do metadat se uloží info o odstraněných podpisech/pečetích.

Výchozí hodnota: false.

<StrictSignedPDFConversion>
[nepovinný element]

Vstup Popis

Boolean

Konvertuje podepsané/pečetěné PDF jenom v případě, že aspoň jeden podpis/pečeť je platný, jinak vrátí PRN_CR_UNABLE_CONVERT_WITH_INVALID_SIGS.

Výchozí hodnota: false.

<ReturnErrorIfNotModified>
[nepovinný element]

Vstup Popis

Boolean

Pokud vstupní soubor nevyžaduje žádnou změnu na základě nastavení ConvertOptions, je vrácen chybový kód PRN_CR_NOT_MODIFIED.

Výchozí hodnota: false.

<XMLReportTemplate>
[nepovinný element]

Vstup Popis

String

Cesta k souboru se strukturou XML reportu. Výchozí hodnota: Report.xml (v InstallDir).

<XMLReportSignaturesTemplate>
[nepovinný element]

Vstup Popis

String

Cesta k souboru se strukturou XML reportu pro odstraněné podpisy/pečetě.

Výchozí hodnota: Report_signatures.xml (v InstallDir).

<AddXMLReportToXMP> [nepovinný element]

Vstup Popis

Boolean

Definuje, jestli se Report přidává do XMP metadata souboru. Výchozí hodnota: false.

<ReturnFullXMPReport>
[nepovinný element]

Vstup Popis

Boolean

Použité jenom v případě zapnutého předešlého argumentu. Vrátí všechna XMP metadata místo XML reportu. Výchozí hodnota: false.

<MaxInputFileSize> [nepovinný element]

Vstup Popis

Int

Maximální velikost vstupního souboru v bytech. Výchozí hodnota: 0 (neomezeno).

<AllowedFileTypes>
[nepovinný element]

Vstup Popis

String

Typy souborů pro konverzi, pro libovolný dokument nastavte * (hvězdičku; výchozí hodnota). Jednotlivé formáty jsou odděleny ; (středníkem).

<EnableOCR> [nepovinný element]

Vstup Popis

Boolean

Aktivuje OCR scanování textu v případě celostránkového obrázku v souboru. V případě, že stránka obsahuje obrázek, který nepokrývá 100% stránky, OCR se neprovádí.

Výchozí hodnota: true

<ForceOCR>
[nepovinný element]

Vstup Popis

Boolean

Aktivuje OCR v případě stránky, která obsahuje aspoň jeden obrázek. POZOR – ztráta kvality textu, převede celou stránku do obrázku a hledá text.

Nutné nastavení EnableOCR na true (výchozí).

Výchozí hodnota: false.

<AddSourceAsPDFA3AssociatedFile>
[nepovinný element]

Vstup Popis

Boolean

Zdrojový soubor je součástí výstupního PDF/A-3 dokumentu ve formě asociované přílohy. Výchozí hodnota: false.

<AddSourceIfNotchanged>
[nepovinný element]

Vstup Popis

Boolean

Originál se nepřikládá, pokud se na souboru nemusí provádět žádné změny. Vrátí se původní soubor. Výchozí hodnota: false.

<ForcePDFAIfErrors>
[nepovinný element]

Vstup Popis

Boolean

Výstupní soubor se při konverzi do PDF/A označí jako PDF/A i přesto, že v něm zůstávají nějaké chyby neopravené. Výchozí hodnota: false.

<ForceImagePDFAIfErrors>
[nepovinný element]

Vstup Popis

Boolean

V případě, že se nepovede převést vstupní dokument do PDF/A, převede nejdříve celý dokument do obrázkového PDF a následně jej převede do PDF/A.

Výchozí hodnota: false.

<ForceImagePDFAResolution>
[nepovinný element]

Vstup Popis

Int

Nastaví rozlišení, které se, v případě použití parametru ForceImagePDFAIfErrors, použije pro obrázkové PDF. Výchozí hodnota: 200.

<HttpHeaders>
[nepovinný element]

Vstup Popis

string

HTTP hlavičky je možné použít v případě konverze webové stránky do PDF.

</Options>

<CustomXMLData>
[nepovinný element]

Vstup Popis

string

Vlastní formát reportovacího XML.

Odpověď

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ConvertFileExResponse xmlns="http://software602.com/longtermdocs/">
      <ConvertFileExResult>int</ConvertFileExResult>
      <Output>base64Binary</Output>
      <Report>string</Report>
      <ErrorMessage>string</ErrorMessage>
    </ConvertFileExResponse>
  </soap:Body>
</soap:Envelope>

<ConvertFileExResult>

Návratová hodnota Popis

Int

Výsledek metody ConvertFileEx. 0 = v pořádku.

Jinak viz kapitola Návratové kódy.

<Output>

Návratová hodnota Popis

Base64Binary

Base64Binary tvar konvertovaného dokumentu v odpovídajícím formátu PDF či PDF/A ve tvaru dle zvoleného konverzního profilu.

<Report>

Návratová hodnota Popis

string

XML report – šablona reportu je v instalačním adresáři v souboru Report.xml. Při převodu se do šablony doplní zvolené údaje, např. jméno dokumentu, čas převodu, výsledek převodu, hash vstupního a výstupního souboru, informace o podpisech převáděného PDF souboru atd.

<ErrorMessage>

Návratová hodnota Popis

string

Obsahuje text chyby v případě neúspěšné konverze.

Příklad vytvoření PDF/A-2a s pečetí a časovým razítkem z Wordu

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ConvertFileEx xmlns="http://software602.com/longtermdocs/">
      <Input>Base64Binary</Input>
      <FileName>Soubor.docx</FileName>
      <Options>
        <PdfFormat>PDF_A_2a</PdfFormat>
        <AddSignature>true</AddSignature>
        <Signature>
          <CertificateID>urn:sha:8QuEIay9kC7fKKFmM2oy1Pe6hE4=</CertificateID>
          <AddTimeStamp>true</AddTimeStamp>
          <CreateBES>true</CreateBES>
          <LocationInfo>Hornokrčská 15, Praha 4, CZ</LocationInfo>
          <ContactInfo>www.602.cz</ContactInfo>
          <Reason>Podepsáno pomocí Long-Term Docs pro testovací účely</Reason>
        </Signature>
      </Options>
    </ConvertFileEx>
  </soap:Body>
</soap:Envelope>