Instalace Long-Term Docs

Tato kapitola popisuje běžný postup pro instalaci řešení Long-Term Docs (LTD) a potřebných komponent pro zprovoznění jím poskytovaných funkcí a služeb. Popis je určen především technickým osobám, které spravují servery a služby v dané organizaci. Popis některých částí, zejména Správce Windows serveru (Server Manager), se může lišit v závislosti na použité verzi operačního systému.

Potřebný software

Jaké programové vybavení je zapotřebí k instalaci a provozu LTD?

  • 64-bitový operační systém Microsoft Windows Server 2016, Windows Server 2019 nebo Windows Server 2022.

  • Webový Server (IIS).

  • ASP.NET 4.7.2 nebo vyšší.

  • .NET Framework 4.7.2 nebo vyšší.

  • Microsoft Visual C++ Redistributables 2015, 2017, 2019 a 2022 (tzv. latest).

  • Nativní aplikace pro konverze speciálních formátů, např. Microsoft Office pro formáty DOCX, XLSX.

Vzhledem k zajištění vysoké prostupnosti je vhodné zabezpečit adekvátní velikost operační paměti RAM a rychlost komunikačních rozhraní. Detailněji bude specifikováno v rámci analýzy a přílohy ke smlouvě.

Pro správnou funkčnost Long-Term Docs je také zapotřebí mít na serveru (popřípadě firewallu, proxy apod.) povolenou komunikaci s adresami:

Prostředí Doménové jméno IP adresa Port Protokol

PROD (QS)

awsc.secusign.cz

13.73.167.130

443

https

PROD (HSM)

rsm.secusign.eu

194.228.175.135

443

https

TEST (QS)

awsctest.secusign.cz

52.178.28.175

443

https

TEST (HSM)

rsmtest.secusign.eu

194.228.175.135

443

https
Adresa rsm/rsmtest.secusign.eu je nutná pouze pro vzdálené pečetění v rámci konverze.

V případě povolené kontroly revokace certifikátu vzdáleného serveru je třeba mít povolenou adresu distribučního místa vystavitele zprostředkujícího certifikátu (Thawte TLS RSA CA G1) a vystavitele kořenového certifikátu (DigiCert Global Root CA2):

Doménové jméno IP adresa Port Protokol

cdp.thawte.com

93.184.220.29

80

http

crl3.digicert.com

93.184.220.29

80

http

Instalace LTD

Long-Term Docs nainstalujete spuštěním dodaného MSI installeru.

Instalace případně upozorní na chybějící prerekvizity. Aktuálně jsou potřebné dvě:

  • První z nich dodává samotný balíček.

  • Druhou je případně třeba dodat ručně – jedná se o latest verzi (Visual Studio 2015, 2017, 2019, and 2022; vc_redist.x64.exe) a je dostupná ze stránek Microsoft.

V průběhu instalace si zvolíte adresář, do kterého budou nakopírovány zdrojové soubory.

MSI installer je k dispozici na vyžádání u obchodního či projektového manažera.

Webové služby

Pro využití integrace prostřednictvím webových služeb je nutné zajistit Webový server IIS a odpovídající nastavení aplikačního poolu a webové aplikace, viz kapitoly 5. Instalace Webového serveru IIS a 6. Instalace Webové aplikace Long-Term Docs.

.NET rozhraní

Long-Term Docs umožňuje integraci funkcí a operací nad dokumenty také pomocí rozhraní .NET knihovny Software602.Converter.dll.

Instalace Webového serveru IIS

NET knihovny jsou obsaženy po instalaci Long-Term Docs v adresáři Engine. Rozhraní .NET metod je opatřeno komentáři ve formě XML dokumentace. Většina metod .NET assembly má stejné rozhraní jako metody webových služeb, které jsou popsány v technické dokumentaci k Long-Term Docs (na vyžádání). Díky tomu je snadná integrace do jiných informačních systémů či webových aplikací.

Instalace Webového serveru IIS krok za krokem:

  • Spusťte Správce serveru (Server Manager).

  • Klikněte vpravo nahoře na Správa (Manage).

  • Klikněte na Přidat role a funkce (Add Roles and Features).

  • Stiskněte tlačítko Další (Next).

  • Nechte vybrané Instalace na základě rolí nebo na základě funkcí (Role-based or feature-based installation) a stiskněte Další (Next).

  • Vyberte server z fondu serverů (Select a server from a server pool) a stiskněte Další (Next).

  • Zaškrtněte možnost Webový server (IIS) [Web Server (IIS)] a potvrďte funkce kliknutím na tlačítko Přidat funkce (Add Features).

  • Stiskněte tlačítko Další (Next).

  • Rozbalte volbu Funkce rozhraní .NET Framework 4.x (.NET Framework 4.x Features) a zaškrtněte pole .NET Framework 4.x.

    X v označení verze upřesňuje aktuálně použitou verzi Windows serveru (4.7, 4.8 apod.).

  • Stiskněte tlačítko Další (Next).

  • Stiskněte tlačítko Další (Next).

  • Rozbalte možnost Vývoj aplikací (Application Development) volbu Technologie ASP.NET 4.x (ASP.NET 4.x) a potvrďte přidání funkcí tlačítkem Přidat funkce (Add Features).

  • Dále u možnosti Nástroje pro správu (Management Tools) zaškrtněte možnost Konzola pro správu služby IIS (IIS Management Console).

  • Pokračujte tlačítkem Další (Next).

  • A instalaci vybraných funkcí spusťte tlačítkem Nainstalovat (Install).

  • Po dokončení instalace stiskněte tlačítko Zavřít (Close).

Po dokončení instalace může být vyžadován restart serveru.

Instalace Webové aplikace Long-Term Docs

