Question
Coforge DPA UK Ltd.
IN
Last activity: 19 Aug 2017 5:29 EDT
How to know the syntax for writing utilities using Pega Components?
Hi,
I want to write utility function(s) in which I need to access clipboard page and other pega related OOTB components. How can I get the help on the syntax for this?
In some existing utility functions i could see some syntax but for me it's like puzzling in knowing how to use these kind of syntax.
Examples of the syntax I have seen in the existing utility functions:
PublicAPI tools = pega_rules_utilities.getPublicAPI();
tools.getDatabase().doesInstanceExist(aObjectHandle); etc.?
Thanks,
Durgarao J.
***Updated by moderator: Lochan to add Categories***
Coforge DPA UK Ltd.
IN
Thanks Ranjr.
I'm aware that we need to use engine API.
I'm looking for the help on using the syntax of Pega components like Clipboard page, other pages etc. in the example mentioned above, there is a keyword used 'tools","getPublicAPI", "getDatabase()"method etc. how can I get the help on using these type of keywords or syntax? I can see the classes, methods available from engine api but I'm not getting the basic information on how to get started using them in Java step.
Example:
PublicAPI tools = pega_rules_utilities.getPublicAPI();
tools.getDatabase().doesInstanceExist(aObjectHandle);
Coforge DPA UK Ltd.
IN
Somewhere in the Help page I have read the below information:
The keyword "tools" identifies the PublicAPI interface in Java calls.
The PublicAPI includes these classes:
Somewhere in the Help page I have read the below information:
The keyword "tools" identifies the PublicAPI interface in Java calls.
The PublicAPI includes these classes:
com.pega.pegarules.pub.*; // Classes common to most public interfaces.
com.pega.pegarules.pub.clipboard.*; //Clipboard, Page, and Property
com.pega.pegarules.pub.context.*; // Requestor, Thread, and Node
com.pega.pegarules.pub.database.*; // Relational database access
com.pega.pegarules.pub.dictionary.*; // Dictionary validation interface
com.pega.pegarules.pub.generator.*; // Java generation
com.pega.pegarules.pub.pal.*; // Reports statistics about a Thread
com.pega.pegarules.pub.runtime.*; //Activities, Models, Whens, Streams
com.pega.pegarules.pub.util.*; // Miscellaneous utilities
Pegasystems Inc.
US
Also to access the PublicAPI you can have a look into this link and to know more about any keywords in Pega you can open the Pega Help > Index > search for "tools" for an example as shown in the attachment and open "tools java variable" and "tools keyword" for further information.