How To: Using the Macro Evaluator Plugin

Applies To:

All versions of Venafi Trust Protection Platform below 23.3


The Macro Evaluator is an internal tool used to test the functionality of macros or macro statements which can be embedded within each other to dynamically call information from different areas of of the Venafi Platform.  The Macro Evaluator is only available within the Logging Tree of the Windows Administration Console.


Accessing the Macro Evaluator:

  1. Start the Windows Administration Console
  2. Navigate to the Logging Tree
  3. Expand "Channels"
    Note: the Macro Evaluator can only be accessed on the support tab of an SMTP Channel (Email Template) object.  It does not make any changes to the SMTP Object, so it doesn't matter which channel you use.
  4. Locate any SMTP Channel (Email Template)
  5. Click on the Support Tab
  6. Click on the "Macro Evaluator" Tab



Using the Macro Evaluator:


(A) Evaluate This button processes the Input for macros and causes the Output window to refresh
(B) Description This is a dropdown list (not in alphabetical order) that has a list of all defined events available in the product. Selecting an event populate the "ID" field and the "Input" window with the default translation for the event. 
(C) Event ID Shows the Event ID in decimal (integer) format.  This is the same format it is stored in the database.
(D) Component Events are always logged against a component or identity in the Venafi Product.  Use the DN or Identity selectors to choose an object to simulate the Event you chose in the Description Drop Down.
(E) Text1 Events typically store variable information to provide information not just that an event happened, but specific variables about the event.  For example, when someone updates and object in Web Admin, an "Admin UI - Object Updated" event is triggered and "Text1" contains the information of who updated and "Text2" contains information about what they updated.  Different events store different types of information.
(F) Text2 Same purpose as Text1.  Best way to learn how to feels these out is to grab an event from the Default SQL Channel that you want to send emails off of. When you export the log to CSV you will see the Text1,Text2,Value1,Value2 for the event.  Use that to fill in these fields to make your simulated event more accurate.  Text1 and Text2 can contain string type of data, which means letters, numbers, special characters, spaces, etc.
(G) Value1 Always an Integer (number).  For example, in an expiration event, this stores how many days until a certificate expires.  In a Certificate Download event from Web Admin, it stores if the Private Key was included or not in the download by using a 0=no private key and 1=private key was included
(H) Value2 Same purpose as Value2 
(I) Input This is a text field where you can type out what your email message will say and test the various macros you would like to use the in message.  Clicking Evaluate will process your macros.
(J) Output  This is the output of the macros that you put in the Input text field. The window is read-only
Was this article helpful?
1 out of 1 found this helpful