Go to Robotic Automation version 22.1 documentation

CallScript

Use the CallScript component to display a script within a Pega Robot Studio solution. To use CallScript, insert variables (designated as tokens) in the script and then supply values to the tokens through automation logic. You can display the CallScript where needed, such as a pop-up window on a computer screen or on a separate device, such as a handheld device.

The component has these properties, methods, and events. For more information, see General Component Properties, Methods, and Events.

 

Properties

Property

Description

BackColor

The background color of the CallScript window.

DisplayStyle

Sets the look and feel of the CallScript window that displays when the component’s show method has been called. Your options are:

  • Popup – Select this option to have the CallScript Component display as a pop-up window on the screen. For more information, see CallScript popup example.

  • Device – Select this option to have the CallScript Component display as a hand-held organizer device For more information, see CallScript device example.

Font

The font used for text displayed in the CallScript window.

ReadOnly

Set to True to make the CallScript window read-only. (Boolean)

Script

Use this property to enter the script to display in the CallScript window. When you browse this property, the CallScript Editor is displayed. You can type a script directly in this editor or upload a text file of the script. To insert variables (tokens) in the script, enclose the token name in curly brackets { and }. The tokens appear as data points on the CallScript design block.

TopMost

Set to True to have the CallScript window appear as the top window on the end user's screen. (Boolean)

WordWrap

Set to True to enable word wrapping of the script. (Boolean)

ZoomFactor

Integer setting from 1 (actual font size) to 6 (six times the initial font size). Your entry controls the size of the text displayed in the CallScript window.

Message

The resulting text that displays in the CallScript after input has been received for the tokens. For example, if the script is: Hello {title} {Lastname} and you output the Message, the result will be "Hello" or Hello followed by whatever input has been received by the title and Lastname tokens for the CallScript component.

 

Events

Event

Description

Complete

Occurs when the script has been written to the CallScript component.

 

 

Methods

Method

Description

Parameters

Result type

Show

Displays the CallScript Component to the screen using the designated Display Style property.

None

Void

Hide

Hides the CallScript Component from the display.

Note: Do not use this method when automating applications because some applications and controls must be on an active desktop and visible.

None

Void

 

 

Related information

CallScript Device Example

CallScript Popup Example

Using the CallScript Component

 


Privacy | Trademarks | Terms of Use | Feedback

Updated: 01 July 2024

© 2016 - 2024 Pegasystems Inc.  Cambridge, MA All rights reserved.

 

OpenSpan data classification label