Skip to main content

Configure the Studio Web "Geodata Service" for FGDB and LPKX Imports

Updated

VertiGIS Studio Web can be used for importing File Geodatabases (FGDB) and Layer Packages (LPKX). This is enabled by a server-side geoprocessing (GP) service in combination with a Map (Display) Service - both hosted in your ArcGIS Enterprise environment. VertiGIS provides a setup package containing a publishing script to help create and configure these services.

 

Who is affected?

  • Customers that want to use the functionalities for FGDB and LPKX Imports. 

Before you begin

Make sure you have:

  • An ArcGIS Enterprise Portal user with permissions to publish and configure services
  • Access to the ArcGIS Server machine federated with the users Enterprise Portal or a server-side location 
  • A target location for the geodata service workspace accessible by ArcGIS Server
  • Permission to copy the setup package to that location
  • Access to a Python environment 
  • The ArcGIS Server Administrator Directory must be accessible for you

Optional:

  • GP service name

  • Map service name

     

Begin the configuration

Step 1: Download the setup package

Download here

The package contains the publishing script and the dynamic workspace folder that needs to be physically copied to the ArcGIS Server. Do not rename, move or modify internal folders unless instructed by VertiGIS Support.

 

Step 2: Copy the setup package to the ArcGIS Server machine

Copy the complete folder "vgs_geodata_upload" to a location that is accessible by the ArcGIS Server process. You can rename the folder as you like. Copy the path of the location for later usage. Depending on your server setup, this may be a location within or alongside the ArcGIS Server directories.

Important:

  • The folder path must be valid from the server's perspective
  • A path that is valid only on the client machine will not work
  • The folder must remain available after publishing if it is used as the dynamic workspace location

Step 3: Run the publishing script using the required parameters

Running the script might take 2-5 minutes the first time. Run the script from a terminal or command prompt. The command must include the path to the Python executable, the path to the publishing script, and all required parameters.

Example:

"C:/workspace/geodata_upload/publish.py" "C:/Program Files/ArcGIS/Pro/bin/Python/envs/arcgispro-py3/python.exe" --portal_url "https://foo-bar.int.vertigis.com/portal" --workspace_path "C:/arcgis/arcgisserver/directories/vgs_geodata_upload" --username "your_username" --password "your_password"

 

Required parameters:

Name Example Description
path to python exe C:/Program Files/ArcGIS/Pro/bin/Python/envs/arcgispro-py3/python.exe -
path to script C:/workspace/geodata_upload/publish.py -
portal_url https://foo-bar.int.vertigis.com/portal -
workspace_path C:/arcgis/arcgisserver/directories/vgs_geodata_upload -
username   Choose authentication method (A)
password   Choose authentication method (A)
oauth_token   Choose authentication method (B)

 

 Optional Parameters:

Name Example Default
workspace_id ServiceFGDB ServiceFGDB
service_foldername VertiGIS_Utilities VertiGIS_Utilities
service_name_geodata VertiGIS_Convert_Geodata_Tools VertiGIS_Convert_Geodata_Tools
service_name_display VertiGIS_Display_Geodata_Service VertiGIS_Display_Geodata_Service
service_source_geodata service_publish/service_source_geodata/VertiGISGeodataTools.pyt service_publish/service_source_geodata/VertiGISGeodataTools.pyt
service_source_display service_publish/service_source_display/VertiGISGeodataDisplay.aprx service_publish/service_source_display/VertiGISGeodataDisplay.aprx
sharing_level ORGANIZATION, PRIVATE, EVERYONE ORGANIZATION

What the script does

The script automates the publishing and configuration of the required services. It performs the following actions:

  • Checks the Python environment
  • Creates a log file
  • Creates temporary working folders
  • Prepares the Geoprocessing Service resources
  • Publishes the Geoprocessing Service with all required settings
  • Prepares the Display Service
  • Publishes the Display Service
  • Applies the required sharing settings

  • Returns the required service URLs 

     

Step 4: Configure the services in Studio Web

After the script has completed successfully, copy the generated service URLs and configure them using the "Geodata Service". You can find it under "Services" in the App Designer.

Required URLs:

  • Geodata Service URL
  • Display Service URL

You are now able to use these commands:

  • Import from FGDB 
  • Import from LPKX 

You may have to authenticate using required username and password depending on your sharing options selected during publishing. 

 

Step 5: Verify the setup

To verify the setup:

  • Confirm that both services were published successfully in Portal/ArcGIS Server
  • Confirm that the GP service allows uploads
  • Confirm that the Display service is available
  • Confirm that the dynamic workspace points to the intended server-side folder:
    • Open the ArcGIS Server Manager 
    • Open the Service > Capabilities > Show Connection String
  • Configure the URLs in Studio Web
  • Test an upload with a supported FGDB or LPKX file

 

Known limitations

  • Working ArcGIS Enterprise Versions:  10.8.1, 11.1, 11.3, 12
  • Required user permissions: We recommend using an ArcGIS Enterprise administrator account to run the publishing script. Non-administrator accounts may require additional configuration depending on the ArcGIS Enterprise setup.
  • Manual publishing is not documented as the standard workflow
  • No automatic cleanup: Uploaded File Geodatabases and Layer Package files remain in the configured server-side workspace location. Administrators must monitor available storage and remove files manually when needed. 
  • ArcGIS Online-only environments are not supported for this server-side setup, because the workflow requires server-hosted geoprocessing services

 

Current script version: 1.0.0

Related articles

Comments

0 comments

Please sign in to leave a comment.