| 1 | | [[TranslatedPages]] |
| 2 | | = Upload to OSM = |
| 3 | | |
| 4 | | ''Keyboard shortcut:'' CTRL+SHIFT+U |
| 5 | | |
| 6 | | Brings up a dialog box which asks you to confirm your upload of edits to the OSM server. |
| 7 | | |
| 8 | | The dialog box lists all the changes which will be uploaded. |
| 9 | | |
| 10 | | You have the option to proceed with the upload, or to cancel it. |
| 11 | | |
| 12 | | Back to [wiki:Help Main Help] |
| | 1 | [[TranslatedPages(outdated=This page covers too much context. The concept of changeset and upload might be better placed on an own page. Screenshots are outdated and obtain sources is not explained.)]] |
| | 2 | [[PageOutline(1-10,Table of Contents)]] |
| | 3 | |
| | 4 | = File > Upload data = |
| | 5 | |
| | 6 | [[JOSMImage(upload,48,link=,middle,margin-right=20)]] ''Keyboard shortcut:'' **`Ctrl+Shift+↑`** |
| | 7 | |
| | 8 | **Upload new, modified, and deleted objects in the current data layer to the server.** |
| | 9 | |
| | 10 | 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 main database and [osmwww: map at osm.org] and can be used by other members of the OSM community. |
| | 11 | |
| | 12 | |
| | 13 | == In simple words == |
| | 14 | * (like online editors like iD or Potlatch) you need to upload your changes to OSM server. Make sure you connected to server :-) |
| | 15 | * you may encounter [wikitr:/Help/Concepts/Conflict conflicts] after you upload changes (in most cases this means you will have to [wikitr:/Help/Dialog/Conflict#Resolvingdifferencesbetweentags choose what tags to leave on your objects]) |
| | 16 | * to reduce chance of conflict: |
| | 17 | * don't edit data other mappers edit in same time window |
| | 18 | * make your downloads-uploads quicker, so there no overlap between your time-window and theirs |
| | 19 | * (rough idea) to entirely avoid conflict, don't edit objects with same id and don't alter their parent relations (node-way and way-relation and relation-relation). If you (and other editor) are editing disjoint datasets (https://en.wikipedia.org/wiki/Disjoint_sets), then there won't be conflict at all. Please note that it also means that all parent ways and all parent relations should be respected (which is likely to change). |
| | 20 | * (unlike online editors like iD or Potlatch) you don't have to upload immediately (you may [wikitr:/Help/Action/Save save] file manually but [wikitr:/Help/Action/AutoSave auto save] will further assist you) |
| | 21 | * (unlike every other editor?) JOSM will let you upload changes to already opened (but not a closed) changeset (see [#Multipleuploadsintoonechangeset Multiple uploads into one changeset]). Every open changeset will "close" automatically by [osmwww: OSM server] after 1 hour. |
| | 22 | |
| | 23 | == Changesets, upload requests, and upload strategies == |
| | 24 | Geo data contributed to the OSM server consists of [wikitr:/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. |
| | 25 | |
| | 26 | The OSM project calls such a package a **[wikitr:/Help/Concepts/Changeset changeset]**. A **changeset** is a collection of related changes (new objects, object modifications, or object deletions) applied to OSM data. |
| | 27 | |
| | 28 | Changesets are different from **upload requests**. A changeset is a **logical** grouping of [wikitr:/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. |
| | 29 | |
| | 30 | Geo 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, [osmwww: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. |
| | 31 | |
| | 32 | === One upload request into one changeset === |
| | 33 | In the most simple case there is only one upload request into a changeset: |
| | 34 | |
| | 35 | [[Image(one-changeset-one-upload-request.png,link=)]] |
| | 36 | |
| | 37 | This is the standard configuration used by JOSM. It is the preferred configuration |
| | 38 | * for users uploading the result of converting a few GPS traces to OSM geo data |
| | 39 | * for users uploading the result of tracing a few hours over aerial photos |
| | 40 | * for users uploading the result of entering local knowledge about street names, points of interests, etc. |
| | 41 | |
| | 42 | === Multiple uploads into one changeset ===#Multipleuploadsintoonechangeset |
| | 43 | |
| | 44 | [[Image(one-changeset-multiple-upload-request.png,link=)]] |
| | 45 | |
| | 46 | This is an advanced configuration option which most users don't have to enable. It can be useful: |
| | 47 | * for users who map using multiple data layer in JOSM and who want to upload the result of their work into one changeset |
| | 48 | * for users who are working in longer mapping session. For them it could be safer to upload intermediate results to the server than to upload the result of the complete session only. In the former case they can use multiple uploads into one changeset which helps them to safe their data without fragmenting them up in unrelated changesets. |
| | 49 | |
| | 50 | JOSM still supports to upload each object individually. |
| | 51 | |
| | 52 | [[Image(one-changeset-individual-object-upload-request.png,link=)]] |
| | 53 | |
| | 54 | Please note that this is a legacy feature. Until recently, this was the only upload option in OSM. Technically, it uses a slightly different approach to communicate with the OSM server. It is still available in JOSM although the OSM server now supports upload requests with up to 10,000 objects. For the casual and normal user it is almost obsolete. In rare cases, it could be useful for power users. |
| | 55 | |
| | 56 | === Uploading large datasets into multiple changeset === |
| | 57 | JOSM also supports uploading large datasets that don't fit into a single changeset. |
| | 58 | |
| | 59 | [[Image(multiple-changesets.png,link=)]] |
| | 60 | |
| | 61 | This is an advanced option which is only useful for power users. They can select this configuration if they have to upload a dataset with more than 10,000 new, modified, or deleted objects. |
| | 62 | |
| | 63 | |
| | 64 | == Choosing your upload strategy - when and how often to upload == |
| | 65 | There is no simple answer to the question when and how often to upload. You neither should edit the whole day and then upload everything at once nor upload every minute after adding a way. |
| | 66 | |
| | 67 | Here are some rules of thumb: |
| | 68 | |
| | 69 | * **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. |
| | 70 | |
| | 71 | * **Collisions with other mappers**: if you upload 10,000 objects in one request and if the server encounters a problem on the 9,999th object the whole upload is rolled back. The problem has to be fixed first (i.e. by resolving a [wikitr:/Help/Concepts/Conflict conflict]). The whole 10,000 objects will then have to be uploaded again. On the other hand, if you upload 10,000 objects with 10 requests containing 1,000 objects each and the server encounters a problem on the 9,999th object then you only have to repeat the last upload request for the 9,001th to 10,000th objects. Objects 1-9,000 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. |
| | 72 | |
| | 73 | |
| | 74 | == Uploading data ==#UploadData |
| | 75 | |
| | 76 | === Launching the Upload Dialog ===#LaunchUploadDialog |
| | 77 | * ''Keyboard shortcut:'' **`Ctrl+Shift+↑`** |
| | 78 | * Menu item ''File->[[JOSMImage(upload)]] Upload'' |
| | 79 | * Toolbar button [[JOSMImage(upload)]] |
| | 80 | |
| | 81 | === Checks before the Upload Dialog is displayed === |
| | 82 | Before the Upload Dialog is displayed, [wikitr:/Help/Dialog/Validator validator] is run on all modified [wikitr:/Help/Concepts/Object objects]. If it finds warnings or errors you'll be presented with a list of them and get the chance to correct the problems and try again or upload anyway. It's not necessary to fix all of that, but please don't go over it easily, especially not the errors. |
| | 83 | |
| | 84 | JOSM also checks for limitations imposed by the OSM server: |
| | 85 | * tag names and tag values must be shorter than 255 characters |
| | 86 | * ways can't consist of too many nodes |
| | 87 | |
| | 88 | If 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. |
| | 89 | |
| | 90 | **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. |
| | 91 | |
| | 92 | === The Upload Dialog ===#UploadDialog |
| | 93 | |
| | 94 | [[Image(upload-dialog-screenshot.png,link=)]] |
| | 95 | |
| | 96 | since JOSM version 17708, the Upload Dialog is modified: |
| | 97 | |
| | 98 | The Upload Dialog consists of two sections: |
| | 99 | * the left side displays a summary of the objects to be added, to be modified, and to be deleted on the server |
| | 100 | * the right side provides tabs for configuring various aspects of the upload process |
| | 101 | |
| | 102 | When the Upload Dialog is launched it always displays the ''Description'' tab which allows you to enter the most important information about your [wikitr:/Help/Concepts/Changeset changeset]: |
| | 103 | the changeset comment:: |
| | 104 | It's important to provide a brief comment describing the changes you are uploading. This makes it easier for other contributors and for yourself to know what your changes are about and why you made the changes. |
| | 105 | * if the comment is empty or too short: the text below the comment box warns you |
| | 106 | [[Image(comment_empty.png,link=)]] |
| | 107 | * if the comment is provided: the text below the comment thanks you |
| | 108 | [[Image(comment_present.png,link=)]] |
| | 109 | the changeset source:: |
| | 110 | Specify the date source for the changes, to allow other contributors to check them if needed. |
| | 111 | * if the data source is not specified: the text below the comment box warns you |
| | 112 | [[Image(source_not_specified.png,link=)]] |
| | 113 | * if the data source is provided: the text below the comment thanks you |
| | 114 | [[Image(source_provided.png,link=)]] |
| | 115 | |
| | 116 | Below there is a summary of the other upload parameters for this upload. And a checkbox which sets the `review_requested=yes` changeset tag. |
| | 117 | |
| | 118 | === Running a simple upload === |
| | 119 | |
| | 120 | See [wikitr:/Introduction#UploadingtoOSM "Uploading to OSM"]. |
| | 121 | |
| | 122 | === Running an upload with advanced options (Settings tab) ===#AdvancedOptions |
| | 123 | |
| | 124 | ==== Choosing the changeset to upload to ==== |
| | 125 | In the Changeset Configuration Panel you can select what [wikitr:/Help/Concepts/Changeset changeset] the data is uploaded to, see the screenshot below: |
| | 126 | |
| | 127 | [[Image(changeset-config-panel-1_JOSMr18303.png,link=)]] |
| | 128 | |
| | 129 | To upload your data, you can choose from the drop down list ''(since r18283)'': |
| | 130 | * JOSM uploads to a new changeset if [[JOSMImage(dialogs/changesetdialog,24,link=,bottom)]] **New changeset** is selected in the drop down list. This is the standard setting. |
| | 131 | * If you want to upload to an existing changeset you have to select one of the available changesets from the drop down list (they are only available, in the list, if there are open changesets which you can upload data because you own them). Click on [[JOSMImage(dialogs/refresh)]] ''Refresh'' to load the list of available open changesets from the server. |
| | 132 | |
| | 133 | Click on [[JOSMImage(closechangeset,24,link=,bottom)]] **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. |
| | 134 | |
| | 135 | After a successful upload JOSM can either close the changeset used or leave it open for another upload. The default setting is to close it. You can configure whether JOSM should leave it open by unselecting the checkbox **Close changeset after upload**. |
| | 136 | |
| | 137 | ==== Configuring the number and size of upload requests ==== |
| | 138 | JOSM uploads geo data with one or more **upload requests** to a [wikitr:/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: |
| | 139 | |
| | 140 | [[Image(advanced-config-panel.png,link=)]] |
| | 141 | |
| | 142 | 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. |
| | 143 | |
| | 144 | 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. |
| | 145 | |
| | 146 | 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. |
| | 147 | |
| | 148 | **Recommendations** |
| | 149 | * For small (<1,000 objects) to medium upload sizes (<5,000 objects), choose **Upload data in one request** |
| | 150 | * 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. |
| | 151 | * 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. |
| | 152 | |
| | 153 | ==== Adding tags to the changeset ==== |
| | 154 | Geo data uploaded to the OSM server is always uploaded to a [wikitr:/Help/Concepts/Changeset changeset]. Similar to [wikitr:/Help/Concepts/Object nodes, ways, and relations] one can assign [wikitr:/Help/Concepts/Object tags] to a changeset. |
| | 155 | |
| | 156 | In the Upload Dialog one can enter tags in the Tag Configuration Panel, see screenshot below: |
| | 157 | |
| | 158 | [[Image(tags-config-panel-screenshot.png,link=)]] |
| | 159 | |
| | 160 | Hashtags within the changeset comment tag are recognized and are additionally added to the hashtags changeset tag. This behavior can be disabled by setting the key `upload.changeset.hashtags` in the [wikitr:/Help/Preferences/Advanced Advanced preferences] to `false`. |
| | 161 | |
| | 162 | **Do's and Don'ts** |
| | 163 | * Tags are your friends. Use them to describe the geo data you are uploading to the OSM server. |
| | 164 | * 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}}}). |
| | 165 | * You don't have to add your user name to the tags. The link between the changeset and your OSM user account is maintained automatically. |
| | 166 | |
| | 167 | Note that the required upload comment is also a tag. You can either enter it in the Tag Configuration Panel with the key {{{comment}}} or in the Basic Settings Panel in the text input field provided there. |
| | 168 | |
| | 169 | === Running a very large upload === |
| | 170 | An upload is considered to be very large if its size exceeds the maximum size of a changeset on the OSM server. Currently, the upper limit for the size of a changeset is 10,000 objects and if JOSM detects that your upload is bigger it displays the following information in the Upload Dialog: |
| | 171 | |
| | 172 | [[Image(large-upload-basic-settings.png,link=)]] |
| | 173 | |
| | 174 | 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: |
| | 175 | |
| | 176 | [[Image(large-upload-advanced-settings.png,link=)]] |
| | 177 | |
| | 178 | For very large uploads, uploading in one request isn't possible and the respective option is therefore disabled. Please select a chunk size to be used in the upload. It has to be smaller than 10,000, too, because the upper limit for the size of a changeset also applies to the chunk size. You can upload a very large dataset with an individual request per object but you're not recommended to do so. |
| | 179 | |
| | 180 | A very large upload doesn't fit within a single changeset. Please select: |
| | 181 | |
| | 182 | * whether JOSM should automatically open as many new changesets as required to upload the data. Select this option if you want to run a very large upload without user intervention. |
| | 183 | |
| | 184 | * whether JOSM should fill up one changeset and return to the Upload Dialog. Select this option if you want to have full control over the changesets created for the upload. |
| | 185 | |
| | 186 | |
| | 187 | == Error and Warning messages == |
| | 188 | |
| | 189 | === Uploading to a closed changeset ===#ChangesetClosed |
| | 190 | If you upload to an open changeset, the upload may fail because the changeset has been closed in the meantime. It could have been closed by the server because of a timeout (changesets cannot stay open for more than 24 hours and are also closed after an hour of inactivity) or because you closed it explicitly in another JOSM instance. |
| | 191 | |
| | 192 | JOSM displays the following error message: |
| | 193 | |
| | 194 | [[Image(error-dialog-changeset-closed.png,link=)]] |
| | 195 | |
| | 196 | **How to resolve** |
| | 197 | * Launch the Upload Dialog again |
| | 198 | * Select another open changeset or select to upload to a new changeset |
| | 199 | * Upload again |
| | 200 | |
| | 201 | === Changeset becomes full during upload ===#ChangesetFull |
| | 202 | There is an upper limit for the size of changesets. On the OSM server it's currently set to 10,000 objects per changeset. An upload may exceed this limit while uploading, mainly if you are uploading a sequence of upload requests to the same changeset. |
| | 203 | |
| | 204 | If JOSM detects that a changeset became full it displays the following warning message: |
| | 205 | |
| | 206 | [[Image(error-dialog-changeset-full.png,link=)]] |
| | 207 | |
| | 208 | **How to resolve** |
| | 209 | * Click on **Continue Uploading** to continue the upload with as many new changesets as necessary. |
| | 210 | * 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. |
| | 211 | * Click on **Abort** to abort uploading and return to the main map editing interface. |
| | 212 | |
| | 213 | === Deleting nodes that are still in use === |
| | 214 | {{{ |
| | 215 | #!html |
| | 216 | <a name="NodeStillInUseInWay"> |
| | 217 | }}} |
| | 218 | If your upload includes a deleted [wikitr:/Help/Concepts/Object#Nodes node] the OSM server checks if the node is still used in one of the ways known to the server. You have to make sure that the node is ''isolated'' (not part of any way and not referred to by any relation) before it can be deleted. |
| | 219 | |
| | 220 | If the OSM server detects that the node is still in use it replies an error message which JOSM displays as follows: |
| | 221 | |
| | 222 | [[Image(upload-412-node-still-in-use.png,link=)]] |
| | 223 | |
| | 224 | If you click on **Prepare conflict resolution** JOSM supports you in resolving the issue. First it downloads all ways in which the node is still used and merges them with your current dataset. In most cases, JOSM removes the deleted node from all parent ways automatically. If for some reason this isn't possible, JOSM creates a [wikitr:/Help/Concepts/Conflict conflict] which you have to [wikitr:/Help/Concepts/Conflict resolve] manually. |
| | 225 | |
| | 226 | After that, just upload again. Your upload now includes all parent ways of the deleted node and the deleted node is removed from all of them. The upload should therefore succeed. |
| | 227 | |
| | 228 | === bounding box very large === |
| | 229 | If the bounding box of the changeset is very large: JOSM displays an a warning: you can continue by clicking on "Upload Changes" or stop by clicking on "Cancel" and split your changes. |
| | 230 | |
| | 231 | [[Image(error-dialog-large-bounding-box.png,link=)]] |
| | 232 | |
| | 233 | **Note**: The size of the bounding box which is considered as very large can be set in advanced preferences (`upload.max-area` (default is `3.0`)). |
| | 234 | |
| | 235 | == See also == |
| | 236 | * [[JOSMImage(uploadselection)]] [wikitr:/Help/Action/UploadSelection Upload Selection to OSM] |
| | 237 | * [wikitr:/Help/Concepts/Conflict What is a conflict?] |
| | 238 | |
| | 239 | ---- |
| | 240 | Back to [wikitr:/Help/Menu/File Menu File] \\ |
| | 241 | Back to [wikitr:/Help Main Help] |
