Exemple : mettre à jour l'URL d'un service dans une carte Web
Cet exemple permet de mettre à jour l'URL d'un service référencé dans des cartes Web. Cela est utile si l'URL du service a changé et que vous souhaitez éviter aux utilisateurs d'avoir à supprimer le service et à le rajouter dans toutes les cartes Web. Les raisons d'une modification de l'URL d'un service sont nombreuses. Par exemple, le service peut avoir été migré vers un nouveau serveur, le nom du service peut avoir été modifié, le service peut avoir été déplacé vers un autre dossier sur le serveur ou le préfixe du domaine du serveur peut avoir changé.
Vous devez spécifier les informations suivantes lorsque vous exécutez le script :
- URL utilisée pour accéder à Portal for ArcGIS. Il peut s'agir de l'URL d'ArcGIS Web Adaptor, par exemple https://webadaptor.domain.com/arcgis ou de l'URL de l'ordinateur qui héberge le portail, par exemple https://portal.domain.com:7443/arcgis. Vous devez inclure le nom de domaine complet de l'ordinateur lorsque vous spécifiez l'URL.
- Nom d'utilisateur et mot de passe d'un compte détenteur de privilèges administratifs sur le portail.
- Type d'élément qui sera mis à jour. Spécifiez "Carte Web", par exemple, pour mettre à jour toutes les cartes Web du portail.
- URL du service actuellement référencé dans les cartes Web, par exemple http://webadaptor.domain.com/arcgis/rest/services/folderA/ServiceAreas/MapServer.
- URL du service qui sera mis à jour dans les cartes Web, par exemple http://webadaptor.domain.com/arcgis/rest/services/folderB/ServiceAreas/MapServer.
L'exemple suivant permet de remplacer l'URL du service de carte http://webadaptor.domain.com/arcgis/rest/services/folderA/ServiceAreas/MapServer par l'URL du service de carte http://webadaptor.domain.com/arcgis/rest/services/folderB/ServiceAreas/MapServer pour toutes les cartes Web du portail :
python updateWebmapServices.py https://webadaptor.domain.com/arcgis admin pass.word "type: Web Map" http://webadaptor.domain.com/arcgis/rest/services/folderA/ServiceAreas/MapServer http://webadaptor.domain.com/arcgis/rest/services/folderB/ServiceAreas/MapServer
#!/usr/bin/env python
# Requires Python 2.7+
# Sample Usage:
# python updateWebmapServices.py <sourcePortal> <sourceAdmin> <sourcePassword>
# <query> <oldUrl> <newUrl>
import urllib
import json
import argparse
def generateToken(username, password, portalUrl):
'''Retrieves a token to be used with API requests.'''
parameters = urllib.urlencode({'username' : username,
'password' : password,
'client' : 'referer',
'referer': portalUrl,
'expiration': 60,
'f' : 'json'})
response = urllib.urlopen(portalUrl + '/sharing/rest/generateToken?',
parameters).read()
try:
jsonResponse = json.loads(response)
if 'token' in jsonResponse:
return jsonResponse['token']
elif 'error' in jsonResponse:
print jsonResponse['error']['message']
for detail in jsonResponse['error']['details']:
print detail
except ValueError, e:
print 'An unspecified error occurred.'
print e
def searchPortal(portalUrl, query=None, totalResults=None, sortField='numviews',
sortOrder='desc', token=None):
'''
Search the portal using the specified query and search parameters.
Optionally provide a token to return results visible to that user.
'''
# Default results are returned by highest
# number of views in descending order.
allResults = []
if not totalResults or totalResults > 100:
numResults = 100
else:
numResults = totalResults
results = __search__(portalUrl, query, numResults, sortField, sortOrder, 0,
token)
if not 'error' in results.keys():
if not totalResults:
totalResults = results['total'] # Return all of the results.
allResults.extend(results['results'])
while (results['nextStart'] > 0 and
results['nextStart'] < totalResults):
# Do some math to ensure it only
# returns the total results requested.
numResults = min(totalResults - results['nextStart'] + 1, 100)
results = __search__(portalUrl=portalUrl, query=query,
numResults=numResults, sortField=sortField,
sortOrder=sortOrder, token=token,
start=results['nextStart'])
allResults.extend(results['results'])
return allResults
else:
print results['error']['message']
return results
def __search__(portalUrl, query=None, numResults=100, sortField='numviews',
sortOrder='desc', start=0, token=None):
'''Retrieve a single page of search results.'''
params = {
'q': query,
'num': numResults,
'sortField': sortField,
'sortOrder': sortOrder,
'f': 'json',
'start': start
}
if token:
# Adding a token provides an authenticated search.
params['token'] = token
request = portal + '/sharing/rest/search?' + urllib.urlencode(params)
results = json.loads(urllib.urlopen(request).read())
return results
def updateWebmapService(webmapId, oldUrl, newUrl, token, portalUrl):
'''Replaces the URL for a specified map service in a web map.'''
try:
params = urllib.urlencode({'token' : token,
'f' : 'json'})
print 'Getting Info for: ' + webmapId
# Get the item data.
reqUrl = (portalUrl + '/sharing/content/items/' + webmapId +
'/data?' + params)
itemDataReq = urllib.urlopen(reqUrl).read()
itemString = str(itemDataReq)
# Find the service URL to be replaced.
if itemString.find(oldUrl) > -1:
newString = itemString.replace(oldUrl, newUrl)
# Get the item's info for the addItem parameters
itemInfoReq = urllib.urlopen(portalUrl +
'/sharing/content/items/' +
webmapId + '?' + params)
itemInfo = json.loads(itemInfoReq.read(),
object_hook=__decodeDict__)
print 'Updating ' + itemInfo['title']
# Post back the changes overwriting the old map
if(itemInfo['ownerFolder'] is not None):
modRequest = urllib.urlopen(portalUrl +
'/sharing/content/users/' +
itemInfo['owner'] +
'/' + itemInfo['ownerFolder'] +
'/items/' + webmapId +
'/update?' + params ,
urllib.urlencode(
{'text' : newString}
))
else:
modRequest = urllib.urlopen(portalUrl +
'/sharing/content/users/' +
itemInfo['owner'] +
'/items/' + webmapId +
'/update?' + params ,
urllib.urlencode(
{'text' : newString}
))
# Evaluate the results to make sure it happened
modResponse = json.loads(modRequest.read())
if modResponse.has_key('error'):
raise AGOPostError(webmapId, modResponse['error']['message'])
else:
print 'Successfully updated the urls'
else:
print 'Didn\'t find any services with ' + oldUrl
except ValueError as e:
print 'Error - no web map specified'
except AGOPostError as e:
print e.webmap
print 'Error updating web map ' + e.webmap + ': ' + e.msg
# Helper functions for decoding the unicode values in the webmap json.
def __decodeDict__(dct):
newdict = {}
for k, v in dct.iteritems():
k = __safeValue__(k)
v = __safeValue__(v)
newdict[k] = v
return newdict
def __safeValue__(inVal):
outVal = inVal
if isinstance(inVal, unicode):
outVal = inVal.encode('utf-8')
elif isinstance(inVal, list):
outVal = __decode_list__(inVal)
return outVal
def __decode_list__(lst):
newList = []
for i in lst:
i = __safeValue__(i)
newList.append(i)
return newList
class AGOPostError(Exception):
def __init__(self, webmap, msg):
print 'ok'
self.webmap = webmap
self.msg = msg
# Run the script.
if __name__ == '__main__':
parser = argparse.ArgumentParser()
parser.add_argument('portal',
help=('url of the Portal (e.g. '
'https://portal.domain.com:7443/arcgis)'))
parser.add_argument('username', help='username')
parser.add_argument('password', help='password')
parser.add_argument('query', help='search string to find content')
parser.add_argument('oldUrl', help='the URL to replace')
parser.add_argument('newUrl', help='the new URL')
# Read the command line arguments.
args = parser.parse_args()
portal = args.portal
username = args.username
password = args.password
query = args.query
oldUrl = args.oldUrl
newUrl = args.newUrl
# Get a token for the source Portal for ArcGIS.
token = generateToken(username=username, password=password,
portalUrl=portal)
# Get a list of the content matching the query.
content = searchPortal(portalUrl=portal,
query=query,
token=token)
for item in content:
if item['type'] == 'Web Map':
updateWebmapService(item['id'], oldUrl, newUrl, token=token,
portalUrl=portal)
print 'Update complete.'
5/10/2014