Table of Contents

Search

  1. Preface
  2. Overview, Downloading, and Installing
  3. Administration API
  4. Identity Service API
  5. Screenflow Programming and SDK
  6. ActiveVOS WSHT API
  7. Embedding Request Forms in Standalone Web Pages
  8. XML-JSON for Process Central

7. APIs, SDKs, and Services

7. APIs, SDKs, and Services

Host Context Locale and Time Zone

Host Context Locale and Time Zone

The host context is data provided by the host application that is accessible to the Guide Designer framework and is passed to all Service Call steps, as well as data provider and search service processes.
Setting Up the Host Context
This host context data is essentially a key/value pair of strings that contain additional data about the host application, guide user, embedding application, and so on. These parameters are provided to a guide during runtime by adding a
host-
prefix (notice the hyphen used as a suffix) to the parameter's name and passing them as query string arguments on the guide URL. For example, if your host provider implementation requires an argument for embedding an application ID named
AppId
, you would add the following to the guide URL:
host-AppId=someValue
.
Three host context parameters names are reserved by Guide Designer and may be required when embedding or executing your guide.
Name
Description
ObjectType
This is required if your guide applies to an object. It is not required if your guide applies to any object (that is, it is not directly associated with an object). The value is the name of the object.
ObjectId
This is required if your guide applies to an object. It is not required if your guide applies to any object. The value is the ID of the object the guide will execute on.
UserId
This is optional, but may be used to set the
Current User
for the current guide. This may be useful if the ID for the embedding application needs to be translated to something else for guide execution.
ExtraInfo
Additional metadata made available to reports for filtering or sorting.
So to set the
ObjectType
to
contacts
, your embedded URL would contain a query string argument like
host-ObjectType=contacts
. At runtime, the
hostContext
element would contain an
arg
element with a name attribute of
ObjectType
and a text node value of
contacts
.
Setting the User's Locale
You can set user locale information to your application by using the
host-UserLocale
URL parameter; for example:
host-UserLocale=en_US
The arguments to
host-UserLocale
are those defined in the ISO 639 standard.
Setting the User's Time Zone
You can set the time zone for your application by using the
host-UserTimeZone
URL parameter; for example:
host-UserTimeZone=America/Los_Angeles
The arguments to
host-UserTimeZone
are those defined within the
tz_database
; see
http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
for more information.