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:{}

short form = 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:

  • 0 (default is no timeout)
  • 1 - 120 minute(s)

No

/attribute:<string>

short form = /Attribute

Format is Name|Value Name|Value. (short form /Attribute)

Attributename|Attributevalue

Attributename|Attributevalue1|Attributevalue2

Multiple instances are allowed with this parameter.

Yes/No

Depends on whether the attribute is required.

/authentication[+|-]

short form = /Authentication

Use Windows authentication mode when connecting to the database, and the DBUser and DBPassword values will be ignored.

  • False (default)
  • True

No

/bpplanguage:<string>

short form = /BPPLanguage

Language for report:

  • English (default)
  • French
  • German

English/French/GermanBPP

No

/bppreportname:<string>

short form = /BPPReportName

BPP report name

No

/capturestringon:<string>

short form = CaptureScreenOn
  • CaptureNone (Default value)
  • CaptureAbortedSteps
  • CaptureAllSteps
  • CaptureFailedSteps
  • CaptureAbortedAndFailedSteps
  • CaptureScreenOn
  • WindowChange

No

/certifyConnectionID:<string>

short form = certifyconnectionid

Access database connection details through Worksoft Portal.

Yes

/createoutputlocation[+|-]

short form = CreateOutputLocation

When True, the Certify Results directory will be created if it does not already exist.

  • False (Default)
  • True

No

/dbname:<string>

short form = DBName

Database name

Yes

/dbpassword:<string>

short name = DBPassword

Database user password

Yes

/dbserver:<string>

short form = DBServer

Database server name

Yes

/dbuser:<string>

short form = DBUser

Database user name

Yes

/disablelogging[+|-]

short form = DisableLogging

Disable logging

  • False (default)
  • True

No

/errorlogfile:<string>

short form = ErrorLogFile

Error log file

Default value is blank.

No

/executionfailthreshold:{}

short form = ExecutionFailThreshold

Set the number of failed steps, after which the execution will halt.

  • 0 (default)
  • 1 - 1000

No

/executionTimeout:{}

short form = executiontimeout

Set the number of minutes after the execution times out.

  • 0 (default)
  • 1 - 3000

No

/help:<string>

short form = Help

Display the usage of the command line

No

/interactive[+|-]

short form = Interactive

Interactive

  • False (default)
  • True

No

/layout:<string>

short form = Layout

Fully qualified Certify layout name

You should start with the first-level folder name and not start with the project name or slash (short form /Layout).

No

/licenseSessionId:{Empty}

short form = /licensesessionid

License session ID

If the license is valid, Certify will use it for execution and not obtain a new license.

Yes

/logstepmode:<string>

short form = LogStepMode

Logging steps

  • LogAllSteps (default)
  • LogAbortedSteps
  • LogFailedSteps
  • LogProcessOnly
  • LogStatusOnly
  • LogDisabled

No

/outputfile:<string>

short form = OutputFile

File system path for generating an output XML file

The path should end in .xml.

Default value is blank.

No

/outputlocation:<string>

short form = OutputLocation

Fully qualified Certify log folder name

You should start with the first-level folder name and not start with the project name or slash (short form /OutputLocation).

No

/outputpdf:<string>

short form = OutputPDF

File system path for generating an output PDF file

The path should end in .pdf.

Default value is blank.

No

/outputpdftype:<string>

short form = OutputPDFType

Output PDF report type:

  • processexecution (default)
  • processexecutionsummary
  • processexecutionrecordset
  • bppgenerated

No

/password:<string>

short form = /Password

Certify user password

Yes

/persistentToken:<string>

short form = Persistent Token

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:<string>

short form = Process

Fully-qualified Certify process name

You should start with the first-level folder name and not start with the project name or slash (short form /Process).

Yes

/processid:<string>

short form = pid

Process ID

No

/project:<string>

short form = Project

Project name

Yes

/qcintegrationuser:<string>

short form = /QCIntegrationUser

QC integration user name

Yes

/qcresultxml:<string>

short form = 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:<string>

short form = Recordset

Certify recordset name

No

/recordsetmode:<string>

short form = RecordsetMode

Recordset mode

  • Read Only (default)
  • Append
  • Clear and Append
  • Read and Update

No

/rpaModelID:{Empty}

short form = RPA Model ID

It takes the unique ID of the RPA model that needs to be executed.

No

/screencapturemode:<string>

short form = ScreenCaptureMode

Screen capture mode

  • CaptureDeskTop (default)
  • CaptureActiveWindow

No

/screenshotHistoryCount:<int>

short form = sshc

Set the number of step screenshots prior to a failed step.

  • 3 (default)
  • 0 - 5

No

/skipresults[+|-]

short form = SkipResults

Select to open the Results window after the process execution.

  • False (default)
  • True

No

/stepdelay:<decimal>

short form = StepDelay

Enter the number of seconds that you want to delay between each step of your execution.

Step delay helps resolve timing issues when testing your application.

  • 0 (default)
  • 1 - 100

No

/stoponfailure[+|-]

short form = StopOnFailure

Stop execution when a failure is encountered in your process. Failure includes failed and aborted steps.

  • False (default)
  • True

No

/SuppressAttachment:<string>

short form = Suppress Attachments

Suppress attachments

  • False (default)
  • True

No

/title:<string>

short form = Title

Title of execution file

Default value is [Process name] - [time stamp]

No

/usecertifyconfig[+|-]

short form = UseCertifyConfig

Use the user ID and password from the Certify Configuration file.

  • False (default)
  • True

No

/useprocessdata[+|-]

short form = UseProcessData

Use process data.

  • False (default)
  • True

No

/user name/user:<string>

short form = User

Certify user name

Yes

/verbose[+|-]

short form = Verbose

Verbose

  • False (default)
  • True

No

/xmloutputtype:<string>

short form = XmlOutputType

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.

  • PartialOutput (default)
  • FullOutput

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 Link IconRelated Topics