Utilisation de Windows PowerShell pour lancer un travail de gestion de données OneStream

Windows PowerShell est un langage de script shell souvent utilisé en conjonction avec le Planificateur de tâches Windows pour les tâches et activités d'automatisation. La possibilité d'automatiser les tâches enlève une chose supplémentaire à l'utilisateur final. Dans cet article, nous allons explorer comment utiliser Windows PowerShell pour exécuter un travail de gestion de données à partir de OneStream. Les travaux de gestion des données dans OneStream peuvent être utilisés pour consolider des données, effacer des données, exécuter un calcul, exporter des données, lancer une règle métier, etc.

Remarque: Ce script ne fonctionne que pour les clients qui ne s'authentifient pas avec SSO.

Tout d'abord, nous initialisons l'API client OneStream en ajoutant le chemin d'accès à l'API OneStream située dans les fichiers de configuration de OneStream. En règle générale, le chemin d'accès répertorié ci-dessous est l'emplacement de l'API.

Add-Type -Path "C: Program Files (x86) OneStream Software OneStreamStudio OneStreamClientApi.dll"

Ensuite, nous déclarons une variable qui contient la commande pour créer une instance de l'API.

$ xfApi = new-object OneStream.Client.Windows.OneStreamClientApi

Cette partie est utilisée pour se connecter et ouvrir l'application (Remarque: cela ne fonctionne que pour OneStream natif ID. Cela ne fonctionnera pas pour la connexion unique). Ici, nous déclarons une variable qui démarre l'instance de l'API. Dans le script, vous devez définir l'adresse du serveur, le nom d'utilisateur OneStream, le mot de passe et le nom de l'application.

$ xfLogonInfo = $ xfApi.Authentication.LogonAndOpenApplication ("SERVER_ADDRESS", "OneStream_Username", "OneStream_Password", "OneStream_Appass_App" , [OneStream.Shared.Wcf.XFClientAuthenticationType] :: ClearTextPW)

Nous exécutons une boucle pour vérifier si l'application a été ouverte avec succès. Si c'est le cas, la console affiche que la connexion a réussi. Une nouvelle variable est ensuite déclarée pour exécuter la séquence de gestion des données. Vous devez définir ici le nom du travail de gestion des données et tous les paramètres / variables. S'il n'y a pas de paramètres / variables, laissez les deuxièmes guillemets vides, comme indiqué ci-dessous. Une fois le travail de gestion des données exécuté, vous obtiendrez un message imprimé dans la console pour vous informer s'il y a eu une erreur (généralement du côté OneStream) ou si elle a été exécutée avec succès. Le script se déconnecte ensuite de OneStream et ferme la connexion API. Si l'application n'a pas été ouverte avec succès, un message expliquant pourquoi l'application ne s'est pas ouverte sera imprimé dans la console.

 if ($ xfLogonInfo.IsAppOpen) {
"Connexion réussie."
"Exécution de la séquence de gestion des données ..."

$ xfResult = $ xfApi.DataManagement.ExecuteSequence ("DataManagementJobName", "")
$ xfResult.Message

$ xfApi.Authentication.Logoff ()
"Déconnecté."
}

autre {
$ xfLogonInfo.ErrorMessage
}

Le code terminé ressemble à ceci:

 Add-Type -Path "C:  Program Files (x86)  OneStream Software  OneStreamStudio  OneStreamClientApi.dll"
$ xfApi = nouvel objet OneStream.Client.Windows.OneStreamClientApi
$ xfLogonInfo = $ xfApi.Authentication.LogonAndOpenApplication ("SERVER_ADDRESS", "OneStream_Username", "OneStream_Password", "OneStream_Application", [OneStream.Shared.Wcf.XFClientAuthenticationType] :: ClearTextPW)

if ($ xfLogonInfo.IsAppOpen) {
"Connecté avec succès."
"Exécution de la séquence de gestion des données ..."

$ xfResult = $ xfApi.DataManagement.ExecuteSequence ("DataManagementJobName", "")
$ xfResult.Message

$ xfApi.Authentication.Logoff ()
"Déconnecté."
}

autre {
$ xfLogonInfo.ErrorMessage
}