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

Object Linking to Host Application

Object Linking to Host Application

If your host application has landing pages for the objects in the application, you may want to provide HTML links in the guide to the objects page in the host application. For example, an object whose
ObjectId
is 123 can be accessed in the hosting application using the following URL:
http://hostapp.net/objects/123
. This link would then appear in the guide.
You will need to create a JavaScript function that can build a URLs from the Object Id. The following code examples shows uses the Object Id to build and return the URL. The
getLinkToObject
function is also passed the host context in case additional information about the host is needed to build the URL.
Code Example: Link Builder Sample
You must assign your builder to
activevos.socrates.screenflow.data.renderers.provider
so that it can be discovered at runtime. This is shown in the second to last line in the following example.
(function($){ activevos.util.createAvosPackage("hostapp.link.generator"); function MyLinkBuilderUtil() { this.getLinkToObject = function(aHostContext, aId) { return "http://hostapp.net/objects/" + aId; }; } activevos.socrates.screenflow.data.renderers.provider = new MyLinkBuilderUtil(); })(jQuery);
Code Example: Configuration to Deploy Link Builder
The following is an example of the Process Central configuration file required to deploy your custom JavaScript function into a guide.
<tns:avosCentralConfiguration xmlns:tns="http://schemas.active-endpoints.com/avc/ 2009/07/avoscentral-config.xsd" > <tns:centralIncludes> <script xmlns="http://www.w3.org/1999/xhtml" src="link-builder.js"></script> </tns:centralIncludes> </tns:avosCentralConfiguration>