This page is maintained for older versions of Rapise only. The latest documentation can be found at: https://rapisedoc.inflectra.com
RVL Object

RVL Object

RVL Object

Some common tasks related to script execution, such as calling scripts, executing separate sheets, returning, exiting and bailing out is served by RVL.

Actions

DoPlayScript

DoPlayScript(/**String*/scriptPath, /**String*/sheetName)

Play RVL script using specified

  • scriptPath {/**string*/}: Path to script

  • sheetName {/**string*/}: Excel sheet containing the script

Exit

Exit(/**String*/ message, /**Boolean*/isError)

Break execution at the specified line

  • message {/**string*/}: Exit message

  • isError {/**boolean*/}: Specify 'false' if you want just exit without exit message

Return

Return(/**String*/ message)

Return from specified line. This method should be called from within RVL

  • message {/**string*/}: Return message

DoPlaySheet

DoPlaySheet(/**String*/sheetName)

Run current script from specified sheet

  • sheetName {/**string*/}: Sheet Name

Properties

CurrentScriptPath

** GetCurrentScriptPath() **

Return path to currently executed .rvl.xls file

CurrentScriptSheet

** GetCurrentScriptSheet() **

Return sheet name of the currently executed .rvl.xls file