Altova MapForce Server 2024 

APIMajorVersion

Schreibgeschützt.

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.

APIMinorVersion

Schreibgeschützt.

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.

APIServicePackVersion

Schreibgeschützt.

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.

Is64Bit

Schreibgeschützt.

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

LastExecutionMessage

Schreibgeschützt.

Ruft die beim letzten Run-Befehl erhaltene Meldung ab.

MajorVersion

Schreibgeschützt.

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

MinorVersion

Schreibgeschützt.

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

ProductName

Schreibgeschützt.

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

ProductNameAndVersion

Schreibgeschützt.

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

ServerPath

Ruft den Pfad der ausführbaren MapForce Server-Datei ab bzw. definiert ihn.

ServicePackVersion

Schreibgeschützt.

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

WorkingDirectory

Ruft das aktuelle Verzeichnis für ausgeführte Aufträge ab bzw. definiert es (relative Pfade werden anhand des Arbeitsverzeichnisses aufgelöst).

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 Argument den Wert der Eigenschaft. Gültie 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.

AddParameter

Weist einem im Mapping definierten Parameter einen Wert zu. Das erste Argument definiert den Namen des Parameters, wie er im Mapping definiert wurde; das zweite Argument definiert den Parameterwert.

BeginCredential

Erstellt neue Anmeldeinformationen mit dem als Argument bereitgestellten Namen. Wenn Sie diese Methode aufrufen, müssen Sie mittels AddCredentialProperty() auch Eigenschaften zu dieser hinzufügen und die Anmeldeinformationen schließlich durch Aufruf von EndCredential() schließen.

ClearCredentialList

Löscht die zuvor definierte Liste der Anmeldeinformationen. Alle Anmeldeinformationen sind während der Lebensdauer des Objekts gültig. Rufen Sie diese Methode auf, wenn Sie alle zuvor gesetzten 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 Optionen 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 definiertes Anmeldeinformationen-Objekt.

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.

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.

StopServerProcess

Mit dieser Methode wird der mit dem COM-Objekt verbundene Prozess explizit beendet, ohne dass das Objekt freigegeben wird. Der Prozess wird implizit beendet, wenn das COM-Objekt freigegeben wird.