Create an ArcGIS Data Pipelines Server site

A server site is an individual deployment of ArcGIS Data Pipelines Server and you can federate it with your ArcGIS Enterprise portal.

You can create the site using the ArcGIS Data Pipelines Server configuration wizard or the createsite command line utility.

Use the wizard to create a site

The ArcGIS Data Pipelines Server configuration wizard creates an ArcGIS Data Pipelines Server site on the machine.

1. Open the wizard and click Create Site.

2. Provide a user name and password and click Next.

   Note:

   The primary site administrator account using this user name and password is recognized only by ArcGIS Data Pipelines Server. It's not an operating system account, and it's managed separately from the user accounts in your user store. The primary site administrator has unrestricted access to the ArcGIS Data Pipelines Server site. This account is typically used to create the ArcGIS Data Pipelines Server site and to configure and manage security. The primary site administrator account shouldn't be confused with the ArcGIS Data Pipelines Server account you provided during installation.

3. Type the paths to the directories you want to use for your content directory, workspace directory, and configuration store.

   By default, they are created in <ArcGIS Data Pipelines Server install directory>\arcgisdatapipelinesserver.

   By default, they are created in <ArcGIS Data Pipelines Server install directory>/datapipelines/usr/directories.

   You can use different directories on your local drive or your network for the configuration store, content store, and logs. This location must be accessible to the ArcGIS Data Pipelines Server account, and the account must have read and write permissions to it.

4. Click Next.

5. Review the summary page and click Finish to create your site, or click Back to make changes.

   When your server site has been created, install and configure ArcGIS Web Adaptor.

Use the createsite utility to create a site

Note:

If you installed ArcGIS Data Pipelines Server silently, the command prompt must be closed and reopened before the createsite utility can be used.

After ArcGIS Data Pipelines Server is installed, you can use the createsite command line utility to create a server site. If you use the createsite utility, you have the following options:

• Provide the path to the createsite.properties file that specifies these parameters. This is the recommended option, as it is more secure.

• Run the createsite utility as the ArcGIS Data Pipelines Server account from the command prompt window, specifying the following:

  • User name

  • Password

  • Configuration store location

  • Directory

The configuration store and directory parameters are optional. The utility is located at <ArcGIS Data Pipelines Server install directory>\tools\createsite\createsite.bat.

Note:

If using a UNC path for directories and config-store, you must escape any backslashes \ when designating them. For example, if the path is \\mymachine\config-store, specify \\\\mymachine\\config-store.

The command line parameters for the utility are as follows:

• -u or --username—The user name for the primary site administrator. The user name cannot contain these characters: \:/*?!<>"".

• -p or --password—The password for the primary site administrator. The password cannot contain these characters: \:/*?!<>"".

• -d or --directory—The root server directory. By default, the server directories are created locally, for example, C:\arcgisdatapipelinesserver\directories.

• -c or --configstore—The configuration store for the ArcGIS Data Pipelines Server site. A sample properties file is located in C:\arcgisdatapipelinesserver\config-store.

• -f or --file—The properties file for the createsite utility. By default, the createsite.properties file is located at <ArcGIS Data Pipelines Server installation directory>\tools\createsite.

• -h or --help—Displays the help message and exits.

The command line parameters for the utility are as follows:

• -u or --username—The user name for the primary site administrator. The user name cannot contain these characters: \:/*?!<>"".

• -p or --password—The password for the primary site administrator. The password cannot contain these characters: \:/*?!<>"".

• -d or --directory—The root server directory. By default, the server directories are created locally, for example, <ArcGIS Data Pipelines Server install directory>/datapipelines/usr/directories.

• -c or --configstore—The configuration store for the ArcGIS Data Pipelines Server site. A sample properties file is located in <ArcGIS Data Pipelines Server install directory>/datapipelines/usr/config-store.

• -f or --file—The properties file for the createsite utility. By default, the createsite.properties file is located at <ArcGIS Data Pipelines Server install directory>/datapipelines/tools/createsite.

• -h or --help—Displays the help message and exits.

Specify parameters in the createsite utility

If you're specifying parameters in the utility, run the command with the following syntax: createsite.bat [-u <username>] [-p <password>] [-d <directory>] [-c <config-store>]. The directory and config-store parameters are optional in this command and will use the default locations specified in the command line parameters table.

The following code example demonstrates keeping the default directory and configuration store locations:

<ArcGIS Data Pipelines Server install directory>\tools\createsite\createsite.bat -u PSAusername -p PSApassword

If you're specifying parameters in the utility, run the command with the following syntax: createsite.sh [-u <username>] [-p <password>] [-d <directory>] [-c <config-store>]. The directory and config-store parameters are optional in this command and will use the default locations specified in the command line parameters table.

The following code example demonstrates keeping the default directory and configuration store locations:

<ArcGIS Data Pipelines Server install directory>/datapipelines/tools/createsite/createsite.sh -u PSAusername -p PSApassword

Specify parameters from a createsite.properties file

If you're specifying parameters from a file, run the command to use the createsite.properties file with the following syntax: createsite.bat [-f <filepath>]. A sample template of this file is located in <ArcGIS Data Pipelines Server install directory>\tools\createsite. The file should use the following syntax:

If you're specifying parameters from a file, run the command to use the createsite.properties file with the following syntax: createsite.sh [-f <filepath>]. A sample template of this file is located in <ArcGIS Data Pipelines Server install directory>/datapipelines/tools/createsite. The file should use the following syntax:

# Configuration properties for ArcGIS Data Pipelines Server site creation
#
# User name for primary site administrator.
# Cannot contain these characters: \\/:*?<>"
SERVER_ADMIN_USERNAME =
# Password for primary site administrator.
# Cannot contain these characters: \\/:*?<>"
SERVER_ADMIN_PASSWORD =
# Initially, leave SERVER_ADMIN_PASSWORD_ENCRYPTED set to false.
# When you run the tool the first time, the password will be
# encrypted and SERVER_ADMIN_PASSWORD_ENCRYPTED will change to true.
SERVER_ADMIN_PASSWORD_ENCRYPTED = false
# Root server directory. By default, the server directories will be created locally.
SERVER_DIRECTORIES_PATH =
# Configuration store for the ArcGIS Data Pipelines Server site. By default, the configuration store will be created locally.
SERVER_CONFIGSTORE_PATH =

Each file path referenced in the createsite.properties file adds a second backslash, such as C:\\arcgisdatapipelinesserver\\directories. This is required by the command line utility.

When you run the utility successfully, a message appears before the tool closes indicating that the ArcGIS Data Pipelines Server site was created.

If you want to join additional machines to the site before continuing, see Join additional machines to an ArcGIS Data Pipelines Server site.

After your server site has been created, install and configure ArcGIS Web Adaptor.