Follow

How To: Using the Macro Evaluator Plugin

Applies To:

All versions of Venafi Encryption Director 6.1 through 11

All versions of Venafi Trust Protection Platform 14.1 and up

About:

The Macro Evaluator is an internal tool that used to test the functionality of macros or macro statements as they 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.

 

The main function is to be able to test macros used in notifications.  The macro allows you to simulate an event that is logged in the database and how notification macros will respond according to that event.

Getting Access:

Currently, Macro Evaluator is an unsupported tool that is not released with the the standard product.  It is only available to customers upon request from Venafi Customer Support.

Installation:

The Macro Evaluator is self-contained in a file "WinTestMacro.dll".  The WinTestMacro.dll file needs to be specific to your version of Director.

  1. Download the WinTestMacro.zip from your FTP folder at https://ftp.venafi.com.  It will only be there if you have requested it from Customer Support and they have agreed to provide it.  Venafi Customer Support may not approve all requests for access to this tool.
  2. Unzip the contents of the archive package to locate the WinTestMacro.dll
  3. Close the Windows Administration Console if you currently have it open
  4. Copy the WinTestMacro.dll into C:\Program Files\Venafi\Drivers\Win Plugins
    Note: the location of your Venafi installation may be different if you did not install in the default location during installation.
  5. There is a possibility that the dll is has been blocked by the Operating System, to verify that the dll is unblocked, right click->properties, and select "unblock" in the general tab. If there is no unblock option the dll is not blocked.
  6. Start the Windows Administration Console
  7. Navigate to the Logging Tree
  8. 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.
  9. Locate any SMTP Channel (Email Template)
  10. Click on the Support Tab
  11. Click on the "Macro Evaluator" Tab
    2014-04-18_8-16-53.png

Upgrading

When you upgrade your version of the Venafi Trust Protection Platform, the WinTestMacro.dll is not automatically removed, and may not be compatible with the version you are upgrading too.  Remove the WinTestMacro.dll from the "C:\Program Files\Venafi\Drivers\Win Plugins" folder prior to upgrading.  Request the new version of WinTestMacro.dll from Venafi Customer Support for the version of the product you have upgraded to and and re-apply the updated file in the same manner you did on the previous version.

Using the Macro Evaluator:

2014-04-18_8-29-21.png

(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?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk