CatalogKeepAlive v1

../_images/CatalogKeepAlive-v1_dlg.png

CatalogKeepAlive dialog.

Summary

Refreshes the current session to the maximum amount provided by the catalog API.

Properties

Name Direction Type Default Description
Session Input string   The session information of the catalog to use.
TimePeriod Input number 1200 Frequency to refresh session in seconds. Default 1200 (20 minutes).

Description

This algorithm refreshes the current session to the maximum amount provided by the catalog API. This algorithm is run when CatalogLogin is executed.

Usage

Example - keeps the current session alive.

# Attempts to keep ALL sessions alive indefinitely.
CatalogKeepALive()

# Attempts to keep a specific session alive.
# This assumes the return value of CatalogLogin() is stored in session.
CatalogKeepALive(Session = session.getPropertyValue("Session"))

Categories: AlgorithmIndex | DataHandling\Catalog

Source

C++ source: CatalogKeepAlive.cpp (last modified: 2018-10-05)

C++ header: CatalogKeepAlive.h (last modified: 2018-10-05)