AutomicBlog.com

a technical Automic Fan Blog

Jan. 10, 2012 at 08:50

Extend UserInterface functionality

A very handy feature of the UC4 UserInterface is the adaptable SendTo menu.
It enables you to activate external programs and internal objects directly from the context menu of the UserInterface, and pass objects or activities  as a parameter.
This means that you can extend UserInterface functionality, your custom new functions are then available with a simple mouse click.

Practical examples:

  • Setting up notifications for active tasks
  • Export multiple objects into individual XML files using the object name as a file name
  • Replicate activities to a different client / another UC4 system
  • Trigger mass object changes
  • ...

The feature

You can find a description of the feature in the UC4 Online Help on the page "UC_SENDTO and UC_SENDTO_ACT".

Short description:

  • To change the context menu for the UC4 Explorer -> adapt the variable object UC_SENDTO
  • To change the context menu for the Activity Window -> adapt the variable object UC_SENDTO_ACT
  • The settings of the variables are effective after the next logon
  • Enter the text for the menu item in the Validity Keyword
  • To activate a UC4 object from the menu, enter the object name in the Value column
    These parameters can be read with the :READ script statement:
    • &NAME#
    • &TYPE#
    • &RUN#  (only for tasks)
    • &LNR#  (only for tasks)
    • &PARENT_RUN#  (only for tasks)
    • &PARENT_NAME#  (only for tasks)
    • &PARENT_TYPE#  (only for tasks)
  • To enable an external program or script, enter the path and name of the program + the parameter -f%01 in the Value column
    %01 is replaced by the name of a temporary file that contains the IDs of the selected objects / activities.

As stated above, the UC4 documentation contains a detailed description.

Notifications for already active tasks

Using below objects, you can set up a Notification for on or more active Tasks directly from the context menu of the Activity Window. If a task ends successfully, you'll get a Notification of type "Message" within half a minute, if the task fails, you'll get an alert.

The SCRI is waiting for the end of the selected tasks and activates the Notification.

This entry in the variable UC_SENDTO_ACT sets up the entry in the context menu of the Activity Window:

 

Here you can download the two objects (v6.00 XML):
http://downloads.uc4blog.com/MONITOR_OBJECT.xml

Do not forget to enter a recipient in the Notification!

Generate individual XML export files

Since the SendTo action is performed separately for each selected item, the following simple script is all you need to export multiple objects with one click into individual XML files:

This is the corresponding entry in UC_SENDTO:

 

Here you can download the script (v6.00 XML):
http://downloads.uc4blog.com/SCRI_EXPORT_XMLS.xml

Do not forget to adapt the export-path &DESTDIR# in the script!

SendTo with external program

You can also invoke external programs with the SendTo functionality. In this case, UC4 generates a file with the name SEND_TO_n.txt in the bin directory of the UserInterface , the file contains either a list of OH_IDNRs or AH_IDNRs.

At first glance, there is no benefit in this, because in the internal call of an object you get  more information than just the ID, and you can then start  a job on any agent from there anyway.

As mentioned above, the internal call is executed individually for each object. For external programs, however, there's only one execution, and the file SEND_TO_n.txt contains all OH_IDNRs / AH_IDNRs of all selected objects. This method is therefore particularly useful for mass processing from the Activity Window, the UC4 Explorer or a search window.

Categories:
  • Administration,
  • Automation
Last modified on 10. January 2012 at 08:54

No comments for this entry

Welcome to my blog!

 

Welcome to my Automic-Tech-Blog

 

Here you can find technical articles on Automic Operations Manager (versions 6.00 and 8.00) and the Automic Auomation Engine (version 9.00).  I describe automation approaches, helpful SQL queries, and experiences with administration of a Automic OM system and its components.

I hope you find interesting articles, and I'm looking forward to your comments.

One last small note:

I have no direct connection to Automic or the Automic Software GmbH other than being a User of their software.

 


Name: Philipp Elmer
From: Austria

Automic-User since: Summer 2006

 

 

I'm a freelancer and started in December 2000 as a Unix operator. My job always included some form of batch-processing, process-automation and scheduling.

Before working with Automic, I already scheduled with cron ;-) , Maestro and Control-M.

Search