Most types of resource within the EVRYTHNG Platform can be created, updated, or deleted using the Dashboard instead of (or in conjunction with) the REST API. While this is not a scalable approach to resource management at a large scale, it is useful for testing an integration or increasing your understanding of the platform through experimentation. In some applications, manual object creation may the best option (when managing only a few Thngs in a bespoke manner) but this is usually not the case.
The projects created within an account can be seen from the 'Overview' page, or from the selector at the top of the navigation pane. Creating a new project can be achieved by clicking the '+' icon next to 'Projects', and filling in the appropriate information.
After the project has been created, it should be automatically selected as the active scoping project in the selector at the top of the navigation pane. This determines which resources are visible in other views (i.e: those that belong to the currently selected project). In addition, you can view the generated project ID, activity timestamps, and assign a picture.
Once it is selected, the 'Applications' navigation option will be visible, allowing you to view, create, and update applications scoped within this project. As opposed to a project use case, a Platform application represents a connecting mobile or web app that will make use of Thngs, products, and users.
To create a new application, open the 'Applications' page with a project already selected, then click the 'Add new' button at the top of the page. Fill in the required details as in the case of creating a project.
Once this is done, you will be able to see the ID and API keys associated with the new application. The Application API key ('API key') is for use in an external application manipulating relevant resources and creating Application Users, whereas the Trusted Application API key ('Trusted API key') is a secret key and has access to more endpoints.
Also on the application's summary page are interfaces for the application's authentication providers, Reactor, and Redirector instances. From here you can write or upload a Reactor script or specify Redirector redirection rules as required.
New product types are created from the 'Products' page in the left-hand navigation pane, using the 'Add new' button at the top of the page. From here you can fill in any SKU-level data using the 'Identifiers' and 'Custom Fields' sections.
Once created, the list of products in the scope of the currently selected project will be shown, alongside a total of how many Thng instances of that product exist.
To scope a product to a specific project, select it with its checkbox inside the photo circle, then use the 'Add to project' button. If a product is not part of a given project it will not be visible to it through the API or appear in the relevant views in the Dashboard.
In order to remove a product (or Thng) from a project's scope, the project must first be selected in the navigation panel.
You can also use the 'Filter' button at the top of the page to filter the list of products by ID, name, or tags if required.
Individual Thngs are created via the Dashboard in a very similar way to products - by using 'Add new' button at the top of the 'Thngs' page. Fill in the required details in the same way.
Once a Thng has been created, it can be seen in summary from the 'Thngs' page. In the case that the Thng was created without a project chosen in the navigation pane, selecting the checkbox in the Thng's photo will allow you to retrospectively specify or change the project the Thng should belong to, similar to how you would for a product, using the 'Add to project' button.
New types of actions can be created from the 'Action Types' page, which initially shows the built-in action types available across all projects and accounts.
Use the 'Add new' button at the top of the page to add a new type of action. Fill in the required details, choose an icon, and any tags required. Remember that the 'Name' field must start with an underscore ('_') character.
The page will then list all the built-in actions and additionally any custom ones you have created, showing their IDs, icons, and tags. Similar to the 'Thngs' page, you can also scope custom action types to specific projects from this page.
Collection management occurs in much the same way as the other resource types previously covered. Use the 'Add new' button on the 'Collections' page to create a new collection.
Once the collection has been created, you can view and manage the Thngs and child collections that are associated with a collection. Click the pencil icon and add Thngs or collections as required.
Lastly, you can view action activity associated with the collection using the section at the bottom of the page. Any actions created on this collection will be shown here for analysis.
Use the 'Places' section to manage place resources within an account. Like other resource sections, you can view and filter the complete list here.
Clicking 'Add new' will present a form to add common fields like name, description, and tags, but also specific address fields. There is also a map that can be used to specify an exact location and the coordinates will be filled in automatically when a position on the map is clicked.
The coordinates and address are not linked - updating one will not update the other.
If enabled for your account, the 'Batches' page allows you to view summary and details of any batches in your account. You can apply filters to find specific batches as required. Note, however, that you cannot create any batches or tasks from the Dashboard itself - this must be done through the REST API. See Tasks for more information.
Clicking on a specific batch will show its status history in chronological order, detailing completed Thng-generating or shortID-generating task outcomes and any errors that may have occurred.
Use the 'Create copy' button when selecting multiple Thngs, products, collections, or action types to create complete copies of those resources. You will be asked to input new names for these, or you can accept the default suggestion.
Updated 2 years ago