TeamSite_16.3_FormAPI_Reference_en_rev1.pdf - TeamSite FormAPI Reference Guide Release 16.3 TM OpenText TeamSite TeamSite FormAPI Reference Guide Rev

TeamSite_16.3_FormAPI_Reference_en_rev1.pdf - TeamSite...

This preview shows page 1 - 5 out of 94 pages.

TeamSite FormAPI Reference Guide Release 16.3
Image of page 1
OpenText TM TeamSite TeamSite FormAPI Reference Guide Rev.: October 2017 This documentation has been created for software version 16.3. It is also valid for subsequent software versions as long as no new document version is shipped with the product or is published at . Open Text Corporation 275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1 Tel: +1-519-888-7111 Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440 Fax: +1-519-888-0677 Support: For more information, visit Copyright © 2017 Open Text. All Rights Reserved. Trademarks owned by Open Text. Disclaimer No Warranties and Limitation of Liability Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However, Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the accuracy of this publication.
Image of page 2
Table of Contents Chapter 1: Overview 7 Chapter 2: Use FormAPI 9 The Content Template <script> tag 9 Initialization 11 Addressing 11 Addressing and Form Tabs 11 Addressing Syntax 12 Use Item Addresses 13 Address Examples 14 Example 1: Container Addresses 14 Example 2: Replicant Addresses 14 Example 3: Mixed Content Addresses 14 Example 4: Address Parents and Siblings 15 Get and Set Item Values 16 Restore Dynamic Options 17 Empty Options 18 Events 18 Visibility and Read-Only 19 Validation and Highlight Mode 21 Examples 23 Remote Server Calls 24 Auto-DCR Functionality 26 How FormAPI Changes FormsPublisher 27 Hidden vs Invisible 27 <readonly> vs setReadonly() 27 CGI Callouts 27 Use FormAPI with TagUI Rulesets 29 Use FormAPI with WorkFlow Modeler 29 Chapter 3: FormAPI Reference 30 Data Capture Form - IWDatacapture 33 IWDatacapture.callServer (url, data, isGet) 34 Frame (top level of data capture form/parent).getScriptFrame () 34 Boolean IWDatacapture.clearFormInfoMessage () 35 IWDatacapture.close (confirmClose) 35 IWDatacapture.displayMessage (message) 35 IWDatacapture.enableImagePreview (enable) 35 number IWDatacapture.getCurrentPageNumber () 36 string IWDatacapture.getDCRPath () 36 FormAPI Reference Guide FormAPI (16.3) Page 3 of 94
Image of page 3
string IWDatacapture.getDCTPath () 36 string IWDatacapture.getFilePath () 36 string IWDatacapture.getFormType () 37 string[] IWDatacapture.getGroups () 37 IWItem IWDatacapture.getItem (name) 37 number IWDatacapture.getPageCount () 37 string[] IWDatacapture.getRoles () 38 IWItem[] IWDatacapture.getRootItems () 38 string IWDatacapture.getUser () 38 string IWDatacapture.getWorkarea () 38 IWDatacapture.gotoPage (pagenumber) 38 Boolean IWDatacapture.isHighlightMode () 39 Boolean IWDatacapture.isModified () 39 IWDatacapture.postFormInfoMessage (messageText) 39 IWDatacapture.save () 39 IWDatacapture.setHighlightMode (highlightMode) 40 IWDatacapture.setIsModified () 40 Content Template Items - IWItem 40 iwitem.addErrorMessage (messageText) 40 iwitem.addInstance (index, [choice_name]) 41 iwitem.addOption (option) 41 iwitem.clearErrorMessages () 41 iwitem.clearMessage 42 Boolean iwitem.deleteInstance (index) 42 IWItem iwitem.getChildByName (name) 42 IWItem[] iwitem.getChildren ()
Image of page 4
Image of page 5

  • Left Quote Icon

    Student Picture

  • Left Quote Icon

    Student Picture

  • Left Quote Icon

    Student Picture