• <GetStart>
  • CSPro User's Guide
    • The CSPro System
    • Data Dictionary Module
    • The CSPro Language
    • Data Entry Module
    • Batch Editing Applications
    • Tabulation Applications
    • Data Sources
    • CSPro Statements and Functions
    • Templated Reporting System
    • HTML and JavaScript Integration
    • Action Invoker
      • Overview
      • Execution Environments
      • Security and Formatting Options
      • Base Actions
      • Application Namespace
      • Clipboard Namespace
      • Data Namespace
      • Dictionary Namespace
      • File Namespace
      • Hash Namespace
      • Localhost Namespace
      • Logic Namespace
      • Message Namespace
      • Path Namespace
      • Settings Namespace
      • Sqlite Namespace
      • System Namespace
      • UI Namespace
    • Appendix
  • <CSEntry>
  • <CSBatch>
  • <CSTab>
  • <DataViewer>
  • <TextView>
  • <TblView>
  • <CSFreq>
  • <CSDeploy>
  • <CSPack>
  • <CSDiff>
  • <CSConcat>
  • <Excel2CSPro>
  • <CSExport>
  • <CSIndex>
  • <CSReFmt>
  • <CSSort>
  • <ParadataConcat>
  • <ParadataViewer>
  • <CSCode>
  • <CSDocument>
  • <CSView>
  • <CSWeb>

Action Invoker Overview

The Action Invoker is a system that executes routines, called "actions," in a standard way across a variety of environments. Similar to CSPro logic functions, each action takes some number of arguments, required and optional, and generally returns a result.
Most actions are part of a namespace, a grouping of related functionality. The actions are summarized on the namespace pages, the alphabetical list of functions page, and in action-specific documentation. Additionally, the actions are described in a parsable format in a file included with CSPro: C:\Program Files (x86)\CSPro 8.0\action-definitions.json.
Execution Environments
Action Invoker actions can be run in a variety of ways, with each format described on one of following pages:
  • CSPro Logic
  • JavaScript (embedded)
  • JavaScript (run from web views)
  • JSON
  • Android Intent
For security purposes you may have to use an access token when using the Action Invoker from JavaScript run from web views, or when using an Android Intent.
Functionality
The following actions are not part of a namespace:
ActionDescription
executeExecutes an action with the action name specified as an argument.
registerAccessTokenRegisters an access token to provide access to the Action Invoker from external callers.
The following namespaces contain related actions, described further on each namespace page:
NamespaceDescription
ApplicationActions to interact with an application and its components.
ClipboardActions to access the device's clipboard.
DataActions to interact with data sources.
DictionaryActions to interact with dictionaries.
FileActions to read from and write to files, and to manipulate files on the file system.
HashActions to create hash values.
LocalhostActions to create localhost URLs that can be used to serve content from the local file system or from memory.
LogicActions to interact with CSPro logic and an application's symbols.
MessageActions to work with messages and to format text.
PathActions to query information about the file system or to perform operations on a path.
SettingsActions to set and retrieve settings that persist across application runs.
SqliteActions to work with SQLite databases.
SystemActions to interact with system resources.
UIActions to display HTML dialogs, interact with web views, and otherwise work with the system's user interface.