{"_id":"5744b7545ab5ed0e00e33fc1","user":"56703d17e10ecb0d0004eed8","category":{"_id":"5744b218f9c7411700ce560e","project":"54774d9af3736008009e9e0e","version":"56a0bd9e3697d80d002ac5e7","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-05-24T19:57:12.539Z","from_sync":false,"order":12,"slug":"classes","title":"Data Classes"},"parentDoc":null,"project":"54774d9af3736008009e9e0e","__v":48,"version":{"_id":"56a0bd9e3697d80d002ac5e7","project":"54774d9af3736008009e9e0e","__v":20,"createdAt":"2016-01-21T11:14:38.131Z","releaseDate":"2016-01-21T11:14:38.131Z","categories":["56a0bd9f3697d80d002ac5e8","56a0bd9f3697d80d002ac5e9","56a0bd9f3697d80d002ac5ea","56a0bd9f3697d80d002ac5eb","56b098a43a5b810d00745e3f","56b098da8f7a4f0d0029dd10","56d5a8ecf612b80b00fb69cd","570989853ab43c0e0072b2d6","571006aa10300c0e007f6133","5735a52431a73b1700887ca0","5744b0529e045c0e00b7a7a2","5744b1d0b56d431700d8a4fb","5744b1fb55d65a0e00b436e1","5744b218f9c7411700ce560e","5744b220f9c7411700ce560f","5744b2259e045c0e00b7a7a7","5744b22cf8b79f0e00de6a2d","5744b23155d65a0e00b436e4","5744b242c758290e00fbc235","5744b2569e045c0e00b7a7a8","5756a3f2bb92962900dafe3d","57ee23e81e42900e0014a42f","581c822c98676e0f00d240ef"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Sockets","version_clean":"1.1.0","version":"1.1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-24T20:19:32.830Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Data Class permissions\",\n  \"body\": \"This section explains how to Create Data Classes as a Syncano Administrator (which is you). If you'd like your users to be able to interact with Data Classes and their Data Objects, you must make sure to use the correct [Data Class permissions](doc:permissions).\"\n}\n[/block]\n\n# Creating a Data Class from the Dashboard\nTo create a Data Class, you choose the respective instance, and then click  \"Data Classes\" in sidebar as shown below.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/ILPV2S1ESWWZfj5GIuog_Add_class_01.png\",\n        \"Add_class_01.png\",\n        \"1213\",\n        \"622\",\n        \"#26426f\",\n        \"\"\n      ],\n      \"caption\": \"Adding a Data Class\"\n    }\n  ]\n}\n[/block]\nClick the the plus button, add Data Class name and the [schema (field names and types)](doc:classes-data-field-types) to your Data Class.  Additionally you can also add a description, and decide if you you want the field to have `Filter` or `Order` index.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Data Class names are permanent!\",\n  \"body\": \"Once you create a Data Class, the name you used for that class cannot be changed.\"\n}\n[/block]\nFiltering and ordering is explained in detail in the [Data Objects Filtering & Ordering](doc:data-objects-filtering-ordering) chapter.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/b6e3045-add_class.png\",\n        \"add_class.png\",\n        2242,\n        1784,\n        \"#f8f8f8\"\n      ],\n      \"sizing\": \"smart\"\n    }\n  ]\n}\n[/block]\nYou'll see at the top of the creation screen is also a \"Customize\" tab. This allows you to customize the Data Class by changing the icon and the background color. This will make it easier to identify a Data Class within the Dashboard.\n\nAlso remember you can edit the Data Class at any point by clicking the **Edit** button (the three dots) on the right side of the Data Class row as seen below:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/feOMzc13TwGPCWxhmWoj_Screen%20Shot%202016-06-15%20at%2011.27.00%20AM.png\",\n        \"Screen Shot 2016-06-15 at 11.27.00 AM.png\",\n        \"1165\",\n        \"57\",\n        \"#52a4fa\",\n        \"\"\n      ],\n      \"caption\": \"Example Data Class Row\"\n    }\n  ]\n}\n[/block]\n**Read more about [editing a data class here](doc:classes-making-modifications).**\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"index fields limit\",\n  \"body\": \"You can add only 16 fields of type \\\"orderIndex\\\" or \\\"filterIndex\\\". For example: a Data Class schema could contain 10 filter indexes and 6 order indexes (16 in total).\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Learn More\",\n  \"body\": \"For more details about the available methods for Data Classes, visit the [Data Classes API reference](http://docs.syncano.com/v0.1.1/docs/classes-list).\"\n}\n[/block]","excerpt":"In this chapter, you will learn how to create a Class in the Dashboard","slug":"classes-creating-a-class","type":"basic","title":"Creating a Data Class"}

Creating a Data Class

In this chapter, you will learn how to create a Class in the Dashboard

[block:callout] { "type": "warning", "title": "Data Class permissions", "body": "This section explains how to Create Data Classes as a Syncano Administrator (which is you). If you'd like your users to be able to interact with Data Classes and their Data Objects, you must make sure to use the correct [Data Class permissions](doc:permissions)." } [/block] # Creating a Data Class from the Dashboard To create a Data Class, you choose the respective instance, and then click "Data Classes" in sidebar as shown below. [block:image] { "images": [ { "image": [ "https://files.readme.io/ILPV2S1ESWWZfj5GIuog_Add_class_01.png", "Add_class_01.png", "1213", "622", "#26426f", "" ], "caption": "Adding a Data Class" } ] } [/block] Click the the plus button, add Data Class name and the [schema (field names and types)](doc:classes-data-field-types) to your Data Class. Additionally you can also add a description, and decide if you you want the field to have `Filter` or `Order` index. [block:callout] { "type": "warning", "title": "Data Class names are permanent!", "body": "Once you create a Data Class, the name you used for that class cannot be changed." } [/block] Filtering and ordering is explained in detail in the [Data Objects Filtering & Ordering](doc:data-objects-filtering-ordering) chapter. [block:image] { "images": [ { "image": [ "https://files.readme.io/b6e3045-add_class.png", "add_class.png", 2242, 1784, "#f8f8f8" ], "sizing": "smart" } ] } [/block] You'll see at the top of the creation screen is also a "Customize" tab. This allows you to customize the Data Class by changing the icon and the background color. This will make it easier to identify a Data Class within the Dashboard. Also remember you can edit the Data Class at any point by clicking the **Edit** button (the three dots) on the right side of the Data Class row as seen below: [block:image] { "images": [ { "image": [ "https://files.readme.io/feOMzc13TwGPCWxhmWoj_Screen%20Shot%202016-06-15%20at%2011.27.00%20AM.png", "Screen Shot 2016-06-15 at 11.27.00 AM.png", "1165", "57", "#52a4fa", "" ], "caption": "Example Data Class Row" } ] } [/block] **Read more about [editing a data class here](doc:classes-making-modifications).** [block:callout] { "type": "warning", "title": "index fields limit", "body": "You can add only 16 fields of type \"orderIndex\" or \"filterIndex\". For example: a Data Class schema could contain 10 filter indexes and 6 order indexes (16 in total)." } [/block] [block:callout] { "type": "info", "title": "Learn More", "body": "For more details about the available methods for Data Classes, visit the [Data Classes API reference](http://docs.syncano.com/v0.1.1/docs/classes-list)." } [/block]