Referenced Panagon Web Services Files

Most of the ASP files you create for eProcess Services will need to reference some, or all, of the Panagon Web Services Javascript library and ASP object implementation files. This topic describes these files and provides example lines of code to reference the files.

Topics include:

Essential Panagon Web Services Files

This table lists the essential Panagon Web Services files and briefly describes each file.

Referenced file

Description

InitApplication.asp

Reference this file in top level pages only. This file implements session-scoped variables and constants needed by Panagon Web Services. In addition, this file sets cookie states.

InitPage.js

Reference this file in each page in your application. This file implements page-scoped variables and constants.

EnableRemoteObject.asp

Enables remote scripting by calling the remote scripting components in the _ScriptLibrary directory (in the root web structure). Remote scripting must be enabled to make method calls on the client-side Javascript API objects, which are used in both the Web Services and the Web WorkFlo application pages.

PopupManager.js

Provides functions for handling popup windows.

Misc.js

Provides the ability to use the Web Services utility functions.

Document.js

Modified for Panagon WorkFlo. Provides the ability to create an IDMWSC_Document object and use methods supported by the object.

Event.js

Provides the ability to create an IDMWSC_Event object and propagate events.

Folder.js

Provides the ability to create an IDMWSC_Folder object and use methods supported by the object.

Library.js

Modified for Panagon WorkFlo. Provides the ability to create an IDMWSC_Library object and use methods supported by the object.

Result.js

Provides the ability to create an IDMWSC_Result object and use the methods and access properties supported by the object.

StoredSearch.js

Provides the ability to create an IDMWSC_StoredSearch object and use the methods supported by the object.

Version.js

Provides the ability to create an IDMWSC_Version object and use the methods supported by the object.

Note All of the referenced files are located in the \IDMWS\WSCAPI directory on the eProcess Services web server. For more information on how to use these referenced Web Services files or how to use the Javascript API objects, refer to Locate the Panagon Web Services Toolkit Help.

Example Code to Reference Files

Include the following lines in the approximate order shown. Include the line referencing the InitApplication.asp in the top level page only.

<script language="Javascript" src="WSCAPI/InitApplication.asp"></script>
<script language="Javascript" src="WSCAPI/InitPage.js"></script>

The lines referencing the Javascript objects can be included in any order, but you should list them in the order the object is most likely to be used. In general, you should include only the .JS file associated with the object you will create in a given page.

<script language="Javascript" src="Redist/PopupManager/PopupManager.js"></script>
<script language="Javascript" src="WSCAPI/Library.js"></script>
<script language="Javascript" src="WSCAPI/Folder.js"></script>
<script language="Javascript" src="WSCAPI/Document.js"></script>
<script language="Javascript" src="WSCAPI/Event.js"></script>
<script language="Javascript" src="WSCAPI/Result.js"></script>
<script language="Javascript" src="WSCAPI/Misc.js"></script>

During web application operation, the referenced Javascript library files are cached on the client system, so including all of the .JS files in every application page impacts performance only during the first page request. After the files are cached in local cache, all calls to the .JS files are handled by the locally cached copies.

You must use remote scripting to access the client-side API objects. You must include the following line to enable remote scripting:

<!-- #INCLUDE FILE="../WSCAPI/EnableRemoteObject.asp"-->