Skip to content

Spira

Use Spira object to communicate with Spira during playback of tests. With Spira object you may do such things as launching a test set and creating an incident. Requires Rapise 7.2+

Action Summary

Action Description
CreateIncident Creates an incident in Spira.
RunTestSet Schedules a test set to execute as soon as possible.

Action Detail

CreateIncident

Creates an incident in Spira..

Spira.CreateIncident(name, description, projectNameOrId)

Parameters:

Name Type Description
name string Subject of an incident.
description string Description of an incident
projectNameOrId string Name or ID of a Spira project to add the incident.

Returns:

number: ID of created incident or 0 in case of error.

RunTestSet

Schedules a test set to execute as soon as possible.

Spira.RunTestSet(nameOrId, token, projectNameOrId, utcTime, utcDate)

Parameters:

Name Type Description
nameOrId Name or ID of the Test Set to run.
token string Automation host token.
Optional.
projectNameOrId string Name or ID of a Spira project that contains the Test Set.
Optional.
utcTime string UTC time, formatted as HH:mm or HH:mm:ss, e.g. 16:45. Default time is current time.
Optional.
utcDate string UTC date, formatted as YYYY-MM-DD, e.g. 2024-12-19. Default value is current date.
Optional.

Returns:

boolean: true if the test set scheduled successfully, otherwise - false.