EachScape

Write into Cloud Collection from an App

Introduction
In this tutorial we show how to use the Remote Query to write into a Cloud Collection from an app.
 

You MUST authorize your app to write into your Cloud Collection. See how.

Tip: If you are familiar with Web Services, know that Cloud Collection are accessible through the Cloud Collection API.

Note: 
 Cloud Collection is accessible through a RESTful web service. Meaning this Tutorial can be extended to the use of any web service. The Remote Query uses RESTful, that means you can store content in a any CMS, not solely EachScape Cloud Collection.  

Install the Demo

Install the Tutorial App "WRITE IN CLOUD COLLECTION"

The App

This Tutorial app allows a user to enter text then store that text into a Cloud Collection.

It uses

• Text Input Block
• A simple Text Block used as a 'Submit' button
• A list block to load Cloud Collection Data.
• Most importantly: The Remote Query Block to write into the Collection.

Writing into the Collection

  App Screenshot

This a screenshot of the View 'Enter Text'

Remote Query write into the Collection using the RESTful protocol

FIRST: You need to create a key to be able to write into that Cloud Collection.

SECOND: You need to use that key (api_key) as a parameter in the Query Block . This lets the app authenticate itself with that collection.

Query Block on the Remote Query Layer

• URL The call to the cloud collection.
  • The default value in the URL field is the URL used for any Cloud Collection.
  • If you are using a different service than the EachScape Cloud Collection then remove that URL and enter the one pointing to your web services.

• Fields #1you have to configure that field with the API KEY:  
  • Name: You have to enter 'api_key' in the Name field.
    • Tech Note: This is the name of the parameter you are passing to the end point. 
  • Value: The unique api_key you generated from your cloud collection. Copy paste the value in that field. It uniquely identify your app and authorize your app to write in that collection.

• Fields #2The text value to update in the Collection
  • Name: Enter the EXACT name of the column of the cloud collection using the following format:
    • values[EXACT name of the column] 
    • For example, for a column named 'Name' the syntax would be
      • values[Name]
      • (see screenshot above for example)
  • Value: The value to be saved to the column specified in Name. In our case that value in the variable from the Text input block.
    • [[var: VAR_Name]]
    • That variable comes from the Editor you can pick it from the 'Variable' section.

• Fields #N...  In this Tutorial we only use one field to save one variable. 
  • You can use up to 28 fiels in a Remote Query 
  • The set up is the same as above for each new field.

TIP

When your column name have more than one word, for example "My Column Name"

enters the name in Remote Query Block exactly as you see it in your collection:

Additional Settings for Remote Query

• "Status Code Key" 
• "Status Reason Key"

These will be set as Variable values of the status of the server when the app communicates with it.

• Success
• Failure
• No Response.

App success screen.

At that point, if you go to the Cloud Collection (or reload the page if you were already on) you will see the name 'John Doe' previously entered stored in the Collection:

Screenshot of the Cloud Collection updated with new content from the app

Similarly if you select the 'See List from Cloud Collection' in the app
the app will display the newly updated Cloud Collection

Reminder

Reminder of the settings of the Remote Query in Studio