{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Metadata for your private data","type":"basic","slug":"metadata-for-private-data","excerpt":"<a name=\"top\"></a>","body":"Files on the Platform are characterised by their content and metadata. The file content is physically stored on cloud storage bucket and is immutable (i.e. it is not possible to edit the content of the file on the Platform).\n\nThe Platform file also contains metadata and may contain tags.  Metadata associated with files makes them searchable, keeping your file collection manageable as it grows. It also enables them to be properly grouped for analyses.\n\n##Overview\n\nOne of the most common reasons for failed tasks is missing or improper metadata. Lack of proper metadata increases the chances that tools and workflows will fail to run correctly. We recommend that you set the metadata fields for your input files before executing analyses on the Platform.  \n\nThere are three ways to enter or change file metadata:\n\n* Using the [visual interface](doc:modify-metadata-using-the-visual-interface)\n* Using the [Command Line Uploader](doc:set-metadata-using-the-command-line-uploader)\n* Using the [API](doc:set-metadata-using-the-api)\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"\\nThe following rules apply for the metadata on the Seven Bridges Platform:\\n\\n  * Maximum number of metadata key-value pairs per file is 1000.\\n  * Maximum length of a metadata key is 100 bytes (UTF-8 encoding).\\n  * Metadata key must not contain characters . and $ .\\n  * Maximum length of a metadata value is 300 bytes (UTF-8 encoding).\\n  * It's not possible to update any metadata value belonging to metadata schema for a Dataset file.\\n  * Metadata and tags can only be set for files. Folders aren't supported.\\n  * Metadata keys and values are treated as case sensitive. \",\n  \"title\": \"Metadata rules\"\n}\n[/block]\n##Metadata categories\n\nThe following metadata categories are available for each of the files:\n\n  * **System metadata** - file attributes which cannot be edited (except for the name attribute). \n  * **Metadata schema** - all available metadata fields that can be specified for the file.\n  * **Custom metadata** - The custom metadata are the key-value pairs that you can define for each of your files. The custom metadata will not be validated on the Platform. The only rules that apply are the metadata rules described above.","updates":["5a54d8f82b04a2001e94bcbd"],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56d0a2be376b040b005b304e","parentDoc":null,"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4","5f894c7d3b0894006477ca01","6176d5bf8f59c6001038c2f7"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":48},"category":{"sync":{"isSync":false,"url":""},"pages":["56d0a2be376b040b005b304e","56d0a2e6376b040b005b3051","56d0ae447c2e100b000af980","56d0b36d40d36e1d00bc145a"],"title":"SET METADATA ASSOCIATED WITH A PRIVATE FILE","slug":"set-metadata-associated-with-a-private-file","order":10,"from_sync":false,"reference":false,"_id":"56d0a2081ecc471500f1795e","createdAt":"2016-02-26T19:05:44.797Z","project":"55faf11ba62ba1170021a9a7","__v":4,"version":"55faf11ba62ba1170021a9aa"},"githubsync":"","__v":48,"user":"554290cd6592e60d00027d17","project":"55faf11ba62ba1170021a9a7","createdAt":"2016-02-26T19:08:46.081Z"}

Metadata for your private data

<a name="top"></a>

Files on the Platform are characterised by their content and metadata. The file content is physically stored on cloud storage bucket and is immutable (i.e. it is not possible to edit the content of the file on the Platform). The Platform file also contains metadata and may contain tags. Metadata associated with files makes them searchable, keeping your file collection manageable as it grows. It also enables them to be properly grouped for analyses. ##Overview One of the most common reasons for failed tasks is missing or improper metadata. Lack of proper metadata increases the chances that tools and workflows will fail to run correctly. We recommend that you set the metadata fields for your input files before executing analyses on the Platform. There are three ways to enter or change file metadata: * Using the [visual interface](doc:modify-metadata-using-the-visual-interface) * Using the [Command Line Uploader](doc:set-metadata-using-the-command-line-uploader) * Using the [API](doc:set-metadata-using-the-api) [block:callout] { "type": "info", "body": "\nThe following rules apply for the metadata on the Seven Bridges Platform:\n\n * Maximum number of metadata key-value pairs per file is 1000.\n * Maximum length of a metadata key is 100 bytes (UTF-8 encoding).\n * Metadata key must not contain characters . and $ .\n * Maximum length of a metadata value is 300 bytes (UTF-8 encoding).\n * It's not possible to update any metadata value belonging to metadata schema for a Dataset file.\n * Metadata and tags can only be set for files. Folders aren't supported.\n * Metadata keys and values are treated as case sensitive. ", "title": "Metadata rules" } [/block] ##Metadata categories The following metadata categories are available for each of the files: * **System metadata** - file attributes which cannot be edited (except for the name attribute).  * **Metadata schema** - all available metadata fields that can be specified for the file. * **Custom metadata** - The custom metadata are the key-value pairs that you can define for each of your files. The custom metadata will not be validated on the Platform. The only rules that apply are the metadata rules described above.