dox42 Server V3.5.1-3.6.1

  • View
    226

  • Download
    0

Embed Size (px)

Text of dox42 Server V3.5.1-3.6.1

  • dox42 Server V3.5.1-4.0

    Dokumentation

  • www.dox42.com 2

    Zusammenfassung

    In die diesem Dokument sind die Serviceschnittstelle sowie die Konfigurationseinstellung des

    dox42Servers beschrieben.

    Inhalt

    Zusammenfassung ............................................................................................................................................................ 2

    Inhalt ...................................................................................................................................................................................... 2

    Dokumentinfo ..................................................................................................................................................................... 3

    Service-Schnittstelle ........................................................................................................................................................ 4

    SOAP Schnittstelle ........................................................................................................................................................ 4

    REST Schnittstelle ........................................................................................................................................................ 5

    Service-Header .............................................................................................................................................................. 6

    Azure Active Directory Header ............................................................................................................................... 6

    OutputActions ..................................................................................................................................................................... 7

    SaveAction ....................................................................................................................................................................... 8

    SharePointAction.......................................................................................................................................................... 9

    Spezielle SharePoint und Managed Metadata Felder setzen.................................................................... 11

    EmailAction .................................................................................................................................................................. 12

    ReturnAction ................................................................................................................................................................ 15

    PrintAction .................................................................................................................................................................... 16

    Konfigurationsparameter ............................................................................................................................................ 17

    Beispiel ........................................................................................................................................................................... 18

    CORS Konfiguration ................................................................................................................................................... 19

    Azure Active Directory Zugriff .............................................................................................................................. 20

    Custom Error Messages Beispiel ......................................................................................................................... 20

    Hyphenation Dictionaries Beispiel ..................................................................................................................... 20

    Maximale Request-Gre und Timeout ............................................................................................................ 20

    Lizenz Aktivierung ..................................................................................................................................................... 21

    Installation ......................................................................................................................................................................... 22

    Upgrade ............................................................................................................................................................................... 24

    Support ................................................................................................................................................................................ 24

    http://www.dox42.com/

  • www.dox42.com 3

    Dokumentinfo

    Version: dox42 Server V3.5.1-4.0

    Autor: DI Christian Bauer

    Datum: 04.12.2017

    http://www.dox42.com/

  • www.dox42.com 4

    Service-Schnittstel l e

    Der dox42 Server ist ber eine SOAP- und eine REST-WebService Schnittstelle erreichbar.

    Operation: GenerateDocument/GenerateSlides

    Die Operation lsst sich ber folgende Paramater steuern:

    DocTemplate (String)

    Pfad zum Dokumenttemplate

    (z.B. C:\doctemplates\solarantrag.docx, ~\templates\mobilfunkrechnung.docx,

    C:\doctemplates\salesreport.pptx)

    InputParams (Key-Value String/String)

    Liste der Inputparameter und Werte:

    ParamName: Name des Parameters (nicht case-sensitive)

    Value: Wert des Parameters

    PostGenActions

    Liste, der nach der Dokumentgenerierung abzuarbeitenden OutputActions:

    ActionName: Name der Action (z.B. SaveAction), nicht case-sensitive

    Params: Parameter der Action (wie InputParams)

    Operation: GenerateSpreadSheet

    Die Operation lsst sich ber folgende Paramater steuern:

    DataMap (String)

    Pfad zum DataMap

    (z.B. C:\doctemplates\salesreport.dm, ~\templates\mobilfunkrechnung.dm)

    InputParams (Key-Value String/String)

    Liste der Inputparameter und Werte:

    ParamName: Name des Parameters (schreibungsunabhngig)

    Value: Wert des Parameters

    PostGenActions

    Liste, der nach der Dokumentgenerierung abzuarbeitenden OutputActions:

    ActionName: Name der Action (z.B. SaveAction), nicht case-sensitive

    Params: Parameter der Action (wie InputParams)

    Die Parameter der einzelnen OutputActions sind in diesem Dokument beschrieben.

    SOAP Schnittstelle

    URL: http://www.YourDomain.com/dox42service.asmx

    WSDL: http://www.YourDomain.com/dox42service.asmx?WSDL

    http://www.dox42.com/http://localhost/dox42service.asmx?op=GenerateDokumenthttp://localhost/dox42service.asmx?op=GenerateDokumenthttp://www.yourdomain.com/dox42service.asmxhttp://www.yourdomain.com/dox42service.asmx?WSDL

  • www.dox42.com 5

    REST Schnittstelle

    URL: http://www.YourDomain.com/dox42RestService.ashx

    REST und SOAP Schnittstelle haben identische Parameter und OutputActions. Bei der REST

    Schnittstelle werden alle Parameter als URL-Parameter bergeben. Ab Version 3.6.3 knnen alle

    Parameter auch als POST Parameter bergeben werden. Dabei gilt die folgende Syntax:

    Parametername Erfordernis Auswirkung

    Operation Obligatorisch

    GenerateDocument |

    GenerateSpreadSheet

    Auswahl der aufzurufenden

    Operation

    DocTemplate Obligatorisch bei

    Operation=GenerateDocument

    Pfad zum Dokumenttemplate

    DataMap Obligatorisch bei

    Operation=

    GenerateSpreadSheet

    Pfad zum DataMap

    InputParam.

    Fr jeden Inputparameter bergabe der Werte fr

    Inputparameter, z.B.:

    InputParam.KundenID=42

    .

    Fr jeden Parameter jeder

    OutputAction

    bergabe der Werte fr

    OutputAction-Parameter, z.B.:

    ReturnAction.Format=pdf

    ReturnAction.disp Optional

    Inline | attachment

    Steuert das Browser-Handling

    des zurckgelieferten

    Dokuments

    ReturnAction.Mode Optional

    File (Standard) | Text

    Bei Text wird der Inhalt des

    Dokuments direkt als Text im

    Browser ausgegeben. Das

    ermglicht u.a. das dynamische

    Generieren von HTML Seiten.

    ReturnAction.fileName Optional, nur bei

    ReturnAction.disp = attachment

    sinnvoll

    Name des zurckgelieferten

    Dokumentes

    RedirectURL Optional, nur ohne

    ReturnAction sinnvoll

    Nach Generierung wird ein

    Redirect durchgefhrt

    http://www.dox42.com/http://www.yourdomain.com/dox42RestService.ashx

  • www.dox42.com 6

    Achtung: URL-Encoding fr Sonderzeichen! (http://www.w3schools.com/tags/ref_urlencode.asp):

    Kunde.Name=Mller => Kunde.Name=M%C3%BCller

    Beispiel fr einen REST-Aufruf:

    http://www.YourDomain.com/dox42RestService.ashx?

    Operation=GenerateDocument&

    DocTemplate=%7e%5cTemplates%5cSales_Report%5cSales_Report.doc &

    InputParam.SelectEmployee=5&InputParam.SelectYear=2012&

    ReturnAction.format=pdf&ReturnAction.fileName=SalesReport.pdf&ReturnAction.disp=attachment

    Technische Hintergrundinformation

    Sollen komplexe Daten (z.B. Dateien) an das dox42 Service per Inputparameter bertragen werden,

    so ist die SOAP Schnittstelle zu bevorzugen, da bei der REST Schnittstelle alle Parameter als URL

    Parameter bertragen werden mssen.

    Service-Header

    Das dox42 SOAP Service lsst sich ber einen Service-Header absichern. Dieser enthlt

    Benutzername und Passwort. In der web.config kann die Verwendung des Service-Headers