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

Features

Features

The following features are currently supported by Guide Designer. However, your host run-time may not support them.
Feature
Description
guidePermissions
Guides within a project can be restricted by role or group using a tab displayed in the
Settings
dialog invoked from the Guide toolbar on the Home page. When this property is set to true, a Permissions tab appears within this dialog.
handleRedirectOnDone
Guides can redirect to another URL when they are done, and the redirect
onDone
feature allows the hosting application to override the default redirect behavior with its own. The default behavior is to navigate the current window to the URL defined by the guide. When this feature is enabled, Guide Designer will no longer do the redirect; instead it will execute an
aesf-done
window event, which your application can listen for and act upon.
The event data will be a string having the following format:
aesf-done | [reference: | url:] data
Examples are:
aesf-done|url:http://active-endpoints.comaesf-done|url:active-endpoints.com aesf-done|reference:50c7f76e-0f86-49d1-8e1d-ee9478f9b54d
The sample project contains an example that shows listening for window events in the
guideExplorer.js
file in the
subscribeToAeSfDoneMessages
function.
polymorphism
If enabled, the user can choose more than one object as a "reference to". If set to true, service call steps and the data service may receive space-delimited object names as a
referenceTo
value. Only set this to true if your host supports polymorphic relationships.
runAsUser
If your host supports data access and modification requests at an elevated user, enable this feature. By default, all requests to service call steps and the data service include a
runAsUser
element set to
$current
. When this is enabled, the guide developer sees an option for setting the
runAsUser
value to
$system
, indicating that a guide can create or modify objects in the host that they may not normally have the permissions for.
redirectToObject
This feature affects End steps and determines the behaviors guide developers can set when a guide is done. If disabled, the only
on done
behavior is the ability to go to a URL. However, if your host supports URLs for the object in the host and if this feature is enabled, guide developers can choose:
  • Refresh Current Object
  • Go to Other Object
  • URL
showEmbedLink
An HTTP link for embedding the guide is displayed.
Note
: If you deploy a project more than once and each has its own
app-config.xml
file, your users will see the following error message:
If this occurs, you will need to go to the Process Console (usually running at
localhost:8080/activevos
), select
Catalog | Contributions
, click on a contribution's link, then select the
Offline
button.