Skip to main content
Version: 8.1

system.perspective.print

This function is used in Python Scripting.

Description​

Prints the supplied message to the local console (or the gateway logs, as appropriate) - by default, this means the Output Console when in the Designer, and the browser's console when in a live session.

Syntax​

system.perspective.print([message], [sessionId], [pageId], [destination])

Parameters​

TypeParameterDescription
StringmessageThe print statement that will be displayed on the console. [optional]
StringsessionIdIdentifier of the Session to target. If omitted, the current Session will be used automatically. When targeting a different session, then the pageId parameter must be included in the call. [optional]
StringpageIdIdentifier of the page to target. If omitted, the current Page will be used automatically. [optional]
StringdestinationWhere the message should be printed. If specified, must be "client", "gateway", or "all". Default is "client". [optional]

Returns​

Nothing

Scope​

Gateway, Perspective Session

note

This function will only work in the Gateway scope if both sessionId and pageId are supplied to the call.

Code Examples​

Code Snippet

# Sends print statement to the gateway logs.
system.perspective.print(message="Hello World", destination="gateway")

Keywords​

system perspective print, perspective.print