Altova MapForce Server 2024 Advanced Edition

addCredentialPropertiesFromMap

Ajoute des propriétés d’un mappage de propriété de l’identifiant à un identifiant actuel Cette méthode prend un mappage de propriété de l’identifiant comme argument (property_name, property_value). Cette méthode doit être appelée après avoir appelé beginCredential() et avant d’appeler endCredential(). En alternative, vous pouvez aussi appeler AddCredentialProperty().

addCredentialProperty

Ajoute une propriété à l’identifiant actuel (par exemple, le nom utilisateur, le mot de passe ou les deux). Le premier argument spécifie le nom de propriété ; le second argument spécifie la valeur de propriété. Noms de propriété valides : username, password. Dans MapForce Server Advanced Edition, le nom de propriété oauth:token est de plus pris en charge.

Cette méthode doit être appelée après avoir appelé beginCredential() et avant d’appeler endCredential(). En alternative, vous pouvez aussi appeler addCredentialPropertiesFromMap().

addParameter

Assigne une valeur à un paramètre défini dans le mappage.

beginCredential

Crée un nouvel identifiant avec le nom fourni comme argument. Si vous appelez cette méthode, vous devez également ajouter des propriétés en utilisant addCredentialProperty() ou addCredentialPropertiesFromMap(), puis fermer l’identifiant en appelant endCredential().

clearCredentialList

Obtient la liste des identifiants définis précédemment. Tous les identifiants sont valides pour la durée de vie de l’objet. Appeler cette méthode si vous souhaitez supprimer explicitement tous les identifiants définis précédemment.

clearOptions

Efface la liste des options définies précédemment par le biais de la () méthode SetOption. Toutes les options définies par la méthode SetOption sont valides pour la durée de vie de l’objet. Appeler cette méthode si vous souhaitez supprimer explicitement toutes les options définies précédemment.

clearParameterList

Supprime la liste des paramètres qui étaient définis précédemment en utilisant la méthode addParameter.

endCredential

Ferme un objet d’identification qui a été précédemment créé utilisant la méthode beginCredential.

getAPIMajorVersion

Obtient la version majeure de l'API de MapForce Server. Cela peut différer de la version de produit si l'API est connectée à un autre serveur.

getAPIMinorVersion

Obtient la version mineure de l'API de MapForce Server. Cela peut différer de la version de produit si l'API est connectée à un autre serveur.

getAPIServicePackVersion

Obtient la version de pack de service de l'API MapForce Server. Cela peut différer de la version de produit si l'API est connectée à un autre serveur.

getLastExecutionMessage

Obtient le message reçu pendant la dernière commande run.

getMajorVersion

Obtient la version majeure du produit, en tant que nombre des années débutant avec 1998 (par exemple, "20" pour Altova MapForce Server 2018 r2 sp1 (x64)).

getMinorVersion

Obtient la version mineure du produit (par exemple, "2" pour Altova MapForce Server 2018 r2 sp1 (x64)).

getOutputParameter

Obtient la sortie de string générée par la dernière commande run. Retourne null si aucune sortie n'est générée. Cette fonction requiert un paramètre de string qui identifie le nom du composant de sortie dans MapForce.

getProductName

Obtient le nom du produit (par exemple, "Altova MapForce Server").

getProductNameAndVersion

Obtient le nom complet et la version du produit (par exemple, "Altova MapForce Server 2018 r2 sp1 (x64)").

getServerPath

Obtient le chemin vers le fichier exécutable binaire du serveur.

getServicePackVersion

Obtient la version de pack de service du produit (par exemple, "1" pour Altova MapForce Server 2018 r2 sp1 (x64)).

getWorkingDirectory

Obtient le Répertoire de travail actuel.

is64bit

Retourne true si le moteur MapForce Server est un exécutable 64-bit.

exécuter

Exécute un fichier MapForce Server Execution (fichier .mfx). Retourne true en cas de succès ; sinon, false.

setOption

Définit une option avant d’exécuter le mappage. Le premier argument spécifie le nom de l’option ; le second argument spécifie la valeur d’option. Cette méthode est particulièrement utile lorsqu’un mappage a été conçu pour consommer des Ressources globales (voir Altova Global Resources). Les options prises en charge actuellement sont les suivantes :

•globalresourcefile (ou gr) un chemin de fichier Ressource Globale. (Lorsque cette option est spécifiée, un nom de configuration de Ressource Globale doit aussi être spécifié, voir item suivant).

•globalresourceconfig (ou gc) - un nom de configuration de Ressource Globale. (Lorsque cette option est spécifiée, un chemin de fichier de Ressource Globale doit aussi être spécifié, voir item précédent).

•catalog - le chemin vers un fichier RootCatalog.xml personnalisé. Cette option vous permet de spécifier un fichier de catalogue personnalisé utilisé pour résoudre des URL utilisés par le mappage. Le catalogue par défaut se trouve dans le sous-directoire etc du répertoire d’installation du programme.

•taxonomy-package - le chemin vers un paquet de taxonomie XBRL personnalisé, si un tel pack est requis par le mappage.

•taxonomy-packages-config-file - le chemin vers une configuration de taxonomie XBRL personnalisée, si un tel pack est requis par le mappage.

Toutes les options définies sont valides pour la durée de vie de l’objet. Si vous définissez une option avec le même nom deux fois, l’option précédente sera contournée. Pour supprimer explicitement toutes les options, appeler la méthode ClearOptions().

setServerPath

Définit le chemin de l'exécutable MapForce Server.

setWorkingDirectory

Définit le répertoire actuel pour les tâches en cours (les chemins relatifs seront évalués par rapport au répertoire de travail).

arrêter

Arrête le processus du serveur.