IServer
L'interface IServer crée une instance d'objet de MapForce Server, et fournit l'accès au moteur de MapForce Server.
Si vous utilisez C++ sous une plateforme COM, le nom de l’interface principale est IServer. Si vous utilisez un langage .NET comme C# ou VB.NET, le nom de l’interface principale est Server.
Propriétés
Nom | Description |
|---|---|
Read-only. 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. | |
Read-only. 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. | |
Read-only. Obtient la version 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. | |
Read-only. Retourne true si le moteur MapForce Server est un exécutable 64-bit. | |
Read-only. Obtient le message reçu pendant la dernière commande Run. | |
Read-only. 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)). | |
Read-only. Obtient la version mineure du produit (par exemple, "2" pour Altova MapForce Server 2018 r2 sp1 (x64)). | |
Read-only. Obtient le nom du produit (par exemple, "Altova MapForce Server"). | |
Read-only. Obtient le nom complet et la version du produit (par exemple, "Altova MapForce Server 2018 r2 sp1 (x64)"). | |
Obtient ou définit le chemin de l'exécutable MapForce Server. | |
Read-only. Obtient la version de pack de service du produit (par exemple, "1" pour Altova MapForce Server 2018 r2 sp1). | |
Obtient ou définit le répertoire actuel pour exécuter les tâches (les chemins relatifs seront évalués par rapport au répertoire de travail). |
Méthodes
Nom | Description |
|---|---|
Ajoute une propriété à l'identifiant actuel (par exemple, le nom d'utilisateur, le mot de passe, ou les deux). Le premier argument spécifie le nom de la propriété, et le second argument spécifie la valeur de la propriété. Noms de propriété valides : username, password. Dans MapForce Server Advanced Edition, le nom de propriété oauth:token est également pris en charge.
Cette méthode doit être appelée après avoir appelé BeginCredential() et avant d'appeler EndCredential(). | |
Assigne une valeur à un paramètre défini dans le mappage. Le premier argument spécifie le nom du paramètre tel que défini dans le mappage ; le second argument spécifie la valeur de paramètre. | |
Crée un nouvel identifiant avec le nom fourni en tant qu'argument. Si vous appelez cette méthode, vous devez aussi y ajouter des propriétés en utilisant AddCredentialProperty(), puis fermer l'identifiant en appelant EndCredential(). | |
Supprime 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. | |
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. | |
Supprime la liste des paramètres qui étaient définis précédemment en utilisant la méthode AddParameter. | |
Ferme un objet d'identifiant qui a été créé précédemment en utilisant la méthode BeginCredential. | |
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. | |
Exécute un fichier MapForce Server Execution (fichier .mfx). Retourne true en cas de succès ; sinon, false. | |
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(). | |
Cette méthode stoppe explicitement le processus connecté avec l'objet COM, sans relâcher l'objet. Le processus s'arrête implicitement lorsque l'objet COM est relâché. |
Exemples
Voir les exemples suivants qui illustrent comment initialiser et exécuter MapForce Server dans des langages différents :