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

ScreenFlow Repository API

ScreenFlow Repository API

The sample project has a sample that uses the repository JavaScript API to query Process Designer for guides, and which are then displayed to your end users so they can choose one to execute. This repository API is useful if your application needs to dynamically present users with a list of available guides in menu form.
The following sample function queries for all guides using the
getEntries() activevos.socrates.screenflow.central.repository.AeScreenFlowRepository
function.
getEntries()
takes two arguments:
  • filter
    , which is currently not implemented.
  • A callback function that is called when the Ajax request completes. It receives an array of
    Item
    objects whose properties are shown in the Sample Item Object code sample.
Code Example: Query for Guides
function() { var repo = new activevos.socrates.screenflow.central. repository.AeScreenFlowRepository(); var filter = null; // currently not used repo.getEntries(filter, function(aSuccess, aItemList) { if (aSuccess) { for (var i = 0; i < aItemList.length; i++) { var item = aItemList[i]; } } }); };
Code Example: Sample Item Object
{ "Item" : { "EntryId" : { "$t" : "" }, "Name" : { "$t" : "" }, "MimeType" : { "$t" : "" }, "Description" : { }, "AppliesTo" : { "$t" : "" }, "Tags" : { }, "VersionLabel" : { "$t" : "" }, "State" : { "$t" : "" }, "ProcessGroup" : { }, "CreatedBy" : { "$t" : "" }, "CreationDate" : { "$t" : "" }, "ModifiedBy" : { "$t" : "" }, "ModificationDate" : { "$t" : "" }, "PublishedBy" : { "$t" : "" }, "PublicationDate" : { "$t" : "" }, "PublishedContributionId" : { "$t" : "" }, "AutosaveExists" : { "$t" : "" } } }