Tuesday, May 27, 2014

URL Tools in Clarity

Flushing the Cache 
http://{Server}/niku/app?action=security.caches
http://{Server}/niku/nu#action:security.caches



A : This undocumented page in the Clarity GUI allows the administrator to clear the application
caches, either selectively or all-at-once. Using this page is an alternative to the trusted
"start and stop" the app services method of picking up configuration changes or forcing the system
to refresh pages from the application server.

Whilst this is "unsupported" by CA, it is generally accepted that this functionality can be used. The
alternative to using the hidden functionality is to "stop and restart" the app service.

The functionality can be accessed by administration users in all current versions of Clarity (7.5.x to 12)


Q : Running XOG from the Clarity Application URL 
http://{Server}/niku/app?action=xog.client
http://{Server}/niku/nu#action:xog.client

NOTE From v13.3 this hidden page has been removed from the GUI (for performance/stability reasons) - see this thread for some detail.

A : This undocumented page provides a simple XOG client. Type (paste) the XOG XML into the
top window, press "Run" and the output will appear in the lower window.

You should NOT build any integration solutions that rely on this screen, the normal XOG functionality
is the only CA-supported way of integrating data to Clarity.

The functionality can be accessed by administration users in all current versions of Clarity (7.5.x to 13.2)



Q : Viewing / releasing locks 
http://{Server}/niku/app?action=security.locks
http://{Server}/niku/nu#action:security.locks

A : This undocumented page provides an overview of all system "locks".
For example "Import Export Lock" is a project that is currently locked (being editted in OWB/MSP),
the other available lock types refelect system functionality.

(This screen is displaying the contents of the PRLOCK table)

But you should NOT really be "clearing locks" using this screen unless explicty directed to by CA-Support


Q : Viewing the LOG Files from the application 
http://{Server}/niku/nu#action:security.logs

A : This page in the Clarity GUI allows an admin user access to the server log files without having to access the CSA

This functionality can be accessed by administration users in only the later versions of Clarity (i.e. starting v13) and only on TOMCAT installations.
Using this "hidden page" should not replace normal access to log files through the CSA or directly on the server itself.


Q : Web Services Interface (WSDL) 
http://{server}/niku/wsdl

A : This page is the starting point of the system documentation for the web-services provided
by your application. CA-provided actions/queries will be found here, along with any custom
NSQL queries you have built. All are available to be call via a web-service from YOUR web-service
enabled client. Of course it is up to YOU / your systems integrator to "code" the client end of this
relationship.

This page is documented is the CA-provided "Integration Guide"