nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

FormAPI events

niniti

"User script in a DCT does not use browser's events or DOM. The user
script only needs to interact with FormAPI events. "

This is what I find in manual. Now business user can log in to TeamSite from any machine, he just types in URL of the server and login page is displayed on his browser.

IWEventRegistry is FormAPI method. How does this method get called on the client computer ? how does his browser get FormAPI methods loaded on client computer ? What I mean to ask is, the DCT is displayed on the client computer as a form. Now this form has user script which contains FormAPI methods. So when this user script is called in action, does it make a server call to execute this FormAPI method or is it executed on client computer only ? If its executed without making server call, how will client computer understand these methods unless they are loaded on client's machine ?

What I nderstand is "FormAPI is a class, which has several methods contain in it." In order to use these methods, FormAPI class need to be instantiated. At what point of time is this FormAPI instantiated ?

thanks

Find more posts tagged with

Comments

Adam Stoller

FormAPI is a layered JavaScript interface - JavaScript is interpreted by browsers - so when the DCT form is loaded, it includes a necessary javascript code to allow FormAPI functions to be recognized and do what they need to.

If you want to load other javascript files into the DCT - you specify it within the DCT and, assuming those files can be found, their functions will be available too.

Does that help?

niniti

1) When we include <script> tag in DCT, does it include FormAPI or do I have to specify to include FormAPI in the script tag ? What do I need to specify in the script tag ?
Following code includes organization.js javascript in the DCT.

<script language="javascript" location="template-type"
src="organization.js"/>

If I want to use FormAPI in DCT, di I need to specify source like in above example or I just need to mention <script> tag in the DCt and it will include FormAPI by default in DCT ? Can I include FormAPI methods in external javascript file ? e.g. can I include FormAPI methods in organization.js in above code ?

2) FormAPI is javascript API. Is that just a class or package ? IWDatacapture, IWEvenRegistry, IWDCRInfo etc are classes of the FormAPI package or are they methods of the FormAPI class ?

BTW your answers are quite helpful, most of the times these answers fill in the gaps left by the manuals.

thanks

niniti

1) When we include "script" tag in DCT, does it include FormAPI or do I have to specify to include FormAPI in the "script" tag ? What do I need to specify in the "script" tag ?
Following code includes organization.js javascript in the DCT.
[html]<script language="javascript" location="template-type"
src="organization.js"/>[/html]
If I want to use FormAPI in DCT, do I need to specify source like in above example or I just need to mention script tag in the DCt and it will include FormAPI by default in DCT ? Can I include FormAPI methods in external javascript file ? e.g. can I include FormAPI methods in organization.js in above code ?

2) FormAPI is javascript API. Is that just a class or package ? IWDatacapture, IWEvenRegistry, IWDCRInfo etc are classes of the FormAPI package or are they methods of the FormAPI class ?

BTW your answers are quite helpful, most of the times these answers fill in the gaps left by the manuals.

thanks

ISCBorisB

When we include "script" tag in DCT, does it include FormAPI...

FormAPI itself is always included, you do not have to do anything.

Can I include FormAPI methods in external javascript file...What do I need to specify in the "script" tag

Yes you can. <script> Tag allows you to abstract out your own FormAPI Code into dedicated JS Libraries. Tag's
attributes are clearly documented in FormAPI Manual.

FormAPI is javascript API. Is that just a class...

FormAPI is a JS Package, to use the term somewhat loosely. IWDatacapture, IWEvenRegistry etc are FormAPI JS Classes.

suppressed.jpg

niniti

When I use "script" tag, FormAPI is included by default with script tag. So even if we dont want to use FormAPI classes, they are still loaded in DCT by default. Its like java.lang package in a java class, right ?

FormAPI is a js package and IWDataCapture, IWEventRegistry etc are its js classes.

Can I use FormAPI in any the design of any HTML page, which is independent of TeamSite DCT ? Or "script" tag in the DCT only can load FormAPI ? I knowe that FormAPI is proprietory to interwoven. So is FoemAPI customized to load with script tag in DCT ? If we can include FormAPI in any HTML independent of DCT, how to do that (I am asking only for knowledge sake, dont intend to use it anyway). I am trying to grasp, how FormAPI resource can be used.

thanks

Adam Stoller

When I use "script" tag, FormAPI is included by default with script tag. So even if we dont want to use FormAPI classes, they are still loaded in DCT by default. Its like java.lang package in a java class, right ?

FormAPI is a js package and IWDataCapture, IWEventRegistry etc are its js classes.

Can I use FormAPI in any the design of any HTML page, which is independent of TeamSite DCT ? Or "script" tag in the DCT only can load FormAPI ? I knowe that FormAPI is proprietory to interwoven. So is FoemAPI customized to load with script tag in DCT ? If we can include FormAPI in any HTML independent of DCT, how to do that (I am asking only for knowledge sake, dont intend to use it anyway). I am trying to grasp, how FormAPI resource can be used.

thanks

Let me expand on an answer you've already been given:

FormAPI itself is always included, you do not have to do anything.

It is included because the code that renders the DCT form includes it itself - regardless of whether you have a script tag in your DCT.

FormAPI outside the context of a DCT form is kind of meaningless so I'm not sure why you'd even be asking about it as such.

niniti

I did not elicit from the answers given that FormAPI is loaded whether "script" tag is there in DCT or not. Thanks for that clarification. Now I understand what happens on the server side.

On the client side, browser is the only software which intrpretes these xml tags. Browser can understand HTML and JavaScript only. If DCT tags are not converted to HTML tags, how will browser interpret these XML tags.

Following excerpts are from the manual
"The user script does not interact with the browser document object model (DOM)interface to the HTML form. Instead, FormAPI provides methods to query and set the values of items in the form."

1) Even if user script interacts with browser DOM, how will browser interpret these XML tags , if they are not converted to HTML tags by the TS before sending them to client side browser ?

2) If XML tags are converted to HTML tags by TS before sending the document to browser, how will browser understand the XPath, which is based on xml elements ? Will the browser understand XPath by the name attribute of the elements ? i.e. name attribute will still be the same even though xml tags are converted to browser understandable HTML tags.

Please clarify the client side mechanism.

thanks

Display.jpg

Adam Stoller

If you just try to look at a DCR in a browser - no - there won't be any FormAPI and it won't know what to do with the XML other than display it as code (or complain about not finding the DTD)

The Edit DCR window is a browser-based application - and it is the application which interprets the DCT's XML code and generates the appropriate HTML and javascript code which is then sent to the browser to be rendered / interpreted there.

Bring up an Edit DCR window on the DCT of your choice - then right-click in it and do View Source.