CINXE.COM

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Setup a Port Job (GUI) | Socrata</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="description" content=""> <meta name="author" content="">  <link href="//netdna.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" rel="stylesheet">  <link href="//netdna.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.css" rel="stylesheet"/>  <link href="//cdn.rawgit.com/noelboss/featherlight/1.3.4/release/featherlight.min.css" rel="stylesheet"/>  <link href="//fonts.googleapis.com/css?family=Ubuntu:bold" rel="stylesheet" type="text/css"/> <link href="//fonts.googleapis.com/css?family=Nobile" rel="stylesheet" type="text/css"/> <link href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.1.0/styles/default.min.css" rel="stylesheet"/>   <link href="/datasync/common/css/common.css" rel="stylesheet"/> <link href="/datasync/common/css/murphy.css" rel="stylesheet"/> <link href="/datasync/css/local.css" rel="stylesheet"/>    <script src="/datasync/common/js/require.js"></script> <script> // Load common code and custom includes requirejs(['/datasync/common/js/common.js'], function(common) { var rel_require = function(script) { if(script.match(/^\/[^\/]/)) { script = '/datasync' + script; } requirejs([script]); }; // Site scripts // Page scripts }); </script>  <link rel="apple-touch-icon-precomposed" sizes="144x144" href="/datasync/common/ico/apple-touch-icon-144-precomposed.png"/> <link rel="apple-touch-icon-precomposed" sizes="114x114" href="/datasync/common/ico/apple-touch-icon-114-precomposed.png"/> <link rel="apple-touch-icon-precomposed" sizes="72x72" href="/datasync/common/ico/apple-touch-icon-72-precomposed.png"/> <link rel="shortcut icon" href="/datasync/common/ico/favicon.png"/>  <link type="application/atom+xml" rel="alternate" href="https://dev.socrata.com/feed.xml" title="Socrata Developer Blog"> </head> <body class="dev homepage setup-port-job">    <div class="navbar navbar-inverse navbar-fixed-top dev" role="navigation">  <div class="navbar-header">  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#nav-collapse"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand dev" href="/datasync/"><i class="fa fa-refresh"></i> Socrata DataSync</a> </div> <div class="collapse navbar-collapse" id="nav-collapse">  <form class="navbar-form navbar-right visible-lg" action="/datasync/search.html" method="GET" role="search"> <div class="form-group"> <input name="q" class="form-control search" type="text" placeholder="Search"> </div> </form>  <ul class="nav navbar-nav"> <li id="socrata-status" style="display: none"> <button type="button" class="btn" data-toggle="popover" data-placement="bottom" data-html="true"></button> </li> <li class="dropdown "> <ul class="dropdown-menu"> <li><a href="/datasync/">Getting Started</a></li> <li class="nav-header dropdown-header">General Guides</li> <li><a href="/datasync/guides/quick-start.html">Quick Start (GUI)</a></li> <li><a href="/datasync/guides/setup-standard-job.html">Setup a Standard Job (GUI)</a></li> <li><a href="/datasync/guides/setup-standard-job-headless.html">Setup a Standard Job (Headlessly)</a></li> <li><a href="/datasync/guides/setup-port-job.html">Setup a Port Job (GUI)</a></li> <li><a href="/datasync/guides/setup-port-job-headless.html">Setup a Port Job (Headlessly)</a></li> <li><a href="/datasync/guides/setup-gis-job.html">Setup a GIS Job (GUI)</a></li> <li><a href="/datasync/guides/setup-gis-job-headless.html">Setup a GIS Job (Headlessly)</a></li> <li class="nav-header dropdown-header">Additional Resources</li> <li><a href="/datasync/resources/control-config.html">Control File Config</a></li> <li><a href="/datasync/resources/preferences-config.html">Preferences Config</a></li> <li><a href="/datasync/resources/schedule-job.html">Scheduling a Job</a></li> <li><a href="/datasync/resources/checking-log.html">Checking Logs</a></li> <li><a href="/datasync/resources/faq-common-problems.html">FAQ / Common Problems</a></li> <li><a href="/datasync/resources/network-considerations.html">Network Considerations</a></li> <li><a href="/datasync/resources/conditions-restrictions.html">Data Conditions & Restrictions</a></li> <li><a href="/datasync/resources/using-map-fields-dialog.html">Using the Map Fields Dialog</a></li> <li class="nav-header dropdown-header">Developer Guides</li> <li><a href="/datasync/guides/datasync-library-sdk.html">DataSync Library/SDK (Java)</a></li> <li><a href="/datasync/guides/compiling-on-windows-eclipse.html">Compiling on Windows (with Eclipse)</a></li> <li><a href="/datasync/guides/compiling-with-maven.html">Compiling with Maven</a></li> </ul> </li> </ul> </div> </div> <div class="container-fluid content"> <h1 id="title">Setup a Port Job (GUI)</h1> <div class="row with-sidebar"> <div class="col-md-3 hidden-phone"> <div class="well sidebar-nav"> <ul class="nav nav-list sidebar "> <li><a href="/datasync/">Getting Started</a></li> <li class="nav-header dropdown-header">General Guides</li> <li><a href="/datasync/guides/quick-start.html">Quick Start (GUI)</a></li> <li><a href="/datasync/guides/setup-standard-job.html">Setup a Standard Job (GUI)</a></li> <li><a href="/datasync/guides/setup-standard-job-headless.html">Setup a Standard Job (Headlessly)</a></li> <li><a href="/datasync/guides/setup-port-job.html">Setup a Port Job (GUI)</a></li> <li><a href="/datasync/guides/setup-port-job-headless.html">Setup a Port Job (Headlessly)</a></li> <li><a href="/datasync/guides/setup-gis-job.html">Setup a GIS Job (GUI)</a></li> <li><a href="/datasync/guides/setup-gis-job-headless.html">Setup a GIS Job (Headlessly)</a></li> <li class="nav-header dropdown-header">Additional Resources</li> <li><a href="/datasync/resources/control-config.html">Control File Config</a></li> <li><a href="/datasync/resources/preferences-config.html">Preferences Config</a></li> <li><a href="/datasync/resources/schedule-job.html">Scheduling a Job</a></li> <li><a href="/datasync/resources/checking-log.html">Checking Logs</a></li> <li><a href="/datasync/resources/faq-common-problems.html">FAQ / Common Problems</a></li> <li><a href="/datasync/resources/network-considerations.html">Network Considerations</a></li> <li><a href="/datasync/resources/conditions-restrictions.html">Data Conditions & Restrictions</a></li> <li><a href="/datasync/resources/using-map-fields-dialog.html">Using the Map Fields Dialog</a></li> <li class="nav-header dropdown-header">Developer Guides</li> <li><a href="/datasync/guides/datasync-library-sdk.html">DataSync Library/SDK (Java)</a></li> <li><a href="/datasync/guides/compiling-on-windows-eclipse.html">Compiling on Windows (with Eclipse)</a></li> <li><a href="/datasync/guides/compiling-with-maven.html">Compiling with Maven</a></li> </ul> </div> </div> <div class="col-md-9"> <p>Port jobs are used for copying datasets that are already on the Socrata platform. Port jobs allow users with publishing rights to copy both dataset schemas (metadata and columns) and data (rows). Port jobs also allow users to port derived views as stand-alone datasets. This guide shows how to setup and run a Port Job using the graphical user interface.</p> <h3 id="step-1-download-datasync">Step 1: Download DataSync</h3> <p>Navigate to the DataSync <a href="https://github.com/socrata/datasync/releases">download page</a>, and download the latest version.</p> <h3 id="step-2-launching-datasync">Step 2: Launching DataSync</h3> <p>Launch DataSync navigating to the folder containing the Datasync JAR file that you downloaded previously and either double-click the jar or run the following command:</p> <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>java -jar <DATASYNC_JAR> </code></pre></div></div> <h3 id="step-3-create-a-new-port-job">Step 3: Create a new Port Job.</h3> <p>In the DataSync UI go to <code class="language-plaintext highlighter-rouge">File -> New... -> Port Job</code>. This will open up a new Port Job.</p> <h3 id="step-4-enter-authentication-details">Step 4: Enter authentication details</h3> <p>Enter your authentication details at the bottom left of DataSync (domain, username, password, and app token). The domain is the root domain of the data site hosting the dataset you wish to port. It must begin with https:// (i.e. <a href="https://data.cityofchicago.org">https://data.cityofchicago.org</a>). The username and password are those of a Socrata account that has a Publisher role. Enter your App token. If you do not yet have an app token, please see <a href="http://dev.socrata.com/docs/app-tokens.html">how to obtain an App token</a>. The username, password and application token will be saved as part of the job configuration. We recommend creating a dedicated Socrata account (with a Publisher role or Owner permissions to specific datasets) to use with DataSync rather than tying DataSync to a particular person鈥檚 account.</p> <p><strong>NOTICE:</strong> DataSync stores the authentication details unencrypted in the Registry on Windows platforms (in the following location: HKEY_CURRENT_USER\Software\JavaSoft\Prefs) and in analogous locations on Mac and Linux. If you are concerned about this as a potential security issue you may want to look into alternative publishing methods. Please contact support if you have questions.</p> <h3 id="step-5--configure-the-port-job">Step 5: Configure the Port Job.</h3> <p>The configurable options to run a Port Job are:</p> <ul> <li><em>Port Method</em>: Choose one of the following: <ol> <li><code class="language-plaintext highlighter-rouge">Copy schema only</code>: This will copy the metadata and columns of the source dataset into a new dataset. No row data is copied over.</li> <li><code class="language-plaintext highlighter-rouge">Copy schema and data</code>: This copies both the metadata/column info and all row data, effectively making a duplicate of the source dataset.</li> <li><code class="language-plaintext highlighter-rouge">Copy data only</code>: This copies the row data from the source dataset into the destination dataset. The effect on the destination dataset is determined by the <code class="language-plaintext highlighter-rouge">Publish Method</code> option below. Please note, this option will only succeed if the schemas of the source and destination dataset agree.</li> </ol> </li> <li> <p><em>Source Domain</em>: The domain to which the source dataset belongs.</p> </li> <li> <p><em>Source Dataset ID</em>: The <a href="http://socrata.github.io/datasync/resources/fac-common-problems.html#what-is-the-id-of-my-dataset">dataset identifier</a> of the source dataset.</p> </li> <li> <p><em>Destination Domain</em>: The domain where the source dataset will be copied to</p> </li> <li> <p><em>Destination Dataset ID</em>: The <a href="http://socrata.github.io/datasync/resources/fac-common-problems.html#what-is-the-id-of-my-dataset">dataset identifier</a> of the destination dataset. This is only needed if selecting <code class="language-plaintext highlighter-rouge">Copy data only</code> as the PortMethod.</p> </li> <li><em>Publish Method</em>: Only relevant if selecting <code class="language-plaintext highlighter-rouge">Copy data only</code> as the PortMethod. Choose one of the following: <ol> <li><code class="language-plaintext highlighter-rouge">upsert</code>: This will upsert the data from the source dataset into the destination dataset, updating rows that exist already, inserting those that do not.</li> <li><code class="language-plaintext highlighter-rouge">replace</code>: This will replace the data in the destination dataset with that in the source dataset.</li> </ol> </li> <li><em>Publish Destination Dataset</em>: Only relevant if copying the schema via <code class="language-plaintext highlighter-rouge">Copy schema only</code> or <code class="language-plaintext highlighter-rouge">Copy schema and data</code> as the PortMethod. Choose one of the following: <ol> <li><code class="language-plaintext highlighter-rouge">Yes</code>: This will publish the destination dataset to complete the Port Job.</li> <li><code class="language-plaintext highlighter-rouge">No</code>, create a working copy: This will leave the destination dataset as a working copy.</li> </ol> </li> </ul> <h3 id="step-6--run-save-and-schedule-the-job">Step 6: Run, save and schedule the Job.</h3> <p>Once your job is setup, you can run it like any other job. For more details, please see steps 4 and 5 of the <a href="/datasync/guides/setup-standard-job.html">Setting up a Standard Job (GUI)</a> Guide.</p> <div class="related-pages"></div> </div> </div> <footer class="muted"> <hr /> <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/deed.en_US"> <img alt="Creative Commons License" src="https://licensebuttons.net/l/by-nc-sa/3.0/80x15.png" /> </a> Licensed by <a xmlns:cc="http://creativecommons.org/ns#" href="http://www.socrata.com" property="cc:attributionName" rel="cc:attributionURL">Socrata</a> under <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/deed.en_US">CC BY-NC-SA 3.0</a>. Learn how <a href="/datasync/contributing.html">you can contribute!</a> </footer> </div>  </body> </html>