New function to read and save data to a remote DataEase Server and other Web Services.

Remote

Function::Internal

retval := Remote(commandstring)

retval := Remote(commandstring, input)

retval := Remote(commandstring, input, output)

Used to do commands on a remote web server or organize in memory structures.

Parameters

commandstring : Text

This can be all from a sequence used to log in, a returned field that we already have fetched using a previous call to Remote or setting a value to a empty object or update existing object. All commands starts with a @commandname:. If not a @ if the first char in the command string, the meaning is either a data fetch and return or a data set. A data fetch is characterized bu being a string without any = in. A data set is a string with a = in. The name fetched or set can be a single name, an object where you use dot notation or an array where you use [index] notation. When you fetch data, you can also transform of fetch part of the data by using a filter. The filter is recognized by a |.

Example of notation

Returns/Result

String with asked for field, empty string or in error situation the error string.

Commands

Filters

Filters that can be used when fetching values. At the moment most of the filters only work on mail data stored in the mime store in the variable mail or mails[]. All filters are set by using the | character before the filter value. A filter can also have parameters like the attachment and attachmentname. Then the the filter have the form |attacment 1 where the parameter is separated from the filter by a space.

Examples

Examples not using a server:

To understand how to use the Remote data store, we will do a few examples without calling a server in the first examples. First we will show how to set a named datastore. All settings done to a named data store is maintaned in memory until you close down DataEase or use the @cleanup command. To set up a new datastore, you use the @current:name command. This will switch to an existing datastore if it exist or create a new. In the next example we will create "mydata" datastore and create a field direct on the root object called "myvalue", an array called "data" with 10 objects, and 2 field in each object called "Name" and "Code". Then we pick the 6th element in the array and return it.

-- The DQL define temp "Dummy" text. define temp "telle" number. define temp "cname" text. define temp "ccode" text. Dummy := Remote("@current:mydata"). Dummy := Remote("myvalue=a value"). telle := 0 . while telle < 10 do     Dummy := Remote(concat("data[", telle , "].Name=Name", telle)) .     Dummy := Remote(concat("data[", telle , "].Code=C", telle)) .     telle := telle + 1 . end cname := Remote("data[5].Name") . ccode := Remote("data[5].Code") . list records     cname ;     ccode . -- The body ***************************************************** Test of creating a json structure in memory only ***************************************************** .items Code: [{ccode}] Name: [{cname}] .end ***************************************************** -- The result ***************************************************** Test of creating a json structure in memory only ***************************************************** Code: C5 Name: Name5 ***************************************************** 

Create an string array and read values back form it. In this example we do not use field names inside the array, but just set a string value direct into the array. This is never used in the DataEase server, but can be useful when connecting to other kinds of server like mail server. We also added a @cleanup command to start on a fresh datastore. This is useful if you reuse your datastore name.

-- The DQL define temp "Dummy" text. define temp "telle" number. define temp "cname" text. define temp "ccode" text. Dummy := Remote("@current:mydata"). Dummy := Remote("@cleanup"). telle := 0 . while telle < 10 do     Dummy := Remote(concat("data[", telle , "]=Name", telle)) .     Dummy := Remote(concat("data2[", telle , "]=C", telle)) .     telle := telle + 1 . end cname := Remote("data[5]") . ccode := Remote("data2[5]") . list records     cname ;     ccode . -- The body ***************************************************** Test of creating a json string array in memory ***************************************************** .items Code: [{ccode}] Name: [{cname}] .end ***************************************************** -- The result ***************************************************** Test of creating a json string array in memory ***************************************************** Code: C5 Name: Name5 ***************************************************** 

This concludes the section where you use the Remote command without calling a server. In the next section you will need a server to use.

Examples with data on remote server:

For the examples I use a Contact table where you have a first_name, last_name, title, and email field. I have created a DG3 page that have a fixed filter

email=[{ user.email }] that connects the logged in user to the record data by the registered email. To use the page for Remote, you just add a query string q.action=getrecord to the url and sets the action to updaterecord when you save the changed data back to the server. Here are the example of how to do it.

Login and show the registered values on the contact.

