This is a driver template for use as a resource driver, including the Inventory Driver functions (remove "Inventory" directory if not using).

CREATE WITH Driver Builder v5.1 GA

Features

* External Configuration file - change driver settings without recompiling

* Debug logging - Enable or disable with config file.  Limits log size configurable), keeps history

* Email Function - Configure outgoing settings in config file.  Optional email attachment

* TestShellAPI initialization

External Configuration File

By storing global values that may change between different execution environment in an external config file, driver portability is increased.  Values can be configured without recompiling the driver.

• See attached default config file.  Gets loaded by init with values populated in Project.Params matrix
• File is CSV format.

•  "##" at start of line indicates comment.  Blank lines are ignored.  
•  [PramName],[ParamValue],[Optional Comment]

• To change, modify Project.ConfigFile in driver

Debug Logging

The function WriteLog provides a simple debug log interface.  Init function checks for the file (name and path set in DriverConfig.csv), maintains a maximum file size (DebugLogMaxKB), and archives 5 most recent files when they reach maximum size.

• Enable or disable debug log with DebugLogEnabled config param
• Input is a string value - function automatically adds date/time stamp and visual separator

Email Function

Enables the driver to send email notifications to users via SendMail function 

• Configure outgoing mail server parameters in external config file
• Check the server settings to determine if SSL is required or if anonymous send is allowed
• Provide recipient address, subject, message, and optional attachment
• If attachment path is not found, email is sent with note indicating missing attachment

TestShellAPI Initialization

• Uses Project.APISession to maintain open session through driver execution
• APILogin function allows logging in as any user

• e.g. use {reservation('Username',2)}, {reservation('Password',2)}, and {reservation('Domain',2)} to log in using the credentials of the reservation owner
• Use Project.Params('AdminUser',1) and Project.Params('AdminPassword',1) to login in as admin if necessary (set in external config file)