Dále opět následuje popis postupu krok za krokem.

  • Nainstalujte balíček Long-Term Docs – standardně se instaluje do
    C:\Program Files\Software602\Long-Term Docs SDK.

  • (Tento krok není povinný)
    Nakopírujte adresář WebService z instalačního adresáře C:\Program Files\Software602\Long-Term Docs SDK do zvoleného umístění na serveru – běžně se používá cesta c:\inetpub\wwwroot. Adresář WebService přejmenujte na LTD.

  • V IIS administraci vytvořte nový aplikační pool „Long-Term Docs“ nebo upravte nastavení již existujícího poolu.

    Pokud budete upravovat již existující pool, nové nastavení může ovlivnit běh stávajících aplikací v tomto poolu, proto doporučujeme vytvořit nový.

    • Klikněte na položku Start – Ovládací panely (Control panels) – Nástroje pro správu (Administrative Tools) – Správce internetové informační služby (Internet Information Services (IIS) Manager).

    • Kliknutím na „+“ rozbalte uzel aktuálního počítače.

    • Klikněte na položku Fondy aplikací (Application Pools).

    • Vpravo ve sloupci Akce (Actions) klikněte na volbu Přidat fond aplikací (Add application pool).

    • Zadejte název poolu Long-Term Docs a v poli Verze rozhraní .NET Framework (.NET CLR version) vyberte volbu .NET Framework v4.x (.NET CLR Version v4.0.xxxx). Zkontrolujte, zda v poli Spravovaný režim kanálů (Managed pipeline mode) je vybrána volba Integrovaný (Integrated). Ponechte zaškrtnutou možnost Spustit fond aplikací ihned (Start application pool immediately). Stiskněte tlačítko OK.

    • Na vytvořený pool Long-Term Docs klikněte pravým tlačítkem, vyberte možnost Upřesnit nastavení (Advanced settings) a u položky Načíst profil uživatele (Load User Profile) nastavte hodnotu True. U položky Identita (Identity) pak změňte ApplicationPoolIdentity na konkrétního uživatele, například Administrator.

Existují dva způsoby, jak přidat webovou službu jako aplikaci do IIS. Vyberte si jeden ze způsobů a přidejte aplikaci do IIS. Doporučený je způsob b), protože adresář wwwroot má přednastavená práva čtení a spouštění pro webové aplikace.

  • Přidání nové aplikace Long-Term Docs v IIS

    • Vlevo ve sloupci Připojení kliknutím na „+“ rozbalte položku Weby (Sites).

    • Klikněte pravým tlačítkem myši na položku Default Web Site a z lokální nabídky vyberte položku Přidat aplikaci (Add application).

    • V položce Alias pojmenujte aplikaci, např. hodnotou LTD.

    • Vpravo vedle položky Fond aplikací (Application pool) stiskněte tlačítko Vybrat (Select), vyberte hodnotu Long-Term Docs /jiný námi připravený pool a stiskněte tlačítko OK.

    • Do pole Fyzická cesta (Physical path) vyplňte cestu k instalačnímu adresáři Long-Term Docs SDK\WebService.

    • Stiskněte tlačítko OK.

  • Nechte automaticky vytvořit aplikaci (předpokládá nastavení z druhého nepovinného kroku na začátku kapitoly).

    • Vlevo ve sloupci Připojení (Connections) kliknutím na „+“ rozbalte položku Weby\Default Web Site (Sites\Default Web Site).

    • Klikněte pravým tlačítkem myši na složku LTD.

    • Vyberte možnost Převést na aplikaci (Convert to application).

  • Po přidání/vytvoření klikněte levým tlačítkem na novou aplikaci LTD, poté uprostřed okna na Výchozí dokument (Default document) a nastavte výchozí dokument posunutím položek buď na Default.asmx (používá se pro spisovou službu při upgrade z Print2PDF) nebo na LTD.asmx (používá se pro nové instalace a klienty Signer). Pokud dokument v seznamu chybí, můžete jej přidat pomocí pravého menu Akce (Actions).

Nastavení debugovacího logu a konverzních formátů je uloženo v konfiguračním souboru v instalačním adresáři Long-Term Docs SDK\Engine\Engine.config.

Instalace certifikátu

Pro správné fungování webové služby Long-Term Docs je zapotřebí licenčního certifikátu a nastavit přístup k němu.

  1. Stáhněte a uložte soubor .p12 s licenčním certifikátem do umístění, kam bude mít webová služba přístup, např. C:\inetpub\wwwroot\LTD.

  2. Nastavte cestu k souboru licenčního certifikátu a heslo do konfiguračního souboru Web.config, který naleznete v adresáři WebService (resp. LTD), jako hodnoty klíčů LTD_CertPath a LTD_CertPass.

V případě využití .NET knihoven Long-Term Docs se cesta k souboru licenčního certifikátu a heslo nastavují jako hodnoty klíčů LTD_CertPath a LTD_CertPass v konfiguračním souboru Long-Term Docs SDK\Engine\Engine.config. Klíče je nutné vytvořit v části <appSettings>.

Licenční certifikát LTD obdrží (nebo o něj žádá) zákazník/partner/implementátor od své kontaktní osoby Software602 a.s. (obchodní nebo projektový manažer).

Test funkčnosti certifikátu

  1. Otevřete webový prohlížeč a zadejte adresu „[vaše doména]/[název webové služby]”.

  2. Vyberte metodu TestLicence.

  3. Klikněte na tlačítko Vyvolat (invoke).

  4. Podle výstupu zjistíte, zda je certifikát nakonfigurovaný správně.

Konverze dokumentů

Konfiguraci pro korektní převody dokumentů Microsoft Office, Open Office a FO/ZFO (Datových zpráv) souborů naleznete v kapitole Konverzní formáty a jejich konfigurace