worksite web application integration toolkit (8.5, english)
DESCRIPTION
WorkSite Web Application Integration Toolkit (8.5, English)TRANSCRIPT
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
1/114
iManage WorkSite Web Application
Integration ToolkitDevelopers Guide
Version 8.5Document Revision 2
August 2009
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
2/114
Notice
1999-2009 Autonomy Corporation plc and its affiliates. All rights reserved.
No part of this publication (hardcopy or electronic form) may be reproduced or transmitted, in any form or by any means, electronic, mechanical,photocopying, recording, or otherwise, without the prior written consent of Autonomy Corporation plc and its affiliates. Information in this manualis furnished under license by Autonomy Corporation plc and its affiliates and may only be used in accordance with the terms of the l icenseagreement. If this software or documentation directs you to copy materials, you must first have permission from the copyright owner of thematerials to avoid violating the law which could result in damages or other remedies.
Trademarks and Copyrights
Interwoven, iManage, ConfirmSite, ContentServices, ControlHub, DataDeploy, DeskSite, FileSite, iManage, iManage Universal Search, iManageWorkSite, LiveSite, MediaBin, MetaCode, MetaTagger, OffSite, OpenDeploy, Primera, iManage RecordsManager, Scrittura, TeamPortal,TeamSite, VisualAnnotate, WorkDocs, WorkPortal, WorkRoute, WorkSite, WorkSite Express Search, WorkTeam, the respective taglines, logosand service marks are trademarks of Autonomy Corporation plc and its affiliates, which may be registered in certain jurisdictions. All othertrademarks are owned by their respective owners. Some or all of the information contained herein may be protected by patent numbers: US #6,505,212, GBRI # 1053523, US # 6,480,944, US# 5,845,270, US #5,430,812, US #5,754,704, US #5,347,600, AUS #735365, AU 7830068, GB#GB2333619, US #5,845,067, US #6,675,299, US #5,835,037, AUS #632333, CAN #2,062,965, FRAN / GRBI / SPAI / SWED #480941, GERM#69020564.3, KORS 10-0576487, JAPA #2968582, MX #219522, NZ #516340, SING #109524, SG #89006, SG #89086, SG #74973, SG#85502 US #5,065,447, US #6,609,184, US #6,141,017, US #5,990,950, US #5,821,999, US #5,805,217, US #5,838,832, US #5,867,221, US#5,923,376, US #6,434,273, US #5,867,603, US #4,941,193, US #5,822,721, US #5,923,785, US #5,982,938, US #5,790,131, US #5,721,543,US #5,982,441, US #5,857,036, US #6,697,532, US #6,792, 454, US #6,928,149, US #7,092,969 or other patents pending application for
Autonomy Corporation plc and its affiliates.
Autonomy Corporation plc
Cambridge Business Park
Cowley Rd
Cambridge
CB4 0WZ
Tel: +44 (0) 1223 448000
Fax: +44 (0) 1223 448001
Email: [email protected]
8/21/09
Copyright Notice
mailto:[email protected]:[email protected] -
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
3/114
WorkSite Web Application Integration Toolkit Developers Guide
Contents
About This Book 11Intended Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Notation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Manual Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Documentation Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls 15WorkSite Web Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Using WorkSite Web ASP.Net Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Adding Controls to an ASP.Net Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
ASP.Net Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Step 1: Reference the WebParts.dll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Step 2: Insert the Code for the ASP.Net Control . . . . . . . . . . . . . . . . . . . . . . 18
Step 3: Modify the Controls Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Quick Search Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Step 1: Reference the WebParts.dll . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Step 2: Insert the Code for the Quick Search Control. . . . . . . . . . . . . . . . . . 23
Step 3: Modify the Controls Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Using WorkSite Web JavaScript Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Load the JavaScript Files from the WorkSite Web Directory . . . . . . . . . . . . . . . 24
Initialization Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Create the Links on the Demo Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Enter the Code for the WorkSite Web Controls . . . . . . . . . . . . . . . . . . . . . . . . . 27
WorkSiteWebPart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
WorkSiteQuickSearchPart. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Open the Controls That Are Called by the Links. . . . . . . . . . . . . . . . . . . . . . . . 32
Using the WorkSite Web ASP.Net Control Demo. . . . . . . . . . . . . . . . . . . . . . . . . . 36Chapter 2: Addressable URLs for WorkSite Web Components Server 37
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Importing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Importing an Existing Document as a New Version . . . . . . . . . . . . . . . . . . . . . . 38
Importing a URL Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Checking In Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
4/114
Contents
4 WorkSite Web Application Integration Toolkit Developers Guide
Checking Out Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Downloading Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Sending Documents via E-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Viewing Document Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Viewing Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Viewing Document History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Viewing Where a Document Is Used. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Viewing a Document in HTML Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Refiling a Document. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Editing or Viewing a Documents Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Editing or Viewing a Folder's Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Editing or Viewing a Workspace's Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Sending Links to Workspaces via Email. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Using the WorkSite Web Dialog Callback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapter 3: Enhanced Browse Dialog 53Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Using Enhanced Browse Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Client-side Callback Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Chapter 4: WorkSite Web Service 59Consuming the Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Description of the WorkSite Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Web Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Using Web Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Document Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
CreateDocuments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
CheckOut. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
CheckinReplaceOriginal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
CheckinNewVersion. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
CheckinNewDocument. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
CheckinUndo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
SetDocumentsProperties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
GetDocuments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
WorkSpace Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
CreateWorkspaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
SetWorkspacesProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
GetWorkspaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Folder Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73CreateFolders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
SetFoldersProperties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
GetFolders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
GetFolderContents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
GetSubFolders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Searches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
5/114
Contents
WorkSite Web Application Integration Toolkit Developers Guide
SearchDocuments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
SearchWorkspaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Other Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
CreateCustomAttributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79GetCustomAttributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
GetObjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Substructures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
AclItem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
AdditionalProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
CustomProperty. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
CustomAttribute. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
DocumentFolder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Error. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
FolderSearchParameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
FullTextSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86HistoryItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
NewWorkspace : Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
ObjectSecurity. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
OutputMask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
ProfileError. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
ProfileItem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
ProfileSearchParameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Recipient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
WorkSpace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
WSObject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Enumerators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
AclType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
imAccessRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
imCheckOutOptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
imFolderAttributeID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
imFullTextSearchLocation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
imProfileAttributeID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
imSearchAttributeType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
imSearchEmail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
imSecurityType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Chapter 5: Workspace Creation Web Service 101Consuming the Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
6/114
Contents
6 WorkSite Web Application Integration Toolkit Developers Guide
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
7/114
WorkSite Web Application Integration Toolkit Developers Guide
Figures
Figure 1 IWOV Web Part .......................................................................................................... 16Figure 2 WorkSite Web ASP.Net Controls Demo Page ............................................................ 17Figure 3 My Matters control on the Demo Page ....................................................................... 26Figure 4 Solution Explorer view ................................................................................................ 60Figure 5 Add Web Reference dialog ......................................................................................... 61Figure 6 Web reference appears in Solution Explorer .............................................................. 62Figure 7 Solution Explorer view .............................................................................................. 102Figure 8 Add Web Reference dialog ....................................................................................... 103Figure 9 Web reference appears in Solution Explorer ............................................................ 104
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
8/114
Figures
8 WorkSite Web Application Integration Toolkit Developers Guide
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
9/114
WorkSite Web Application Integration Toolkit Developers Guide
Tables
Table 1 Notation conventions ............................................................................................... 12Table 2 Description of moniker variables.............................................................................. 19Table 3 Description of ShowFlags enumerators................................................................... 21Table 4 Enumerator and its description ................................................................................ 24Table 5 Value of moniker variables....................................................................................... 29Table 6 Numeric values for wswpShowEnums..................................................................... 30Table 7 Numeric value for contentType enumerator............................................................. 30Table 8 Value for contentType enumerator .......................................................................... 32Table 9 Parameters to import documents............................................................................. 37Table 10 Parameters to import an existing document as a new version ................................ 38Table 11 Parameters to import a URL document ................................................................... 39Table 12 Parameters to check in documents.......................................................................... 39Table 13 Parameters to check out documents ....................................................................... 41Table 14 Parameters to download documents ....................................................................... 42Table 15 Parameters for sending documents via e-mail......................................................... 43Table 16 Parameters to view document versions ................................................................... 44Table 17 Parameters to view related documents.................................................................... 45
Table 18 Parameter to view document history........................................................................ 45Table 19 Parameters for viewing where a document is used ................................................. 46Table 20 Parameter for viewing a document in HTML format ................................................ 47Table 21 Parameter for refiling a document............................................................................ 48Table 22 Parameter for editing or viewing a documents properties....................................... 49Table 23 Parameter for editing or viewing a folder's properties.............................................. 49Table 24 Parameters for editing or viewing a Workspace's properties................................... 50Table 25 Parameters for sending links to Workspaces via e-mail .......................................... 51Table 26 Parameters passed to BrowseDlgEx.aspx............................................................... 54Table 27 Required parameters for enhanced browse dialog callback .................................... 55Table 28 Supported OutputMask bits for a moniker type........................................................ 81
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
10/114
Tables
10 WorkSite Web Application Integration Toolkit Developers Guide
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
11/114
WorkSite Web Application Integration Toolkit Developers Guide
About This Book
This guide includes information about the following topics:
ASP.Net controls and JavaScript objects that form the underlying structure of Web Parts.
Addressable URLs that can be used to access WorkSite Web dialogs from within another
Web application.
Enhanced browse dialogs that can leverage WorkSite Webs search functionality to locate
documents or workspaces, and that support multiple item selection.
Web service consumption within a .Net environment using the C# programming language.
Workspace generation for the WorkSite content management system from within other
applications.
Detailed instructions are provided for using these features.
Intended AudienceThis guide includes information for developers, or other users requiring information about
customizing WorkSite Web.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
12/114
About This Book
12 WorkSite Web Application Integration Toolkit Developers Guide
Notation Conventions
This manual uses the following notation conventions:
This guide also uses the following conventions:
The term Windows indicates any supported version of the Microsoft Windows operating
system, such as Windows2000.
Table 1 Notation conventions
Convention Definition and Usage
Bold Text that appears in a GUI element such as, a menu item, button, orelement of a dialog box, and command names are shown in bold.For example:
Click Edit Filein the Button Bar.
Italic Book titles appear in italics.
Terms are italicized the first time they are introduced.
Important information may be italicized for emphasis.Monospace Commands, command-line output, and file names are in
monospace type. For example:
The i wext at t r command-line tool allows you to set and look upextended attributes on a file.
Monospaced
italicMonospaced italics are used for command-line variables.Forexample:
i wckr ol e role user
This means that you must replace roleand userwith your values.
Monospaced bold Monospaced bold represents information you enter in response tosystem prompts. The character that appears before a line of user
input represents the command prompt, and should not be typed.For example:
iwextattr -s project=proj1 //IWSERVER/default/main/dev/WORKAREA/andre/products/index.html
Monospaced bold
italicMonospaced bold italic text is used to indicate a variable in userinput. For example:
iwextattr -s project=projectnameworkareavpath
means that you must insert the values ofprojectnameandworkareavpathwhen you enter this command.
[ ] Square brackets surrounding a command-line argument mean thatthe argument is optional.
|Vertical bars separating command-line arguments mean that onlyone of the arguments can be used.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
13/114
Manual Organization
WorkSite Web Application Integration Toolkit Developers Guide
Directory paths use UNIX conventions. These conventions mandate using forward slashes (/
) in path names. (Windows systems use backward slashes.) The Windows convention is used
when referring to a Windows-specific directory. For example:
UNI X: docr oot / news/ f r ont . htmlWi ndows: docroot \ news\ f r ont . html
Manual Organization
This manual is organized as follows:
Chapter 1, Using WorkSite Web ASP.Net and Java Script Controls,describes the ASP.Net
controls and JavaScript objects that form the underlying structure of IWOV Web Parts. It
also discusses how to work with WorkSite Web elements in multiple environments.
Chapter 2, Addressable URLs for WorkSite Web Components Server,describes how to use
addressable URLs to import, check in, check out, view, and perform other tasks with
documents. It includes the base URL for these activities, parameters, accepted variables, and
other related information.
Chapter 3, Enhanced Browse Dialog,describes how to modify the browser to use WorkSite
Webs search functionality to locate documents or workspaces, and to support multiple item
selection. It includes coding instructions for making these modifications.
Chapter 4, WorkSite Web Service,describes how the Web service is consumed within a
.Net environment using the C# programming language. It also describes the methods in
WorkSite Web Service, including input messages, output messages, and parameters. Chapter 5, Workspace Creation Web Service,describes how to generate workspaces for the
WorkSite content management system from within other applications. It explains how to use
this functionality, and it includes sample code.
Product Documentation
The following documents describe related products or functionality for the WorkSite Web:
WorkSite Web Components Server Installation Guide
WorkSite Web Online Help
WorkSite Web Application Integration Toolkit
WorkSite Web Customization Developer's Guide
WorkSite Web CSS Customization Guide
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
14/114
About This Book
14 WorkSite Web Application Integration Toolkit Developers Guide
WorkSite Web Connectors Developer's Guide
WorkSite Web for SharePoint User's Guide
WorkSite Protocol Handler for SharePoint
Documentation Updates
Additions and corrections to this document (when available) can be downloaded in PDF format
from the following Web site: https://customers.autonomy.com .
https://customers.autonomy.com/https://customers.autonomy.com/ -
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
15/114
WorkSite Web Application Integration Toolkit Developers Guide
Chapter 1
Using WorkSite Web ASP.Net and
Java Script Controls
The WorkSite for SharePoint Users Guideexplains how to bring WorkSite documentmanagement functionality to Microsoft Office SharePoint by dropping IWOV Web Parts on a
SharePoint workspace. You can also add WorkSite Web controls such as My Mattersor
searches to ASP.Net pages or any other type of portal or static HTML page. This chapter
describes the ASP.Net controls and JavaScript objects that form the underlying structure of
IWOV Web Parts and how to work with WorkSite Web elements in different environments. For
example, you may want to create ASP.Net pages and use them in conjunction with SharePoint as
target workspaces to display search results or zoomed views into WorkSite folders or
workspaces. With a higher level of programming skill, you can use the underlying JavaScript
objects to render any of the WorkSite controls such as My WorkSiteor My Matters on a
custom Web portal or a static HTML page.
NOTE
To work with WorkSite Web elements in ASP.Net or a Web portal application other than
SharePoint, you must have the WorkSite Web Component Server installed on the machine on
which the portal application is running.
WorkSite Web Controls
An IWOV Web Part is a thin wrapper written in C# around an ASP.Net control. Every IWOVWeb Part has an underlying ASP.Net control.
The WorkSite Web ASP.Net controls with full WorkSite functionality can be added to any
ASP.Net page. This chapter will describe how to configure the WorkSite Web ASP.Net controls
by specifying the parameters.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
16/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
16 WorkSite Web Application Integration Toolkit Developers Guide
The WorkSite Web ASP.Net control is, in turn, a thin wrapper around a JavaScript object. The
JavaScript object contains all the presentation logic and functions to render the WorkSite Web
control. In other words, the functionality of the ASP.Net control (and ultimately the IWOV Web
Part) is executed by calling functions and methods of the JavaScript objects. The JavaScriptobjects themselves will render WorkSite Web elements directly on an HTML page, and you can
modify the view by calling methods of the objects. The IWOVWeb Part is a thin wrapper that
references but does not contain the presentation logic. Figure 1describes the levels of structure
underlying the IWOV Web Part.
Figure 1 IWOV Web Part
There are 14 IWOV Web Parts available in WorkSite for SharePoint. All IWOV Web Parts
represent different views of two base controls, the Quick Search control and the Web Part
control. My WorkSiteis the default view of the Web Part control. This control can also be
configured to present My Matters or My Favorites, or a single folder or workspace or a saved
search. Figure 2is a screen capture of the WorkSite Web ASP.Net Controls Demo Page thatcontains a WorkSite Web ASP.Net controls for My WorkSiteand a Quick Searchcontrol.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
17/114
Using WorkSite Web ASP.Net Controls
WorkSite Web Application Integration Toolkit Developers Guide
Figure 2 WorkSite Web ASP.Net Controls Demo Page
We will use this demo page to illustrate how to work with WorkSite Web ASP.Net and
JavaScript controls. The WorkSite Web ASP.Net Controls Demo file is available for your
reference on the WorkSite Web installation CD. For installation information, see Using the
WorkSite Web ASP.Net Control Demo on page 36.
Using WorkSite Web ASP.Net Controls
A common practice when using WorkSite for SharePoint is to direct search results and the zoom
in view of folder contents to a "Goto.aspx" page or a "Result.aspx" page. An ASP.Net page with
WorkSite Web controls can be created within SharePoint of within another Web application.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
18/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
18 WorkSite Web Application Integration Toolkit Developers Guide
The following sections describe how to add and configure the Quick Search and Web Part
controls on an ASP.Net page.
Adding Controls to an ASP.Net Page
You can add a WorkSite Web control to an ASP.Net page by following three steps:
1. Insert the code that references the DLL containing the WorkSite Web JavaScript objects.
2. Insert the code for the ASP.Net control.
3. Set or modify the parameters of the ASP.Net control to determine the features that appear
when the control is displayed.
The following sections walk you through the process of adding the ASP.Net WebPart controland the QuickSearchPart control.
ASP.Net Control
Step 1: Reference the WebParts.dll
To drop a WorkSite Web control on an ASP.Net page, you must insert the following code into
the ASP.Net source code to reference the i Manage. WorkSi t e. Web. WebPart s. dl l . It is located
inside the Autonomy\WorkSite\Web\bin folder.
NOTE
The i Manage. WorkSi t e. Web. WebPar t s. dl l needs to be referenced only once.
The next step is to insert the code for the ASP.Net control.
Step 2: Insert the Code for the ASP.Net ControlThe following code creates the WorkSite ASP.Net control. To view the generated code for the
JavaScript object, see WorkSiteWebPart on page 27. The default view of this control is My
WorkSite,as shown in Figure 2.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
19/114
Using WorkSite Web ASP.Net Controls
WorkSite Web Application Integration Toolkit Developers Guide
Moni ker Type="WorkArea"Cust omDet ai l Page="True"
Det ai l Page="Got o. aspx"
Sel ect i onMode="None"
Cont ent Types="Document , Wor kspace"
ShowFl ags="Tree, Cont ent , Vi ewMenu, Act i onMenu, Act i onBar , SearchType"
Cont r ol Hei ght ="320"
Expl orerWi dth="240"
St r etch="Tr ue"
St yl e="border : 1px sol i d #587BD7; " / >
Step 3: Modify the Controls Parameters
You can modify the Web Part control to display any of the WorkSite Web elements listed on the
left side of the WorkSite Web ASP.Net Controls Demo Page shown in Figure 2. For example,you can configure the Web Part control to display My Matters or My Favorites.You can
display the tree or a search form in the left pane with toggle buttons in the toolbar. Menus,
Action Bar and View menu can be shown or hidden. If you choose not to include any of these
features, the toolbar will not display on the control.
The parameters of the WorkSite Web Part control are listed below:
id
The ID attribute must be unique within a page.
MonikerType
A variable value used with the NRTID of the WorkSite Web control configured to display
different WorkSite Web controls. Descriptions of the moniker variables are listed in the
following table.
Table 2 Description of moniker variables
Moniker Variable Description
CheckedOutList Calls the CheckedOut Documents control.
WorkList Calls the combined Document Worklist control.RecentWorkspaces Calls the Matter Worklist control.
SubscriptionFolder Calls the My Matters control.
FavoritesFolder Calls the My Favorites control.
Session Calls the Session.
WorkArea Calls the WorkArea.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
20/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
20 WorkSite Web Application Integration Toolkit Developers Guide
CustomDetailPage
Boolean. When true, the search results or the zoom in view of the folder are directed to a target
ASP.Net page.
DetailPage
The ASP.Net page where the search results or zoom in view of the folder will display.
ContentTypes
String value that determines what type of content will be displayed in the right pane of the
control.
Document
WorkSpace
Document, WorkSpace
DocumentSearchFolder Calls the Document Search control.StartWorkspace Calls the Start WorkSpace control.
QueryString Looks for the moniker (which can be an NRTID) inthe query string in the URL.
Detail Looks for the moniker (which can be an NRTID) inthe query string in the URL.
Manage Calls the Manage control.
DocumentProperties Looks for the moniker (which can be a documentNRTID) in the query string in the URL.
Moniker Looks for the value of the moniker in the Monikerparameter.
Table 2 Description of moniker variables
Moniker Variable Description
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
21/114
Using WorkSite Web ASP.Net Controls
WorkSite Web Application Integration Toolkit Developers Guide
ShowFlags
A set of enumerators control the items to be displayed inside the WorkSite Web control. Table 3
lists these enumerators.
ControlHeight
The default height of the control. The height parameter does not apply if only the left or the right
pane is present on the control. In that case, the control height will grow to accommodate the
content, with no internal scroll bars. When both panes are present on the control and the Stretch
parameter described below is true, the height is set to 100% of the height of the parent HTML
element. If Stretchis false, this parameter sets the default height and a resize bar appears at thebottom of the window. If the height is not set on the parent element, the WorkSite Web control
will not display properly.
Table 3 Description of ShowFlags enumerators
Flag(enumerator)
Description
Tree Displays the tree in the left pane of the control.
Form Displays the search form in the left pane of the control
TreeForm Displays the tree in the left pane with a toggle button in thetoolbar to switch to the search form
FormTree Displays the search form in the left pane with a toggle button inthe toolbar to switch to the tree
Content Displays the content pane on the right
ViewMenu Displays the View menu button on the toolbar
ActionBar Displays the Action menu button on the toolbar for the objectselected in the tree
ActionMenu Displays the Action menu for nodes in the tree
SearchType Displays the Search Type drop-down menu
Preview Displays the preview pane inside the content pane for thedocuments
ToggleTF Displays the a button at the top left corner of the toolbar totoggle between Tree and Form
LeftSide Displays the left pane
RightSide Displays the right pane
Toolbar Displays the toolbar
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
22/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
22 WorkSite Web Application Integration Toolkit Developers Guide
ExplorerWidth
The default width of the left pane of the control, or the entire control if there is only one pane.
When there are two panes, a resize bar appears on the control and the user can modify theExpl orer Wi dt h.
Stretch
Boolean. This parameter affects the pi xel Hei ght of the control. It does not apply when only the
left or right pane is present on the control. When both panes are present on the control and the
Stretch parameter described below is true, the height is set to 100% of the height of the parent
HTML element. If Stretch is false, this parameter sets the default height and a resize bar appears
at the bottom of the window. If the parent element does not have a size parameter, the WorkSite
Web control will not display properly.
Style
Used to enter additional CSS style attributes.
Quick Search Control
Step 1: Reference the WebParts.dll
NOTE
If you have already added a WorkSite Web ASP.Net control to your page, you may skip this
step.
To drop a WorkSite Web control on an ASP.Net page, you must insert the following code into
the ASP.Net source code to reference the iManage.WorkSite.Web.WebParts.dll. It is located in
the WorkSite Web installation directory: worksite/Web/bin/
i Manage. WorkSi t e. Web. WebPar t s. dl l .
The next step is to insert the code for the ASP.Net control.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
23/114
Using WorkSite Web ASP.Net Controls
WorkSite Web Application Integration Toolkit Developers Guide
Step 2: Insert the Code for the Quick Search Control
The following code creates the WorkSite Web Quick Search control. It uses the id attribute to
automatically call the JavaScript object and its functions.
Step 3: Modify the Controls Parameters
Configure the Quick Search control by setting the parameters. For example, you can include a
drop-down selection menu on the Quick Search control that lets the user choose a document
search or a workspace search, or you can display the Advanced search form instead of the Basic
form.
The parameters of the WorkSite Web Quick Search Control are listed below.
id
The ID attribute must be unique within a page.
CustomDetailPage
Boolean. When true, the search results are directed to a target ASP.Net page.
DetailPage
String. The ASP.Net page where the search results will display.
Style
Used to enter style elements such as borders.
ShowObjectType
Boolean. When true, the Quick Search control will display a drop-down menu of objects to be
searched (documents or workspaces). When false, no drop-down box appears.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
24/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
24 WorkSite Web Application Integration Toolkit Developers Guide
ObjectType
String values that describe the type of search:
i mDocument SearchFol der
i mWorkSpaceSearchFol der
ContentTypes
Enumerator that determines whether a drop-down box appears on the control. The
ShowObj ect Typeparameter described above must be true for the drop-down box to appear.
Using WorkSite Web JavaScript Objects
You can add WorkSite Web controls to any HTML page by dropping client-side JavaScript
objects into the code. The following sections describe how to create the Demo Page shown in
Figure 2using JavaScript objects.
Load the JavaScript Files from the WorkSite Web Directory
The following code loads all the JavaScript files. If you are using ASP.Net controls, the
JavaScript files are loaded automatically. The files only need to be loaded once, even if you are
adding multiple WorkSite Web objects. The filenames are in bold type for your reference.
CAUTIONDo not modify the code that loads the JavaScript files.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
25/114
Using WorkSite Web JavaScript Objects
WorkSite Web Application Integration Toolkit Developers Guide
sr c="/ wor ksi t e/ i ncl udes/Common.js">
wi ndow. worksi t e && _
WorkSi t eWebPar t Setup( ) ;
Initialization Code
Enter the following initialization code:
/ / Common I ni t i al i zat i on code
/ / t o do i ni t i al i zat i on of WebPart s
wi ndow. worksi t e && WorkSi t eWebPart Set up( ) ;
Create the Links on the Demo Page
NOTE
This step is for demonstration purposes only.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
26/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
26 WorkSite Web Application Integration Toolkit Developers Guide
The main Web Part control renders My WorkSite by default, but it contains the building blocks
of the other WorkSite Web controls. When clicked, a link on the left side of the WorkSite Web
ASP.Net Controls Demo Page configure the corresponding APS.Net control within the My
Matters window. For example, Figure 3shows the control after the My Matterslink has beenclicked.
Figure 3 My Matters control on the Demo Page
Create a table to position the link list. The following code creates the links. The HREF calls the
JavaScript function "openMyWorkSite( )", "openCheckedOutDocuments( )", etc. These
functions are described in detail in Step 6.
My WorkSi t e
Checked- outDocuments
Document Workl i st
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
27/114
Using WorkSite Web JavaScript Objects
WorkSite Web Application Integration Toolkit Developers Guide
Mat t er Workl i st
My Mat t ers
My Favori t es
Expl orerWorkspace
Sear ch
Workspace Search I n Tree
Enter the Code for the WorkSite Web Controls
In this example, two controls are added to the page by entering the code for the JavaScriptobjects.
NOTE
This is the code that is generated when you add an ASP.Net control to a page.
WorkSiteWebPart
The following code calls the JavaScript object corresponding to the base WorkSite WebPart
control (in this case, My WorkSite).
i f ( wi ndow. wor ksi t e )
{
/ / Cr eat e t he Worksi t e WebPar t Obj ect
WorkSi t eWebPar t ( {i d: ' WebCont r ol ' ,
pi xel Wi dt h: 240,
pi xel Hei ght : 320,
cust omDetai l Page: t r ue,
det ai l Page: ' Got o. aspx' ,
st yl e: ' bor der : 1px sol i d #587BD7; ' ,
str et ch: t rue
}) . wr i te( ) ;/ / Ref r esh t he Wor ksi t e WebPar t wi t h appr opr i at e par ameter s. I n t hi s / / exampl e, l oad Mat t er wor kl i st .
onl oadAdvi se( ' di spat ch( \ ' WebCont rol \ ' , \ ' refr esh\ ' , {qs: ( \ ' ?nrt i d=\ ' _
+ Moni kerWorkAr ea) , showFl ags: 500, sel ect i onMode: 0, cont ent Type: 8320_
}) ' ) ;
}
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
28/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
28 WorkSite Web Application Integration Toolkit Developers Guide
Modify the Controls Parameters
You can modify the parameters that are passed to the constructor WorkSiteWebPart:
id
The ID attribute must be unique within a page.
pixelWidth
The default width of the left pane of the control.
pixelHeight
The default height of the control. The height parameter does not apply if only the left or the right
pane is present on the control. In that case, the control height will grow to accommodate the
content, with no internal scroll bars. When both panes are present on the control and the Stretch
parameter described below is true, the height is set to 100% of the height of the parent HTML
element. If Stretch is false, this parameter sets the default height and a resize bar appears at the
bottom of the window. If the parent element does not have a size parameter, the WorkSite Web
control will not display properly.
customDetailPage
Boolean. When true, the search results or zoom in view of the folder are directed to a target
ASP.Net page.
detailPage
The ASP.Net page where the search results will display.
style
Used to enter style elements such as borders. You can enter style elements manually, but youcannot reference CSS stylesheets with this property.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
29/114
Using WorkSite Web JavaScript Objects
WorkSite Web Application Integration Toolkit Developers Guide
stretch
Boolean. This parameter affects the pi xel Hei ght of the control. It does not apply when only the
left or right pane is present on the control. When both panes are present on the control and theStretch parameter described below is true, the height is set to 100% of the height of the parent
HTML element. If Stretch is false, this parameter sets the default height and a resize bar appears
at the bottom of the window. If the parent element does not have a size parameter, the WorkSite
Web control will not display properly.
The constructor executes the wri t e( ) method. When the page loads, the dispatch method
automatically calls the refr esh( ) method. This ensures that refr esh( ) executes after the
page loads.
Modify the Parameters Passed to the Control s Refresh Method
The refr esh( ) method retrieves data based on the following parameters:
qs
This parameter specifies the target, for example: qs: '?nrtid=' + MonikerRecentPages. If there
is no value for the qsparameter, My WorkSite is the default. Values for the moniker variable are
listed in the following table:
showFlags
A combination of wswpShowEnumvalues that control the view of the WorkSite Web control. They
are turned on by listing the wswpShowEnumsthat you want to appear. The wswpShowEnumscan be
listed in any order. You can substitute a numeric value for the wswpShowEnum. In this example, it
is "showFl ags: 497".
Table 5 Value of moniker variables
Moniker Variable Value
MonikerCheckedOutList "_checkedoutlist"MonikerWorkList "_worklist"
MonikerRecentWorkspaces "_recentpages"
MonikerSubscriptionFolder "_subscriptionfolder"
MonikerFavoritesFolder "_favoritesfolder"
MonikerSession "_session"
MonikerWorkArea "_workarea"
MonikerDocumentSearchFolder "_documentsearchfolder"
MonikerStartWorkspace "_start"
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
30/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
30 WorkSite Web Application Integration Toolkit Developers Guide
NOTE
The wswpShowEnumscorrespond to the view options that appear on the IWOV Web Part
Properties dialog in SharePoint.
The wswpShowEnumsand their numeric values are shown in the following table:
contentType
Enumerator that determines what type of content will be displayed in the right pane of the
control. Use the numeric value of the enumerator.
WorkSiteQuickSearchPart
Insert the following code to add the WorkSite Quick Search control:
Table 6 Numeric values for wswpShowEnums
wswpShowEnum Num. Value Descript ion
Tree 1 Displays the tree in the left pane of the control.
Form 2 Displays the search form in the left pane
TreeForm 4 Displays the tree in the left pane with a togglebutton in the toolbar to switch to the search form
FormTree 8 Displays the search form in the left pane with atoggle button in the toolbar to switch to the tree
Content 16 Displays the content pane
ViewMenu 32 Displays the View menu button on the toolbar
ActionBar 64 Displays the Action menu buttons on the toolbarfor the node that is selected in the tree
ActionMenu 128 Displays the Action menu for nodes in the tree
SearchType 256 Displays the Search Type drop-down menu on theQuick Search control
Table 7 Numeric value for contentType enumerator
Enumerator Num. Value
Document 8192
WorkSpace 128
Document, WorkSpace 8320
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
31/114
Using WorkSite Web JavaScript Objects
WorkSite Web Application Integration Toolkit Developers Guide
i f ( wi ndow. wor ksi t e )
{
/ / Cr eat e the Qui ck Sear ch Worksi t e WebPart Obj ect
WorkSi t eQui ckSear chPar t ( {i d: ' Qui ckSearchCont r ol ' , _
cust omDet ai l Page: t rue, det ai l Page: ' Sear ch. aspx' , st yl e: ' ' , _
showObj ect Type: t r ue}) . wr i t e() ;
/ / Ref r esh t he Worksi t e WebPar t wi t h appr opr i ate parameters .
/ / I n t hi s exampl e, l oad t he user s document sear ch pr of i l e f orm.
onl oadAdvi se( ' di spat ch( \ ' Qui ckSearchCont rol \ ' , \ ' ref resh\ ' , _
{showFor m: f al se, obj ectType: \ ' i mTypeDocument Sear chFol der\ ' , _
cont ent Type: 8320 }) ' ) ;
}
Modify the Controls Parameters
The parameters that are passed to the WorkSi t eQui ckSear chPar t constructor are:
id
The ID attribute must be unique within a page.
customDetailPage
Boolean. When true, the search results are directed to a target ASP.Net page.
detailPage
The ASP.Net page where the search results will display.
style
Used to enter style elements such as borders. You can enter style elements manually, but you
cannot reference CSS stylesheets with this property.
showObjectType
Boolean. When true, the Quick Search control will display a drop-down menu of objects to be
searched (documents, workspaces, or both). When false, no drop-down box appears.
The constructor executes the wri t e( ) method. When the page loads, the Dispatch method
automatically calls the Refresh method. This ensures that Refresh executes after the page loads.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
32/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
32 WorkSite Web Application Integration Toolkit Developers Guide
Modify the Parameters Passed to the Control s Refresh Method
The Refresh method retrieves data based on the following parameters:
showForm
Boolean. When true, the search form rather than the tree displays in the left pane of the control.
When false, the tree displays.
objectType
String value that describes the type of search:
i mTypeDocument SearchFol der
i mTypeWorkSpaceSearchFol der
contentType
Enumerator that determines whether a drop-down box appears on the control. The
ShowObj ect Typeparameter described above must be true for the drop-down box to appear. The
enumerator and the corresponding numeric value can be used interchangeably.
Open the Controls That Are Called by the Links
The following code corresponds to the links listed on the Demo Page. Each link calls a different
configuration of the WorkSi t eWebPar t JavaScript object. It is included to illustrate how tomodify the My WorkSite control to create the various WorkSite Web Parts that have been
packaged for use in SharePoint. Note the difference in the showFl agsparameters when different
WorkSite controls are opened in the window. You can modify the showFl agsparameter to
customize the view of the control.
Table 8 Value for contentType enumerator
Enumerator Num. Value Description
Document 8192 Defaults to document search. No
drop-down menu appears.
WorkSpace 128 Defaults to workspace search. Nodrop-down menu appears.
Document, WorkSpace 8320 Drop-down menu appears. User can selectDocuments or WorkSpaces.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
33/114
Using WorkSite Web JavaScript Objects
WorkSite Web Application Integration Toolkit Developers Guide
My WorkSite
The following code renders the WorkSiteWebPart as My WorkSite.
f unct i on openMyWorkSi t e( )
{
ref resh(
{
qs: ' ?' ,
showFl ags: wswpShowEnum. Tr ee | wswpShowEnum. Cont ent |
wswpShowEnum. Vi ewMenu | wswpShowEnum. Act i onMenu
}) ;
}
Checked Out Documents
The following code renders the WorkSiteWebPart as Checked Out Documents.
f unct i on openCheckedOut Document s( )
{
ref resh(
{
qs: ' ?nr t i d=' + Moni ker CheckedOut Li st ,
showFl ags: wswpShowEnum. Content | wswpShowEnum. Vi ewMenu |
wswpShowEnum. Act i onBar
}) ;
}
Document Worklist
The following code renders the WorkSiteWebPart as Document Worklist.
f unct i on openDocument Workl i st ( )
{
ref resh(
{
qs: ' ?nr t i d=' + Moni ker WorkLi st ,
showFl ags: wswpShowEnum. Content | wswpShowEnum. Vi ewMenu |wswpShowEnum. Act i onBar
}) ;
}
Matter Worklist
The following code renders the WorkSiteWebPart as Matter Worklist.
f unct i on openMatt er Workl i st ( )
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
34/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
34 WorkSite Web Application Integration Toolkit Developers Guide
{
ref resh(
{
qs: ' ?nrt i d=' + Moni ker RecentWorkspaces,showFl ags: wswpShowEnum. Tr ee | wswpShowEnum. Act i onMenu
}) ;
}
My Matters
The following code renders the WorkSiteWebPart as My Matters.
f unct i on openMyMatt ers ( )
{
ref resh(
{
qs: ' ?nr t i d=' + Moni ker Subscri pt i onFol der ,
showFl ags: wswpShowEnum. Tr ee | wswpShowEnum. Act i onMenu
}) ;
}
My Favorites
The following code renders the WorkSiteWebPart as My Favorites.
f unct i on openMyFavor i t es( )
{
ref resh(
{
qs: ' ?nr t i d=' + Moni ker Favor i t esFol der ,
showFl ags: wswpShowEnum. Tr ee | wswpShowEnum. Cont ent |
wswpShowEnum. Vi ewMenu | wswpShowEnum. Act i onMenu
}) ;
}
WorkSite Explorer
The following code renders the WorkSiteWebPart as WorkSite Explorer.
f unct i on openExpl or er ( )
{ref resh(
{
qs: ' ?nr t i d=' + Moni ker Sessi on,
showFl ags: wswpShowEnum. Tr ee | wswpShowEnum. Cont ent |wswpShowEnum. Vi ewMenu | wswpShowEnum. Act i onMenu
}) ;
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
35/114
Using WorkSite Web JavaScript Objects
WorkSite Web Application Integration Toolkit Developers Guide
}
WorkSpace or Folder
The following code renders the WorkSiteWebPart as WorkSpace or Folder.
f unct i on openWorkspace( )
{
ref resh(
{
qs:' ?nr t i d=! nr t dms%3A0%3A!sessi on%3Awor kdemo%3A!dat abase%3AWDI MAN80%3A!page%3A43198%3A' ,
showFl ags: wswpShowEnum. Tr ee | wswpShowEnum. Cont ent |wswpShowEnum. Vi ewMenu | wswpShowEnum. Act i onMenu
}) ;}
Search
The following code renders the WorkSiteWebPart as Quick Search, Document Search, or
WorkSpace Search.
f unct i on openSear ch( )
{
ref resh(
{ qs: ' ?' ,
showFl ags: wswpShowEnum. For mTr ee | wswpShowEnum. Cont ent |wswpShowEnum. Vi ewMenu | wswpShowEnum. Act i onBar | wswpShowEnum. Act i onMenu |wswpShowEnum. Sear chType,
sel ect i onMode: sel ect i onModeEnum. Mul t i Sel ect
}) ;
}
Refresh Function
Each time the refresh( ) method of a JavaScript object is called, the following helper function is
invoked:f unct i on r ef r esh( dat a)
{
di spat ch( ' WebCont r ol ' , ' r ef resh' , dat a) ;
}
wher e
' WebCont r ol ' = t he i d of t he cont r ol .
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
36/114
Chapter 1: Using WorkSite Web ASP.Net and Java Script Controls
36 WorkSite Web Application Integration Toolkit Developers Guide
' r ef r esh' = t he met hod
' dat a' = t he set of parameter s t hat i s passed t o t he ref r esh( ) met hod
Using the WorkSite Web ASP.Net Control
Demo
The name of the WorkSite Web ASP.Net Control project file is
WorkSiteASP.NetControlsDemo.zip.
NOTE
To use this sample you must have WorkDocs or WorkSite Web 8.5 installed.
To install the WorkSite ASP.Net Control Demo:
1. Locate the WorkSiteASP.NetDemo.zip file located on the WorkSite Web installation CD.
2. Extract the WorkSiteASP.NetDemo.zip file to a folder on your local machine.
3. Create a virtual directory called "WorksiteAspNetDemo" and point it to this folder.
4. From the Browse dialog, type http://localhost/WorksiteAspNetDemo/Webcontrol.aspxto
launch the Demo.
The following files are included in the demo zip file:
Webcontrol.aspx This file contains both WebControl and Quick Search Control demo
Goto.aspx This file contains WebControl. This is used as "Zoomed in" Page when you
double click on any folder or workspace in Webcontrol.aspx
Search.aspx Shows the search form and result. This page is also used as target page
when you perform Quick Search in Webcontrol.aspx
NOTE
If you have WorkSite Web installed under a virtual directory other than the
default /worksite, you must open all the listed ASP.Net files and replace the VirtualPath="/
worksite with the appropriate value. The link "Workspace" has
a hard-coded workspace moniker. You will need to replace this with the appropriate monikerfrom your system.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
37/114
WorkSite Web Application Integration Toolkit Developers Guide
Chapter 2
Addressable URLs for WorkSite
Web Components Server
OverviewAddressable URLs are used to access WorkSite Web dialogs from within another Web
application. WorkSite Web dialogs have been carefully designed to be integrated with third
party applications. All dialogs accept query string parameters.
To streamline the user experience, you should enable auto trusted login on the WorkSite Web
Components Server. This eliminates the WorkSite Web login prompt. To set up auto trusted
login, consult the WorkSite Web Components Server Installation and Configuration Manual.
Importing Documents
Base URL:
ht t p: / / l ocal host / worksi t e81/ scri pt s/ CheckI n. aspx
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/CheckI n. aspx?dest =! nr t dms: 0: ! sessi on: t est - ser ver : ! dat abase: t est - db: ! f ol der : or di nary, 45789: &r edi r ect=htt p: / / www. yahoo. com
Table 9 Parameters to import documents
Parameter Description Acceptable Value(s)Addi tionalInformation
dest The IWOV moniker of thecontainer object in which thedocument(s) will be saved
nrtdms:0:!session:test-server:!database:test-db:!folder:ordinary,45789
The container must befor document folder ora database
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
38/114
Chapter 2: Addressable URLs for WorkSite Web Components Server
38 WorkSite Web Application Integration Toolkit Developers Guide
Addi tional Comments :
This callback function should only be used for importing documents that are not URL
documents.
The new moniker(s) for the imported document(s) can be retrieved by writing a custom callback
function in your HTML that the import dialog will call. See Using the WorkSite Web Dialog
Callback on page 51.
Importing an Existing Document as a New Version
Base URL:
ht t p: / / l ocal host/ worksi t e/ scr i pt s/ CheckI n. aspx
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/CheckI n. aspx?i mpor t =ver si on&nr t i d=! nr t dms: 0: ! sessi on: t est - server : ! database: t est -db: ! document : 229713, 5: &dest =! nr t dms: 0: ! sessi on: t est- server : ! database: t est- db: ! f ol der : or di nary, 45789: &r edi r ect =ht t p: / / www. yahoo. com
Table 10 Parameters to import an existing document as a new version
Parameter Description Acceptable Value(s)Addi tionalInformation
dest The IWOV moniker for thecontainer object into which thedocument is imported
!nrtdms:0:!session:test-server:!database:test-db:!folder:ordinary,45789:
The container shouldbe a document folderor database
nrtid The IWOV moniker for theobject on which the operationis being performed
nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
import Indicates a new version shouldbe created for the monikerpassed in the nrtidparameter
"version This value iscase-sensitive
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Table 9 Parameters to import documents
Parameter Description Acceptable Value(s)Addi tionalInformation
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
39/114
Overview
WorkSite Web Application Integration Toolkit Developers Guide
Importing a URL Document
Base URL:ht t p: / / l ocal host/ worksi t e/ scr i pt s/ CheckI n. aspx
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/CheckI n. aspx?i mpor t =ur l &dest=! nr t dms: 0: ! sessi on: t est- server : ! database: t est- db: ! fol der: ordi nary, 45789: &r edi r ect =ht t p: / / www. yahoo. com
Table 11 Parameters to import a URL document
Parameter Description Acceptable Value(s)Addi tionalInformation
dest The IWOV moniker for thecontainer object into which thedocument is imported
!nrtdms:0:!session:test-server:!database:test-db:!folder:ordinary,45789:
The container shouldbe a document folderor database only
import Indicates that a URL is beingimported
url This value iscase-sensitive
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Checking In Documents
Base URL:
ht t p: / / l ocal host/ worksi t e/ scr i pt s/ CheckI n. aspx
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/CheckI n. aspx?nr t i d=! nr t dms: 0: ! sessi on: t est - server : ! database: t est - db: ! document : 225386, 3: ! nr t dms: 0: ! sessi on: t est - server : ! database: t est - db: ! document : 225387, 2: &dest =! nr t dms: 0: ! sessi on: t est - ser ver : ! dat abase: t est - db: ! f ol der : or di nar y, 45789: &r edi rect=htt p: / / www. yahoo. com
Table 12 Parameters to check in documents
Parameter Description Acceptable Value(s)Addi tionalInformation
dest The IWOV moniker for thecontainer object into which thedocument is saved
!nrtdms:0:!session:test-server:!database:test-db:!folder:ordinary,45789:
The container shouldbe a document folderor database only
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
40/114
Chapter 2: Addressable URLs for WorkSite Web Components Server
40 WorkSite Web Application Integration Toolkit Developers Guide
Addi tional Comments :
The document(s) must be checked out.
Checking Out Documents
Base URL:
ht t p: / / l ocal host / worksi t e/ scri pt s/ Checkout . aspx
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/Checkout . aspx?nr t i d=! nr t dms: 0: ! sessi on: t est - server : ! dat abase: t est - db: ! document : 225386, 3: ! nr t dms: 0: ! sessi on: t est- server : ! database: t est - db: ! document : 225387, 2: ! n
nrtid The IWOV moniker(s) for theobject(s) on which theoperation is being performed
For a single operation:
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
For multiple operations:
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:^!nrtdms:0:!session:test-server:!database:test-db:!document:225364,2:^!nrtdms:0:!session:test-server:!database:test-db:!document:2397,1:
For multi-operation,monikers must beseparated usingconstantkMultiOpSeparator(character ^)asdefined in includes/common.js
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Table 12 Parameters to check in documents
Parameter Description Acceptable Value(s)Addi tionalInformation
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
41/114
Overview
WorkSite Web Application Integration Toolkit Developers Guide
r t dms: 0: ! sessi on: t est- server : ! dat abase: t est - db: ! document : 230119, 2: ! nr t dms: 0: ! sessi on: t est - ser ver : ! dat abase: t est - db: ! document : 230144, 1: &r edi r ect =ht t p: / /www. yahoo. com
Table 13 Parameters to check out documents
Parameter Description Acceptable Value(s)Addi tionalInformation
nrtid The IWOV moniker(s) for theobject(s) on which theoperation is being performed
For a single operation:
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
For multiple operations:
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:^!nrtdms:0:!session:test-server:!dat
abase:test-db:!document:225364,2:^!nrtdms:0:!session:test-server:!database:test-db:!document:2397,1:
For multi-operation,monikers must beseparated usingconstantkMultiOpSeparator(character ^)as defined in includes/common.js
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Downloading Documents
Base URL:
ht t p: / / l ocal host/ worksi t e/ scr i pt s/ Export . aspx
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
42/114
Chapter 2: Addressable URLs for WorkSite Web Components Server
42 WorkSite Web Application Integration Toolkit Developers Guide
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/Export . aspx?nr t i d=! nr t dms: 0: ! sessi on: t est - server : ! database: t est - db: ! document : 230147, 1: ! nr t dms: 0: ! sessi on: t est - server : ! database: t est- db: ! document : 230146, 1: &r edir ect=ht t p: / / www. yahoo. com
Table 14 Parameters to download documents
Parameter Description Acceptable Value(s)Addi tionalInformation
nrtid The IWOV moniker(s) for theobject(s) on which theoperation is being performed
For a single operation:
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
For multiple operations:
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:^!nrtdms:0:!session:test-server:!database:test-db:!document:225364,2:^!nrtdms:0:!session:test-server:!database:test-db:!document:2397,1:
For multi-operation,monikers must beseparated usingconstantkMultiOpSeparator(character ^)as defined in includes/
common.js
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Sending Documents via E-mail
Base URL:
ht t p: / / l ocal host / worksi t e/ scri pt s/ DocMai l To. aspx
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
43/114
Overview
WorkSite Web Application Integration Toolkit Developers Guide
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/DocMai l t o. aspx?l at est=0&i sLi nk=1&nr t i d=! nr t dms: 0: ! sessi on: t est- server : ! dat abase:t est - db: ! document : 229713, 5: &subj ect =Sendi ngDocument &r edi r ect =ht t p: / /www. yahoo. com
Table 15 Parameters for sending documents via e-mail
Parameter Description Acceptable Value(s)Addi tionalInformation
nrtid The IWOV moniker(s) for theobject(s) on which theoperation is being performed
For a single operation
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
For multiple operations
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:^!nrtdms:0:!session:test-server:!database:test-db:!document:225364,2:^!nrtdms:0:!session:test-server:!database:test-db:!document:2397,1:
Additional Info:Formulti-operation,monikers must beseparated usingconstantkMultiOpSeparator(character ^)
as defined in includes/common.js
latest Indicates the document versionto be used when constructingthe URL that will be sent in themessage. This only applieswhen the parameter isLink=1.
0 = Send a link to the versionspecified by the moniker
1 = Send a link to the latest versionof the document specified by themoniker
2 = Allow the user to select the
version when viewing the link
For multi-operation,this value applies to alldocuments specifiedin the nrtidparameter
isLink Indicates whether thedocument(s) should be sent asattachment(s) to the messageor as URL/NRL link(s)
0 = Documents are attached tomessage (latest parameter isignored)
1 = URL links created in the bodyof the message and NRL links sentas attachments
For multi-operation,this value applies to alldocuments specifiedin the nrtidparameter
subject The subject line of the emailmessage
Any string value
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Addi tional Comments :
WorkSite Web must connect to an SMTP server.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
44/114
Chapter 2: Addressable URLs for WorkSite Web Components Server
44 WorkSite Web Application Integration Toolkit Developers Guide
Viewing Document Versions
Base URL:ht t p: / / l ocal host / worksi t e/ scri pt s/ Home. aspx
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/Home. aspx?page=_r esource&docnr t i d=! nr t dms: 0: ! sessi on: t est - server : ! database: t est -db: ! document : 229713, 5: &doct mpl t =vers i on- t abl e&showpopup=1&r edi r ect =htt p: / /www. yahoo. com
Table 16 Parameters to view document versions
Parameter Description Acceptable Value(s)Addi tional
Informationpage _resource This value should be
constant
docnrtid The IWOV moniker for theobject on which the operationis being performed
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
doctmplt Indicates that versions arebeing requested for thedocument specified by thedocnrtidparameter
version-table This value iscase-sensitive
showpopup 1 This value should beconstant
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Viewing Related Documents
Base URL:
ht t p: / / l ocal host / worksi t e/ scri pt s/ Home. aspx
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
45/114
Overview
WorkSite Web Application Integration Toolkit Developers Guide
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/Home. aspx?page=_r esource&docnr t i d=! nr t dms: 0: ! sessi on: t est - server : ! database: t est -db: ! document : 229713, 5: &doct mpl t =r el ated- t abl e&showpopup=1&r edi r ect =htt p: / /www. yahoo. com
Table 17 Parameters to view related documents
Parameter Description Acceptable Value(s)Addi tionalInformation
page _resource This value should beconstant
docnrtid The IWOV moniker for theobject on which the operationis being performed
nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
doctmplt Indicates that related
documents are being requestedfor the document specified bythe docnrtid parameter
related-table This value is
case-sensitive
showpopup 1 This value should beconstant
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Viewing Document History
Base URL:
ht t p: / / l ocal host / worksi t e/ scri pt s/ Home. aspx
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/Home. aspx?page=_r esource&docnr t i d=! nr t dms: 0: ! sessi on: t est - server : ! database: t est -db: ! document : 229713, 5: &doct mpl t =hi st ory- t abl e&showpopup=1&r edi r ect =htt p: / /www. yahoo. com
Table 18 Parameter to view document history
Parameter Description Acceptable Value(s)Addi tionalInformation
page _resource This value should beconstant
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
46/114
Chapter 2: Addressable URLs for WorkSite Web Components Server
46 WorkSite Web Application Integration Toolkit Developers Guide
Viewing Where a Document Is Used
Base URL:
ht t p: / / l ocal host / worksi t e/ scri pt s/ Home. aspx
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/
Home. aspx?page=_r esource&docnr t i d=! nr t dms: 0: ! sessi on: t est - server : ! database: t est -db: ! document : 229713, 5: &doct mpl t =where- used- t abl e&showpopup=1&r edi r ect =ht t p: / /www. yahoo. com
nrtid The IWOV moniker for theobject on which the operationis being performed
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
doctmplt Indicates that the request is fordocument historyfor thedocument specified by thedocnrtid parameter
history-table This value iscase-sensitive
showpopup 1 This value should beconstant
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Table 19 Parameters for viewing where a document is used
Parameter Description Acceptable Value(s)Addi tionalInformation
page _resource This value should beconstant
nrtid The IWOV moniker for theobject on which the operationis being performed
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
doctmplt Indicates that the request is forfolders where the document isreferenced
where-used-table This value iscase-sensitive
showpopup 1 This value should beconstant
Table 18 Parameter to view document history
Parameter Description Acceptable Value(s)Addi tionalInformation
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
47/114
Overview
WorkSite Web Application Integration Toolkit Developers Guide
Viewing a Document in HTML Format
Base URL:
ht t p: / / l ocal host / worksi t e/ scri pt s/ Vi ewDoc. aspx
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/Vi ewDoc. aspx?nr t i d=! nr t dms: 0: ! sessi on: t est - server : ! database: t est - db: ! document : 229713, 5: &command=ok&i sHTML=1&r edi r ect =ht t p: / / www. yahoo. com
Table 20 Parameter for viewing a document in HTML format
Parameter Description Acceptable Value(s)Addi tionalInformation
nrtid The IWOV moniker for theobject on which the operationis being performed
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
command ok This value should beconstant. It is alsocase-sensitive.
ishtml 1 This value should beconstant
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Refiling a Document
Base URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/ Ref i l eEdi t . aspx
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Table 19 Parameters for viewing where a document is used
Parameter Description Acceptable Value(s)Addi tionalInformation
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
48/114
Chapter 2: Addressable URLs for WorkSite Web Components Server
48 WorkSite Web Application Integration Toolkit Developers Guide
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/Ref i l eEdi t . aspx?nr t i d=! nr t dms: 0: ! sessi on: t est - ser ver : ! dat abase: t est - db: ! document: 229713, 5: &par ent =! nr t dms: 0: ! sessi on: t est - ser ver : ! dat abase: t est - db: ! f ol der : or di nary, 45789: &r edi r ect=htt p: / / www. yahoo. com
Table 21 Parameter for refiling a document
Parameter Description Acceptable Value(s)Addi tionalInformation
nrtid The IWOV moniker for theobject on which the operationis being performed
For a single operation:
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
For multiple operations:
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:^!nrtdms:0:!session:test-server:!database:test-db:!document:225364,2:^!nrtdms:0:!session:test-server:!database:test-db:!document:2397,1:
For multi-operation,monikers must beseparated usingconstantkMultiOpSeparator(character ^)as defined in includes/
common.js
parent The IWOV moniker for thedocument folder from whichthe profile values are retrieved
!nrtdms:0:!session:test-server:!database:test-db:!folder:ordinary,45789:
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Editing or Viewing a Documents Properties
Base URL:
ht t p: / / l ocal host/ worksi t e/ scr i pt s/ DocProf i l e. aspx
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
49/114
Overview
WorkSite Web Application Integration Toolkit Developers Guide
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/DocPr of i l e. aspx?nr t i d=! nr t dms: 0: ! sessi on: t est - ser ver : ! dat abase: t est - db: ! document: 229713, 5: &r edi r ect=htt p: / / www. yahoo. com
Table 22 Parameter for editing or viewing a documents properties
Parameter Description Acceptable Value(s)Addi tionalInformation
nrtid The IWOV moniker for theobject on which the operationis being performed
!nrtdms:0:!session:test-server:!database:test-db:!document:225387,1:
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Editing or Viewing a Folder's Properties
Base URL:
ht t p: / / l ocal host/ worksi t e/ scr i pt s/ Fol derEdi t . aspx
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/Fol derEdi t . aspx?nr t i d=! nrt dms: 0: ! sessi on: t est - ser ver : ! dat abase: t est - db: ! f ol der : or di nar y, 45789: &op=edi t &r edi r ect=htt p: / / www. yahoo. com
Table 23 Parameter for editing or viewing a folder's properties
Parameter Description Acceptable Value(s)Addi tionalInformation
nrtid The IWOV moniker for theobject on which the operationis being performed
nrtdms:0:!session:test-server:!database:test-db:!folder:ordinary,45789:
op Indicates that the operationbeing performed is an edit
edit This value iscase-sensitive
redirect The URL to which the user isredirected upon completion of
the operation
Fully qualified URL
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
50/114
Chapter 2: Addressable URLs for WorkSite Web Components Server
50 WorkSite Web Application Integration Toolkit Developers Guide
Editing or Viewing a Workspace's Properties
Base URL:ht t p: / / l ocal host/ worksi t e/ scr i pt s/ Page. aspx
Sample URL:
ht t p: / / l ocal host / wor ksi t e/ scri pt s/ Page. aspx?page=! nr t dms: 0: ! sessi on: t est - server : ! database: t est- db: ! page: 37964: &op=edi t &r edi r ect =ht t p: / / www. yahoo. com
Table 24 Parameters for editing or viewing a Workspace's properties
Parameter Description Acceptable Value(s)Addi tionalInformation
page The IWOV moniker for theobject on which the operationis being performed
!nrtdms:0:!session:test-server:!database:test-db:!page:37964:
op Indicates that the operation beingperformed is an edit
edit This value iscase-sensitive
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Sending Links to Workspaces via Email
Base URL:
http://localhost/worksite/scripts/docMailto.aspx
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
51/114
Using the WorkSite Web Dialog Callback
WorkSite Web Application Integration Toolkit Developers Guide
Sample URL:
ht tp: / / l ocal host/ worksi t e/ scr i pts/docMai l t o. aspx?i sLi nk=1&nr t i d=! nr t dms: 0: ! sessi on: t est - ser ver : ! dat abase: t est - db: !page: 24904: ! nr t dms: 0: ! sessi on: t est - server : ! dat abase: t est - db: ! page: 43198: &subj ect =Sendi ngWorkspaces&r edi r ect =ht t p: / / www. yahoo. com
Table 25 Parameters for sending links to Workspaces via e-mail
Parameter Description Acceptable Value(s)Addi tionalInformation
nrtid The IWOV moniker(s) for theobject(s) on which theoperation is being performed
For a single operation:
!nrtdms:0:!session:test-server:!database:test-db:!page:24904:
For multiple operations:
!nrtdms:0:!session:test-server:!database:test-db:!page:24904:^!nrtdms:0:!session:test-server:!database:test-db:!page:43198:
For multi-operation,monikers must beseparated usingconstantkMultiOpSeparator(character ^)asdefined in includes/
common.js
isLink Indicates that a URL link toWorkSite Web should becreated in the body of themessage
1 = URL links to WorkSite Webcreated in the body of the message
This parameter mustbe set to 1 for thedialog to rendercorrectly
subject The subject line for the emailmessage
Any string value
redirect The URL to which the user isredirected upon completion ofthe operation
Fully qualified URL
Using the WorkSite Web Dialog Callback
The dialog callback feature in WorkSite Web allows a client-side Java Script function to be
called upon completion of an operation. For example, when you import new documents, the
Importdialog will send the new monikers for the documents to the callback function.
To use the dialog callback feature:
1. Open the import URL in a new window.2. Inside your HTML, define a function called worksiteDialogCallBackthat takes result as
an argument.
3. Write your custom code to utilize the result.nrtidsproperty. This property is an array and
can be accessed using a for-loop declaration.
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
52/114
Chapter 2: Addressable URLs for WorkSite Web Components Server
52 WorkSite Web Application Integration Toolkit Developers Guide
Example:
I mpor t Document t o WorkSi t eWeb
scr i pt >
f unct i on openLi nk( )
{
var url = "ht t p: / / l ocal host/ worksi t e/ scr i pt s/Checki n. aspx?dest =! nr t dms: 0: ! sessi on: t est - ser ver : ! dat abase: t est - db: ! f ol der : or di nary, 45789: " ;
wi ndow. open( url ) ;
}
f unct i on wor ksi t eDi al ogCal l Back( r esul t ){
f or ( var i =0; i < resul t . nrt i ds. l engt h; i ++)
{
/ / Put your cust omcode here to handl e t he arr ay of nr t i ds
al er t ( r esul t . nr t i ds[ i ] )
}
}
-
5/19/2018 WorkSite Web Application Integration Toolkit (8.5, English)
53/114
WorkSite Web Application Integration Toolkit Developers Guide
Chapter 3
Enhanced Browse Dialog
Overview
The classic browse dialog is very powerful. It allows users to navigate through the WorkSiteWeb hierarchy in search of WorkSite objects. However, there are two limitations to the classic
browse dialog. First, users cannot use WorkSite Webs search functionality to locate documents
or workspaces; they must navigate through the directory tree. Second, the classic browse dialog
supports single-item selection only. The enhanced browse dialog has been created to overcome
these limitations for developers and end-users. The following sections in this guide describe
how developers can leverage the features of the enhanced browse dialog with minimal coding
efforts.
Using Enhanced Browse DialogThe enhanced browse dialog object behaves similarly to the classic browse dialog object. You
invoke the enhanced browse dialog by using a WorkSite Web URL and passing special
parameters. When the user makes a selection and clicks the OKbutton on the enh