Aktivieren Sie bitte JavaScript, um diese Seite anzeigen zu können.

Altova MapForce Server 2020 

Die MapForceServer-Klasse erstellt eine MapForce Server-Objektinstanz und ermöglicht den Zugriff auf den MapForce Server-Prozessor.

 

Methoden

Name

Beschreibung

addCredentialPropertiesFromMap

Fügt zu den aktuellen Anmeldeinformationen Eigenschaften aus einer Anmeldeinformationen-Eigenschaftszuordnung hinzu. Diese Methode erhält als Argument eine Anmeldeinformationen-Eigenschaftszuordnung (property_name, property_value). Diese Methode muss nach beginCredential() und vor endCredential() aufgerufen werden. Alternativ dazu können Sie auch AddCredentialProperty() aufrufen.

addCredentialProperty

Fügt eine Eigenschaft zu den aktuellen Anmeldeinformationen hinzu (z.B. den Benutzernamen, das Passwort oder beides). Das erste Argument definiert den Namen der Eigenschaft, das zweite den Wert der Eigenschaft. Gültige Eigenschaftsnamen: username, password. In der MapForce Server Advanced Edition wird zusätzlich dazu der Eigenschaftsname oauth:token unterstützt.

 

Diese Methode muss nach beginCredential() und vor endCredential() aufgerufen werden. Alternativ dazu können Sie auch addCredentialProperty() aufrufen.

addParameter

Weist einem im Mapping definierten Parameter einen Wert zu.

beginCredential

Erstellt neue Anmeldeinformationen mit dem als Argument bereitgestellten Namen. Wenn Sie diese Methode aufrufen, müssen Sie mit Hilfe von addCredentialProperty() oder addCredentialPropertiesFromMap() auch Eigenschaften dazu hinzufügen und die Anmeldeinformationen schließlich durch Aufruf von endCredential() schließen.

clearCredentialList

Löscht die Liste der zuvor definierten Anmeldeinformationen. Alle Anmeldeinformationen sind während der Lebensdauer des Objekts gültig. Rufen Sie diese Methode auf, wenn Sie alle zuvor definierten Anmeldeinformationen explizit löschen möchten.

clearOptions

Löscht die Liste der zuvor mit der Methode setOption definierten Optionen. Alle mit der setOption-Methode definierten Methoden sind während der Lebensdauer des Objekts gültig. Rufen Sie diese Methode auf, wenn Sie alle zuvor gesetzten Optionen explizit löschen möchten.

clearParameterList

Löscht die Liste der zuvor mit der Methode addParameter definierten Parameter.

endCredential

Schließt ein zuvor mit der Methode beginCredential erstelltes Anmeldeinformationsobjekt.

getAPIMajorVersion

Ruft die Hauptversion der MapForce Server API ab. Diese stimmt unter Umständen nicht mit der Produktversion überein, wenn die API mit einem anderen Server verbunden ist.

getAPIMinorVersion

Ruft die Nebenversion der MapForce Server API ab. Diese stimmt unter Umständen nicht mit der Produktversion überein, wenn die API mit einem anderen Server verbunden ist.

getAPIServicePackVersion

Ruft die Service Pack-Version der MapForce Server API ab. Diese stimmt unter Umständen nicht mit der Produktversion überein, wenn die API mit einem anderen Server verbunden ist.

getLastExecutionMessage

Ruft die beim letzten run-Befehl erhaltene Meldung ab.

getMajorVersion

Ruft die Hauptversion des Produkts als Anzahl von Jahren seit 1998 ab (z.B. "20" für Altova MapForce Server 2018).

getMinorVersion

Ruft die Nebenversion des Produkts ab (z.B. "2" für Altova MapForce Server 2018 r2).

getOutputParameter

Ruft den mit dem letzten run-Befehl generierten String Output ab. Gibt Null zurück, wenn kein Output generiert wurde. Für diese Funktion ist ein String-Parameter, der den Namen der Output-Komponente in MapForce definiert, erforderlich.

getProductName

Ruft den Namen des Produkts ab (z.B. "Altova MapForce Server").

getProductNameAndVersion

Ruft den vollständigen Namen und die Version des Produkts ab (z.B. "Altova MapForce Server 2018 r2 sp1 (x64)").

getServicePackVersion

Ruft die Service Pack-Version des Produkts ab bzw. definiert sie (z.B. "1" für Altova MapForce Server 2018 r2 sp1 (x64)).

is64bit

Gibt true zurück, wenn der MapForce Server-Prozessor eine ausführbare 64-Bit-Datei ist.

run

Führt eine MapForce Server-Ausführungsdatei (.mfx-Datei) aus. Gibt bei Erfolg true zurück, andernfalls false.

setOption

Definiert vor Ausführung des Mappings eine Option. Das erste Argument definiert den Namen der Option, das zweite Argument definiert den Optionswert. Diese Methode ist besonders dann nützlich, wenn in einem Mapping globale Ressourcen verwendet werden (siehe Globale Altova-Ressourcen). Derzeit werden die folgenden Optionen unterstützt:

 

globalresourcefile (oder gr) - Der Pfad zu einer globalen Ressourcendatei. (Wenn diese Option definiert ist, muss auch ein Name für die Konfiguration der globalen Ressource definiert werden, siehe nächster Eintrag).

globalresourcefile (oder gr) - Name einer globalen Ressourcenkonfiguration. (Wenn diese Option definiert ist, muss ein Dateipfad zu einer globale Ressourcen-Datei definiert werden, siehe vorheriger Eintrag).

catalog - Pfad zu eienr benutzerdefinierten RootCatalog.xml-Datei. Mit Hilfe dieser Option können Sie eine benutzerdefinierte Katalogdatei für die Auflösung von im Mapping verwendeten URLs definieren. Der Standardkatalog befindet sich im Unterverzeichnis "etc" des Programminstallationsverzeichnisses.

taxonomy-package - Der Pfad zu einem benutzerdefinierten XBRL-Taxonomiepaket, falls eines für das Mapping erforderlich ist.

taxonomy-packages-config-file - Der Pfad zu einer benutzerdefinierten XBRL-Taxonomiepaketkonfiguration, falls eine für das Mapping erforderlich ist.

 

Alle definierten Optionen sind während der Lebensdauer des Objekts gültig. Wenn Sie eine Option mit demselben Namen zwei Mal definieren, wird die vorherige Option außer Kraft gesetzt. Um alle Optionen explizit zu löschen, rufen Sie die Methode clearOptions() auf.

setServerPath

Definiert den Pfad der ausführbaren MapForce Server-Datei.

setWorkingDirectory

Definiert das aktuelle Verzeichnis für ausgeführte Aufträge (relative Pfade werden anhand des Arbeitsverzeichnisses aufgelöst).

 

Beispiele

Ein Beispiel zur Erstellung einer neuen Instanz von MapForceServer in Java finden Sie im Java-Beispiel.

© 2019 Altova GmbH