Changes between Version 37 and Version 38 of Help/Action/Upload


Ignore:
Timestamp:
2011-12-16T15:29:05+01:00 (14 years ago)
Author:
skyper
Comment:

shortcut + syntax

Legend:

Unmodified
Added
Removed
Modified
  • Help/Action/Upload

    v37 v38  
    33= File > Upload to OSM =
    44
    5 [[Image(source:/trunk/images/upload.png)]]  ''Keyboard shortcut:'' '''{{{Ctrl-Shift-U}}}'''
    6 
    7 '''Upload new, modified, and deleted objects in the current data layer to the server.'''
    8 
    9 Geo data edited in JOSM is only available locally and only usable by the user who entered the data unless the user decides to make it available to the community too. In order to publish data the user has to '''upload''' it. Uploading means that the geo data is transferred to a central server run by the OSM community where it is integrated with geo data from other mappers in a central database. It's by uploading data that locally edited geo data both becomes part of the [http://www.openstreetmap.org public maps] and can be used by other members of the OSM community.
     5[[Image(source:trunk/images/upload.png)]]  ''Keyboard shortcut:'' **{{{Ctrl+Shift+U}}}**
     6
     7**Upload new, modified, and deleted objects in the current data layer to the server.**
     8
     9Geo data edited in JOSM is only available locally and only usable by the user who entered the data unless the user decides to make it available to the community too. In order to publish data the user has to **upload** it. Uploading means that the geo data is transferred to a central server run by the OSM community where it is integrated with geo data from other mappers in a central database. It's by uploading data that locally edited geo data both becomes part of the [http://www.openstreetmap.org public maps] and can be used by other members of the OSM community.
    1010
    1111{{{
     
    2121Geo data contributed to the OSM server consists of [wiki:/Help/Concepts/Object nodes, ways, and relations]. Because there are hundreds of mappers publishing their geo data on the OSM server it is important to track who published what data in which context. It would be tedious for mappers to describe why every single node and every single way is published. A more convenient approach is to package a group of related objects and assign the package itself a comment, instead of the individual objects.
    2222
    23 The OSM project calls such a package a '''[wiki:/Help/Concepts/Changeset changeset]'''. A '''changeset''' is a collection of related changes (new objects, object modifications, or object deletions) applied to OSM data.
    24 
    25 Changesets are different from '''upload requests'''. A changeset is a '''logical''' grouping of [wiki:/Help/Concepts/Object objects], whereas an upload request is a '''technical grouping''' for transferring geo data to the central OSM server only. In JOSM we say, that objects are uploaded '''using''' upload requests '''to''' a changeset. The JOSM Upload Dialog allows aspects of the upload requests and changeset objects to be configured. Some of the settings are compulsory (i.e. the user has to configure them before geo data can be uploaded) but most of them are optional and JOSM works with reasonable default values.
     23The OSM project calls such a package a **[wiki:/Help/Concepts/Changeset changeset]**. A **changeset** is a collection of related changes (new objects, object modifications, or object deletions) applied to OSM data.
     24
     25Changesets are different from **upload requests**. A changeset is a **logical** grouping of [wiki:/Help/Concepts/Object objects], whereas an upload request is a **technical grouping** for transferring geo data to the central OSM server only. In JOSM we say, that objects are uploaded **using** upload requests **to** a changeset. The JOSM Upload Dialog allows aspects of the upload requests and changeset objects to be configured. Some of the settings are compulsory (i.e. the user has to configure them before geo data can be uploaded) but most of them are optional and JOSM works with reasonable default values.
    2626
    2727Geo data can be retrieved later via the changeset it was uploaded to, though it can't be retrieved by the upload request used. Changesets have a unique identifier, upload requests have not. For instance, [http://www.openstreetmap.org/browse/changeset/3274448 this changeset] includes geo data from tracing over orthofotos of the city of Bern, Switzerland. It isn't possible, though, to see the upload requests that were used to fill it.
     
    6363Here are some rules of thumb:
    6464
    65  * '''Time required to upload''': the smaller the upload requests you choose the longer it takes to upload. It takes more time to upload 100 objects using 100 individual upload requests than to upload them in one request containing 100 objects.
    66 
    67  * '''Collisions with other mappers''': if you upload 30,000 objects in one request and if the server encounters a problem on the 29,999th object the whole upload is rolled back. The problem has to be fixed first (i.e. by resolving a [wiki:/Help/Concepts/Conflict conflict]). The whole 30,000 objects will then have to be uploaded again. On the other hand, if you upload 30,000 objects with 10 requests containing 1,000 objects each and the server encounters a problem on the 29,999th object then you only have to repeat the last upload request for the 29,000th to 30,000th objects. Objects 1-28,999 are already successfully uploaded. If you're mapping in areas where other mappers are active too you should therefore prefer smaller sizes for upload requests.
     65 * **Time required to upload**: the smaller the upload requests you choose the longer it takes to upload. It takes more time to upload 100 objects using 100 individual upload requests than to upload them in one request containing 100 objects.
     66
     67 * **Collisions with other mappers**: if you upload 30,000 objects in one request and if the server encounters a problem on the 29,999th object the whole upload is rolled back. The problem has to be fixed first (i.e. by resolving a [wiki:/Help/Concepts/Conflict conflict]). The whole 30,000 objects will then have to be uploaded again. On the other hand, if you upload 30,000 objects with 10 requests containing 1,000 objects each and the server encounters a problem on the 29,999th object then you only have to repeat the last upload request for the 29,000th to 30,000th objects. Objects 1-28,999 are already successfully uploaded. If you're mapping in areas where other mappers are active too you should therefore prefer smaller sizes for upload requests.
    6868
    6969== Uploading data  ==
     
    7171=== Launching the Upload Dialog ===#LaunchUploadDialog
    7272
    73  * ''Keyboard shortcut:'' CTRL+SHIFT+U
     73 * ''Keyboard shortcut:'' **{{{Ctrl+Shift+U}}}**
    7474 * Menu item ''File->[[Image(source:/trunk/images/upload.png)]] Upload''
    7575 * Toolbar button [[Image(source:/trunk/images/upload.png)]]
     
    8484If the objects you're uploading have cyclic dependencies (relation 1 refers to relation 2, relation 2 refers to relation 3, relation 3 refers to relation 1) JOSM can't upload them. JOSM will ask you to break up these dependencies first.
    8585
    86 '''Note''': On large datasets these checks can take some time and for the time being they don't provide user feedback. Please be patient if it takes a couple of seconds to launch the Upload Dialog on large datasets. This will be fixed soon.
     86**Note**: On large datasets these checks can take some time and for the time being they don't provide user feedback. Please be patient if it takes a couple of seconds to launch the Upload Dialog on large datasets. This will be fixed soon.
    8787
    8888=== The Upload Dialog ===
     
    9999
    100100 1. [wiki:/Help/Action/Upload#LaunchUploadDialog Launch]  the Upload Dialog
    101  2. Enter an upload comment. You '''must''' provide an upload comment of at least 3 characters.
    102  3. Click on [[Image(source:/trunk/images/upload.png)]]'''Upload Changes'''
     101 2. Enter an upload comment. You **must** provide an upload comment of at least 3 characters.
     102 3. Click on [[Image(source:/trunk/images/upload.png)]]**Upload Changes**
    103103
    104104=== Running an upload with advanced options ===
     
    111111[[Image(tags-config-panel-screenshot.png)]]
    112112
    113 '''Do's and Don'ts'''
     113**Do's and Don'ts**
    114114 * Tags are your friends. Use them to describe the geo data you are uploading to the OSM server.
    115115 * Use the tag {{{source}}} to describe the source of your geo data (examples: {{{traced from Yahoo Imagery}}}, {{{based on GPS traces and surveyed by bike}}}).
     
    125125JOSM uploads to a new changeset if '''Upload to a new changeset''' is selected. This is the standard setting.
    126126
    127 If you want to upload to an existing changeset you have to select one of the available changesets from the drop down list. This list is only enabled if there are open changesets which you can upload data to because you own them. Click on [[Image(source:/trunk/images/dialogs/refresh.png)]] ''Refresh'' to load the list of available open changesets from the server. If there is at least one open changeset available you can select the radio button '''Upload to an existing changeset''' and select a changeset.
     127If you want to upload to an existing changeset you have to select one of the available changesets from the drop down list. This list is only enabled if there are open changesets which you can upload data to because you own them. Click on [[Image(source:/trunk/images/dialogs/refresh.png)]] ''Refresh'' to load the list of available open changesets from the server. If there is at least one open changeset available you can select the radio button **Upload to an existing changeset** and select a changeset.
    128128
    129129Click on [[Image(source:/trunk/images/closechangeset.png)]]''Close Changeset'' to close the currently selected open changeset. This is for convenience only. You don't have to close a changeset here in order to run a successful upload.
     
    133133
    134134==== Configuring the number and size of upload requests ====
    135 JOSM uploads geo data with one or more '''upload requests''' to a [wiki:/Help/Concepts/Changeset changeset] on the OSM server. In the Advanced Configuration Panel you can decide about the number and the size of upload requests, see screenshot:
     135JOSM uploads geo data with one or more **upload requests** to a [wiki:/Help/Concepts/Changeset changeset] on the OSM server. In the Advanced Configuration Panel you can decide about the number and the size of upload requests, see screenshot:
    136136
    137137[[Image(advanced-config-panel.png)]]
    138138
    139 Select '''Upload data in one request''' to upload all object in one request. If you're uploading a medium to large number of objects this might take some time and JOSM will not be able to inform you about the progress. There are only two outcomes of such an upload: the upload either succeeded or it didn't. In the former case everything is fine, in the later no objects at all have been uploaded. This kind of upload will never lead to a partial upload which is both its strength and its weakness. It can be its weakness if the entire upload fails because there is a problem in the very last object in the upload request.
    140 
    141 Select '''Upload data in chunks of objects''' to upload the objects in a sequence of requests with a predefined size. You can enter a preferred size for an upload request (called the "chunk size"). Depending on its value JOSM will submit a number of upload requests (the number is displayed on the right of the input field for the "chunk size"). In contrast to the former option, every upload of a chunk can either succeed or fail. You will get some coarse grained progress feedback because JOSM will inform you when an individual chunk has been uploaded successfully or when its upload has failed. Uploading in chunks is in most cases slower than uploading in one requests, though.
    142 
    143 Select '''Upload each object individually''' to upload each object with an individual upload request. You will get very fine grained progress feedback because JOSM will inform you when an individual object was uploaded successfully or when its upload has failed. Note that this option is in most cases the slowest option.
    144 
    145 '''Recommendations'''
    146  * For small (<1,000 objects) to medium upload sizes (<5,000 objects), choose '''Upload data in one request'''
    147  * For medium to large upload sizes (> 5,000 objects) choose '''Upload data in chunks of objects'''. A chunk size of 1,000 is a good value to start with.
    148  * Don't use '''Upload each object individually''' unless you have a specific reason to do so. This is basically a legacy strategy from former versions of the OSM server.
     139Select **Upload data in one request** to upload all object in one request. If you're uploading a medium to large number of objects this might take some time and JOSM will not be able to inform you about the progress. There are only two outcomes of such an upload: the upload either succeeded or it didn't. In the former case everything is fine, in the later no objects at all have been uploaded. This kind of upload will never lead to a partial upload which is both its strength and its weakness. It can be its weakness if the entire upload fails because there is a problem in the very last object in the upload request.
     140
     141Select **Upload data in chunks of objects** to upload the objects in a sequence of requests with a predefined size. You can enter a preferred size for an upload request (called the "chunk size"). Depending on its value JOSM will submit a number of upload requests (the number is displayed on the right of the input field for the "chunk size"). In contrast to the former option, every upload of a chunk can either succeed or fail. You will get some coarse grained progress feedback because JOSM will inform you when an individual chunk has been uploaded successfully or when its upload has failed. Uploading in chunks is in most cases slower than uploading in one requests, though.
     142
     143Select **Upload each object individually** to upload each object with an individual upload request. You will get very fine grained progress feedback because JOSM will inform you when an individual object was uploaded successfully or when its upload has failed. Note that this option is in most cases the slowest option.
     144
     145**Recommendations**
     146 * For small (<1,000 objects) to medium upload sizes (<5,000 objects), choose **Upload data in one request**
     147 * For medium to large upload sizes (> 5,000 objects) choose **Upload data in chunks of objects**. A chunk size of 1,000 is a good value to start with.
     148 * Don't use **Upload each object individually** unless you have a specific reason to do so. This is basically a legacy strategy from former versions of the OSM server.
    149149
    150150=== Running a very large upload ===
     
    153153[[Image(large-upload-basic-settings.png)]]
    154154
    155 The warning message indicates that JOSM can't upload the data unless you configure some advanced settings. Either switch to the tab '''Advanced''' or click on the link in the message. The following configuration panel will be displayed:
     155The warning message indicates that JOSM can't upload the data unless you configure some advanced settings. Either switch to the tab **Advanced** or click on the link in the message. The following configuration panel will be displayed:
    156156
    157157[[Image(large-upload-advanced-settings.png)]]
     
    174174[[Image(error-dialog-changeset-closed.png)]]
    175175
    176 '''How to resolve'''
     176**How to resolve**
    177177 * Launch the Upload Dialog again
    178178 * Select another open changeset or select to upload to a new changeset
     
    186186[[Image(error-dialog-changeset-full.png)]]
    187187
    188 '''How to resolve'''
    189  * Click on '''Continue Uploading''' to continue the upload with as many new changesets as necessary.
    190  * Click on '''Go back to Upload Dialog''' to go back to the upload dialog. There you can select another changeset to upload the remaining objects to.
    191  * Click on '''Abort''' to abort uploading and return to the main map editing interface.
     188**How to resolve**
     189 * Click on **Continue Uploading** to continue the upload with as many new changesets as necessary.
     190 * Click on **Go back to Upload Dialog** to go back to the upload dialog. There you can select another changeset to upload the remaining objects to.
     191 * Click on **Abort** to abort uploading and return to the main map editing interface.
    192192
    193193