-- The DQL define temp "Dummy" text. define temp "fname" text. define temp "lname" text. define temp "email" text. define temp "title" text. define temp "dob" text. Dummy := Remote("@current:mydata"). Dummy := Remote("@connect:127.0.0.1:8080/licensecheck/editcontact/"). Dummy := Remote( "@login:username/password"). Dummy := Remote("@query:q.action=getrecord"). Dummy := Remote( "@get") . fname := Remote( "recorddata.first_name") . lname := Remote( "recorddata.last_name") . email := Remote( "recorddata.email") . title := Remote( "recorddata.title") . dob := Remote( "recorddata.dob") . list records     fname ;     lname ;     email ;     title ;     dob . -- The Body ***************************************************** Get my contact info ***************************************************** .items Name:[{fname}] [{lname}] EMail:[{email}] Title:[{title}] Day of birth:[{dob}] .end ***************************************************** -- The result if you have a valid login ***************************************************** Get my contact info ***************************************************** Name:Test User EMail:test@example.com Title: Day of birth:17.08.67 ***************************************************** 

Get a record and update it with new values. This routine simply toggles the title form blank to "The Master" each time it is called and return the result.

-- The DQL used define temp "Dummy" text. define temp "fname" text. define temp "lname" text. define temp "email" text. define temp "title" text. define temp "dob" text. Dummy := Remote("@current:mydata"). Dummy := Remote("@connect:127.0.0.1:8080/licensecheck/editcontact/"). Dummy := Remote( "@login:username/password"). Dummy := Remote("@query:q.action=getrecord"). Dummy := Remote( "@get") . fname := Remote( "recorddata.first_name") . lname := Remote( "recorddata.last_name") . email := Remote( "recorddata.email") . title := Remote( "recorddata.title") . dob := Remote( "recorddata.dob") . if title = blank then     title := "The master" . else     title := "" . end Dummy := Remote("@query:"). Dummy := Remote( "action=updaterecord") . Dummy := Remote( jointext("recorddata.title=",title)) . Dummy := Remote( "@put") . title := Remote( "recorddata.title") . list records     fname ;     lname ;     email ;     title ;     dob . -- The body ***************************************************** Get and update my contact info ***************************************************** .items Name: [{fname}] [{lname}] EMail: [{email}] Title: [{title}] Day of birth: [{dob}] .end ***************************************************** -- The result if you have a valid login ***************************************************** Get my contact info ***************************************************** Name: Test User EMail: test@example.com Title: The master Day of birth: 17.08.67 ***************************************************** 

Delete record

For the examples I use a Contact table where you have a first_name, last_name, title, and email field. I have created a DG3 page that have a fixed filter

email=[{ user.email }] that connects the logged in user to the record data by the registered email. To use the page for RemoteLookup, you just add a query string q.action=getrecord to the url and sets the action to updaterecord when you save the changed data back to the server. Here are the example of how to do it.

Login and show the registered values on the contact.

-- The DQL

define temp "Dummy" text.

define temp "fname" text.

define temp "lname" text.

define temp "email" text.

define temp "title" text.

define temp "dob" text.

Dummy := RemoteLookup("@current:mydata").

Dummy := RemoteLookup("@connect:http://127.0.0.1:8080/licensecheck/editcontact/").

Dummy := RemoteLookup( "@login:username/password").

Dummy := RemoteLookup("@query:q.action=getrecord").

Dummy := RemoteLookup( "@get") .

fname := RemoteLookup( "recorddata.first_name") .

lname := RemoteLookup( "recorddata.last_name") .

email := RemoteLookup( "recorddata.email") .

title := RemoteLookup( "recorddata.title") .

dob := RemoteLookup( "recorddata.dob") .

list records

fname ;

lname ;

email ;

title ;

dob .

-- The Body

*****************************************************

Get my contact info

*****************************************************

.items

Name:[{fname}] [{lname}]

EMail:[{email}]

Title:[{title}]

Day of birth:[{dob}]

.end

*****************************************************

-- The result if you have a valid login

*****************************************************

Get my contact info

*****************************************************

Name:Test User

EMail:test@example.com

Title:

Day of birth:17.08.67

*****************************************************