Understanding Certify.exe
Certify.exe is a command-prompt program that gives you the ability to execute Certify test processes without the use of the standard Certify user interface. This program also allows you to automate test execution from batch files or other automation products, such as schedulers or business rules engines.
The Certify.exe program is located in the main Client installation directory. This program requires a Certify client and Microsoft .NET installed on the machine. Certify updates Certify.exe by pulling a new file from the auto-update folder and overwriting the local Certify.exe file.
The program can be started from a:
- Microsoft Windows DOS Command prompt
- Windows Run dialog
- DOS batch file
If the Certify client directory is in either the system or user search path on the machine, DOS batch files that are not located in the main Certify client installation folder calls the program by using a fully-qualified path or by program name.
Parameters
Listed in the table below are the parameters needed to create processes to run in Certify.exe.
|
Parameter |
Value |
Required Field |
|
actionTimeout |
Set the timeout in minutes for process execution when the execution engine does not receive a response from the interface. Valid values are listed below: Default (no timeout) 1 - 120 minute(s) |
No |
|
Attribute |
Attributename|Attributevalue Attributename|Attributevalue1|Attributevalue2 Multiple instances are allowed with this parameter. |
Yes/No Depends on whether the attribute is required. |
|
Authentication |
False (default) True Use Windows authentication mode when connecting to the database, and the DBUser and DBPassword values will be ignored. |
No |
|
CaptureScreenOn |
CaptureNone (Default value) CaptureAbortedSteps CaptureFailedSteps CaptureScreenOn |
No |
|
certifyconnectionid |
Access database connection details through Worksoft Portal. |
Yes |
|
CertifyConnectUrl |
Certify Connect Url (/ccurl) |
No |
|
CreateOutputLocation |
False (Default) True When True, the Certify Results directory will be created if it does not already exist. |
No |
|
DataSourceConfigurationName (/dscn) |
Certify Connect Data Source Configuration Name |
No |
|
DBName |
Database name |
Yes |
|
DBPassword |
Database user password |
Yes |
|
DBServer |
Database server name |
Yes |
|
DBUser |
Database user name |
Yes |
|
DisableLogging |
Disable logging (/DisableLogging) Values: False (Default) and True |
No |
|
Help |
Display the usage of the command line |
No |
|
Layout |
Fully qualified Certify layout name |
No |
|
LogStepMode |
LogAllSteps (Default) LogAbortedSteps LogFailedSteps |
No |
|
OutputFile |
File system path for generating an output XML file The path should end in .xml. Default value is blank. |
No |
|
OutputLocation |
Fully qualified Certify log folder name |
No |
|
OutputPDF |
File system path for generating an output PDF file The path should end in .pdf. |
No |
|
Output PDFType |
Output PDF report type (/OutputPDFType) Values: ProcessExecution (Default) and ProcessExecutionRecordset |
No |
|
Password |
Certify user password |
Yes |
|
persistentToken |
If you are using Worksoft single sign-on (SSO) authentication, you need to use a persistent token instead of a username and password. First, generate a token in the Worksoft Portal in the User Administration page. Copy the token to the clipboard and add persistentToken={token} to the Certify command line. Tokens are generally in the form of a 64-character long alphanumeric string. |
Yes |
|
Process |
Fully-qualified Certify process name |
Yes |
|
ProcessId |
Process ID (/pid) |
No |
|
Project |
Project name |
Yes |
|
QCResultXML |
File system path for generating an output XML file The path should end in .xml This parameter is specifically used as a part of our integration with Micro Focus ALM/Quality Center. Default value is blank. |
No |
|
Recordset |
Certify recordset name |
No |
|
RecordsetMode |
Read (Default) Append Clear and Append Read and Update |
No |
|
ScreenCaptureMode |
CaptureDeskTop (Default) CaptureActiveWindow |
No |
|
StepDelay |
0 - 100 Default value is 0. |
No |
|
StopOnFailure |
False (Default) True |
No |
|
Title |
Title of execution file Default value is [Process name] - [time stamp] |
No |
|
UseCertifyConfig |
Use the user ID and password from the Certify Configuration file. Values: False (Default) and True |
No |
|
UseProcessData |
False (Default) True |
No |
|
User |
Certify user name |
Yes |
|
Verbose |
False (Default) True |
No |
|
XmlOutputType |
PartialOutput (Default) FullOutput If FullOutput is designated, then the generated output XML file will contain all details about the result—each process, each step, recordset data, images, etc... If PartialOutput is designated, then the XML file will contain only high level details. |
No |
Command Line Format
The Certify.exe program parses command line arguments formatted as name value pairs separated by one or more spaces.
Example:
Certify.exe/name=value<sp>/name="value<sp>value"<sp>/name=value<sp>/...
- The space <sp> character is a special character and is used as a parsing delimiter.
- The name string cannot contain any space characters.
- If the value string contains any space characters, then the value must have opening and closing quotation marks ( " " ).
Name Value Format
The Certify.exe program parses each name value pair from the command line arguments into separate name and value strings.
The equal ( = ) character is considered a special character and is used as a parsing delimiter. The name string cannot contain equal ( = ) characters.
The program validates each name string against the following set of rules:
- Each name string must start with a leading forward slash ( / ).
- Names are not case sensitive.
- Each name string, excluding the leading slash ( / ) must exactly match a supported option name.
- Required options must be present in the command line.
- Parameters that do not allow multiple instances in the command line must have only one instance.
Process, Layout, and Log Folder Names Format
Valid processes, layouts, and log folder names must have a fully-qualified format and must contain the following:
- Project name
- All folder names
- Name of the specific item
The path separator can be a back slash ( \ ) character or a forward slash ( / ) character.
Examples:
Project1\Folder1\Folder2\Process1
Project2\Folder1\Layout1
Project2\Folder2\LogFolder2
Folder names cannot contain the following characters:
- Forward slash ( / )
- Backward slash ( \ )
- Pipe ( | )
- Opening and closing quotation marks ( " " )
If you use a folder name with one of these characters, an error will be generated, and the process will be aborted.
Attribute String Format
Valid attribute strings can have list values. The pipe ( | ) character is considered a special character that is used in delimiting list values of an attribute.
Example:
Name|Value
Process Examples
Example 1: Basic Process
Certify.exe/dbserver=localhost /dbname="worksoft test" /dbuser=user /dbpassword=password /project="test project" /user=jsmith /password=password /process="test process"
Example 2: Process with Layout and Recordset
Certify.exe/dbserver=localhost /dbname="worksoft testdb" /dbuser=user /dbpassword=password /project="test2 project" /user=kjones /password=password /process="test2 process" /layout="test2 project\test folder\test layout" /recordset="test recordset" /recordsetmode=read /outputlocation="test2 project\worksoft result folder"
Example 3: Process with Attributes
Certify.exe/dbserver=localhost /dbname=worksoft /dbuser=user /dbpassword=password /project=worksoftproject /user=jsmith /password=password /process="testproject\testfolder\testprocess" /layout="testproject\testfolder\test layout" /recordset="test recordset" /recordsetmode=read /outputlocation="test2 project\test result folder" /attribute="name|value1|value2"
Related Topics