AddDataStoreItem (arcpy)
Top
Summary
Registers a folder or database with an ArcGIS Server site. See About registering
your data with the server to learn more about when and why you should register
your data.
Discussion
See About registering your data with the server to learn more about when and
why you should register your data with ArcGIS Server.
Syntax
AddDataStoreItem (connection_file, datastore_type, connection_name,
server_path, {client_path}, {hostname})
An ArcGIS Server connection file (.ags) representing the server
with which you want to register the data. If you've made a
connection in ArcCatalog you can use the connection file found in
your user profile directory. Alternatively, you can create a
connection file from scratch using the
functionCreateGISServerConnectionFile.
The type of data being registered.
DATABASE —The data resides in an enterprise database.
FOLDER —The data is file-based.
A name for this folder or database that publishers or
administrators will see when they view the server properties.
The path or connection to the data as seen by the server.
If you are registering a DATABASE, this is either the path to a
database connection file (.sde) or a string containing the database
connection parameters. See Database connections in ArcGIS
Desktop to learn how to obtain this file or string.
If you are registering a FOLDER, this is the path to the folder.
The path or connection to the data as seen by the publisher's
machine, if different from the information used by the server. In
some cases the publisher and the server may be referencing
physically distinct databases or folders. When you provide the
publisher path and the server path, ArcGIS Server automatically
corrects the paths at publish time when your map documents and
other resources are transferred to the server.
If you are registering a DATABASE, provide either the path to a
database connection file (.sde) or a string containing the database
connection parameters. See Database connections in ArcGIS
Desktop to learn how to obtain this file or string.
If you are registering a FOLDER, provide the path to the folder.
If you are registering ArcGIS Server's Managed Database, do not
provide a path; instead, provide the string managed for this
parameter. ArcGIS Server's Managed Database is an enterprise
geodatabase you designate where data can be copied at publish
time if a user attempts to publish a feature service from an
unregistered data location. See Copying data to the server
automatically when publishing to learn more.
The name of the publisher or client machine that will use this
registered folder or database. If left blank, the name of the
machine running the script will be used.
Return Value
If successful, returns the string "Success".
Code Sample
Register a folder used by both the server and publisher
Registers a local folder C:\temp with ArcGIS Server. Assumes that a connection
to the server has been created in the Catalog window of ArcMap and renamed
MyConnection.
import arcpy
conn = "GIS Servers/MyConnection.ags"
path = "c:/temp"
arcpy.AddDataStoreItem(conn, "FOLDER", "My local data folder", path,
path)
Register a folder that differs between the server and publisher
Registers a shared folder \\MYSERVER\mydata\Washington with the server,
with the local folder C:\mydata\Washington being used by the publisher.
import arcpy
conn = "c:/connections/MYSERVER.ags"
arcpy.AddDataStoreItem(conn, "FOLDER", "Washington",
"//MYSERVER/mydata/Washington",
"c:/mydata/Washington", "MYPUBLISHER")
Continued on next page.
