Rédaction de scripts avec PortalPy pour l'exécution de tâches administratives
PortalPy est un module Python 2.7 qui vous permet de rédiger des scripts pour exécuter des tâches administratives courantes sur votre portail. Les scripts Python qui exploitent PortalPy peuvent être exécutés à partir de n'importe quel ordinateur ayant accès à votre portail tant qu'il est configuré pour exécuter Python 2.7 (obligatoire).
Cette rubrique présente une vue d'ensemble du module PortalPy et propose des exemples et des instructions pour vous aider au départ. Pour pouvoir utiliser PortalPy, vous devez être capable de rédiger des scripts Python, mais PortalPy est la méthode la plus flexible pour automatiser l'administration de votre portail. Avec PortalPy, vous pouvez automatiser tous les workflows proposés par les utilitaires de ligne de commande, les exemples de scripts Python, et bien plus.
Télécharger le module PortalPy (.zip)
Le module PortalPy est également disponible via un référentiel GitHub public. Cette ressource contient le module PortalPy le plus récent, ainsi que des informations supplémentaires transmises par la communauté des utilisateurs. Pour accéder à ce référentiel, vous devez créer un compte GitHub ou vous connecter avec votre compte GitHub.
Configuration du module PortalPy sur votre ordinateur
Pour rédiger des scripts pour des tâches administratives avec PortalPy, vous devez configurer le module PortalPy sur votre ordinateur. Il peut s'agir de tout ordinateur ayant accès à votre portail. Pour commencer, suivez les étapes ci-dessous.
- Télécharger le module PortalPy (.zip) et extrayez le contenu du fichier dans un répertoire appelé portalpy sur votre ordinateur.
- Sur l'ordinateur qui héberge le module PortalPy, définissez une variable d'environnement appelée PYTHONPATH. Indiquez le chemin d'accès au répertoire portalpy défini à l'étape précédente. Par exemple, export PYTHONPATH=$PYTHONPATH:<path from previous step>/portalpy-master.
- Créez un fichier appelé test.py et insérez-y le code suivant :
#!/usr/bin/python import portalpy url = "https://portalpy.esri.com/arcgis" portal = portalpy.Portal(url) print portal.get_version()
- Enregistrez et fermez le fichier.
- Exécutez test.py. Le script va imprimer un numéro de version tel que 2.3.
Votre ordinateur est désormais configuré pour utiliser le module PortalPy.
Documentation du module PortalPy
Pour connaître les classes et les méthodes incluses dans PortalPy, reportez-vous à la rubrique Module PortalPy. La rubrique contient des exemples d'utilisation qui peuvent vous aider à programmer avec l'API REST d'ArcGIS à l'aide du module PortalPy.
Exemples de scripts
Parmi les tâches administratives courantes que vous exécutez via des scripts en utilisant PortalPy, incluez les suivantes :
Exemple : répertorier les utilisateurs d'un groupe
portal = PortalPy.Portal(portalUrl, user, password)
resp = portal.get_group_members('67e1761068b7453693a0c68c92a62e2e')
for user in resp['users']:
print user
Exemple : créer un groupe
portal= PortalPy.Portal(portalUrl, user, password)
group_id = portalAdmin.create_group('my group', 'test tag', 'a group to share travel maps')
Exemple : supprimer un utilisateur et réattribuer le contenu de l'utilisateur à un autre utilisateur
portal= PortalPy.Portal(portalUrl, user, password)
portal.delete_user('amy.user', True, 'bob.user')