Xephr URL Generation and Embedding Values in URLs

When moving between entities and modes, Xephr generates URLs to determine what information will be displayed on the entity.  A standard URL might look like this:

http://supportnet.ndsiasp.com/xephr/qbe/CUSTOMER_PCR_QBE

The first value in the URL is the host for the Xephr Repository: http://supportnet.ndsiasp.com/

The second value in the URL defines that you are running xephr runtime from the host.  xephr/

The third value in the URL defines that mode in which you are viewing the entity. qbe/

The fourth value in the URL defines the entity that is being run: CUSTOMER_PCR_QBE

This URL displays the CUSTOMER_PCR_QBE screen in query mode.

Additional values can be added to a URL to indicate different restrictions for the entity being displayed.

Users and Passwords:

If you need to be able to access the information on an entity, without displaying the log in screen, and the entity is not anonymous, you can pass the user name and password to the entity.  You will need to find out what the hashed version of the password is by using the Xephr Administration Console.

When creating the URL, you would add the following to the base URL described above.  The URL is case sensitive.

After the entity name, add a ?.

Then, type XEPHR_USER=login (where login is the login value for the user).

Then, add an ampersand &.

Then type XEPHR_PWD=password (where password is the hashed password value for the user).

Then add an amperand &.

Then type XEPHR_NOJVM=Y.

Your final URL will look something like this:

http://supportnet.ndsiasp.com/xephr/qbe/CUSTOMER_PCR_QBE?XEPHR_USER=login&XEPHR_PWD=password&XEPHR_NOJVM=Y

Global Variable Creation/Value Assignation

If you need to pass in a set global variable using a straight URL, you can do so by adding the following to the base URL described above.  The URL is case sensitive.  The global created will be a temporary global.  

After the entity name, add a ?.

Then type query=.

Then type an asterisk *

Then type globalname=value (globalname is the name of the global variable, and value is the value assigned to the global variable.)

If you need to add additional ones, add an ampersand &.

Then type query=.

Then type an asterisk *

Then type globalname=value.(globalname is the name of the global variable, and value is the value assigned to the global variable.)

Your final URL will look something like this:

http://supportnet.ndsiasp.com/xephr/qbe/CUSTOMER_PCR_QBE?query=*GLOBAL_NAME=value&query=*GLOBAL_NAME=value&query=*GLOBAL_NAME=value

If you wish to pass in a global variable that will be a session global variable, you can do so by using two asterisks instead of one.

After the entity name, add a ?.

Then type query=.

Then type an asterisk **

Then type globalname=value (globalname is the name of the global variable, and value is the value assigned to the global variable.)

If you need to add additional ones, add an ampersand &.

Then type query=.

Then type an asterisk **

Then type globalname=value.(globalname is the name of the global variable, and value is the value assigned to the global variable.)

Your final URL will look something like this:

http://supportnet.ndsiasp.com/xephr/qbe/CUSTOMER_PCR_QBE?query=**GLOBAL_NAME=value&query=**GLOBAL_NAME=value&query=**GLOBAL_NAME=value

Restricting Query Results

If you need to pass a value to restrict query results using a straight URL, you can do so by adding the following to the base URL described above.  Different symbols added to the URL will return different results.

After the entity name, add a ?

Then type query=

Then type a commercial at @

Then type the block.field that will be restricted by the value.

Then type an equal sign =

Then type the value.

Then type any additional symbol to indicate case insensitivity and wildcard use.

If you need additional values, add an ampersand &

Then type query=

Then type a commercial at @

Then type the block.field that will be restricted by the value.

Then type an equal sign =

Then type the value.

Then type any additional symbol to indicate case insensitivity and wildcard use.

Your final URL might look something like this if you used all restriction possibilities.

http://supportnet.ndsiasp.com/xephr/list/CUSTOMER_PCR_QBE?query=@BLOCK.FIELD=C&query=@BLOCK.FIELD^=joe%20johnson&query=@BLOCK.FIELD@=jd&query=@BLOCK.FIELD|=Error&query=@BLOCK.FIELD~=po

Xephr is a registered trademark of NDS Systems, LC.

Copyright © 2007 NDS Systems LC.