LogoLogo
3.6.9
3.6.9
  • Introduction
  • Getting started
    • Installation
      • Prerequisites
        • Server requirements
      • On-premises
        • Single-node
          • Directory structure
        • Multi-node
      • Azure Market Place
      • AWS Market Place
    • Tutorials
      • Amazon AWS CUR
      • Amazon AWS CUR (Athena)
      • Azure Stack
      • Azure EA
      • Azure CSP
      • Google Cloud
      • VMware vCloud
      • VMware vCenter
    • How-to guides
      • How to configure receiving a monthly billing report
      • How to automatically trigger a monthly billing report
      • How to update your license
      • How to store contract information with an Account in a report
      • How to automatically send workflow errors as webhooks to a monitoring system
    • Concepts
      • User interface
      • Services
    • Releases
      • Upgrading to version 3
      • Known issues
      • Announcements
      • Archive
  • Reports
    • Accounts
    • Services
    • Instances
    • Summary
    • Budget
  • Services
    • Manage
    • Rates
      • Tiered Services
        • Aggregation Levels and the Account Hierarchy
    • Adjustments
    • Subscriptions
  • ACCOUNTS
    • Budget management
  • Data pipelines
    • Extract
      • Configuration
      • Extractor templates
      • Script basics
      • Parslets
      • Subroutines
        • check_dateformat
        • check_dateargument
        • format_date
        • validate_response
      • Language
        • aws_sign_string
        • basename
        • buffer
        • csv
        • clear
        • decimal_to_ipv4
        • discard
        • encode
        • encrypt
        • environment
        • escape
        • exit_loop
        • foreach
        • generate_jwt
        • get_last_day_of
        • gosub
        • gunzip
        • hash
        • http
        • if
        • ipv4_to_decimal
        • json
        • loglevel
        • loop
        • lowercase
        • match
        • pause
        • print
        • return
        • save
        • set
        • subroutine
        • terminate
        • unzip
        • uppercase
        • uri
        • var
    • Transform
      • Configuration
      • Transformer templates
      • Transform Preview
      • Language
        • aggregate
        • append
        • calculate
        • capitalise
        • convert
        • copy
        • correlate
        • create
        • default
        • delete
        • dequote
        • environment
        • event_to_usage
        • export
        • finish
        • Functions
        • if
        • import
        • include
        • lowercase
        • normalise
        • option
        • rename
        • replace
        • round
        • services
        • set
        • sort
        • split
        • terminate
        • timecolumns
        • timerender
        • timestamp
        • update_service
        • uppercase
        • var
        • where
    • Datasets
    • Lookups
    • Metadata
    • Reports
    • Workflows
  • Administration
    • User management
      • Users
      • Groups
    • Notifications
      • Budget Notifications
      • Report notifications
      • Workflow notifications
    • Settings
      • Global Variables
      • White Labeling
  • Advanced
    • Integrate
      • GUI automation
        • Examples
      • API docs
      • Single sign-on
        • Claims-based identity provisioning: users, Account access and user groups
        • Azure-AD
        • Auth0
        • OKTA
        • OneLogin
        • ADFS
        • LDAP
    • Digging deeper
      • Authentication flows
      • Transformer datadate
      • Dataset lifecycle
      • Config.json
      • Databases
  • Security
    • Security
    • Authentication
      • Token
      • LDAP
      • SAML2
    • Password reset
    • Password policy
    • Announcements
  • Troubleshooting
    • Logs
  • Terms & Conditions
  • Privacy Policy
Powered by GitBook
On this page
  • session
  • .login
  • .logout
  • .refreshToken
  • .apiRoot
  • navigate
  • .home
  • .to
  • report
  • .byId
  • .depth
  • .daterangeStart
  • .daterangeEnd
  • .filterAccount
  • .showSingleAccount
  • .showAllSummaries
  • .showConsolidatedSummaries
  • .showSummaryAccounts
  • .showSummaryServices
  • .showSummaryInstances
  • .summaryGroupInstanceBy
  • wait
  • .ms
  • .networkIdle
  • .syncComplete

Was this helpful?

Export as PDF
  1. Advanced
  2. Integrate

GUI automation

The GUI automation API consists of a set of JavaScript functions which enables programmatic access to some features normally controlled by a user in the GUI. These functions are grouped in a global window.Exivity object.

session

Control the current user session.

.login

function(string username, string password): void Attempts to login given the username and password.

.logout

function(): void Logs out the current user, and cleans up local storage used by the current session.

.refreshToken

function(string token): void Attempts to use the given token to login (always refreshes the given token).

.apiRoot

function(string root): void Set the domain (e.g. https://example.com:8002) for the Exivity API.

navigate

Navigate the GUI.

.home

function(): void Navigate to the root URL of the Exivity instance, which is the Dashboard if a user is currently logged in, or the login page otherwise.

.to

function(string path): void Navigates to the given URL fragment.

report

Control the report filters and more.

.byId

function(int id): void Select a report definition.

.depth

function(int depth): void Select a reporting depth.

.daterangeStart

function(string start): void Select the reporting start date, in YYYYMMDD format.

.daterangeEnd

function(string end): void Select the reporting end date, in YYYYMMDD format.

.filterAccount

function(int id): void Filter the report by showing only this account.

.showSingleAccount

.showAllSummaries

function(bool show = true): void Show all summaries if on the /reports/summary page.

.showConsolidatedSummaries

function(bool show = true): void Show consolidated summary on the /reports/summary page.

.showSummaryAccounts

function(bool show = true): void Show accounts on the summary report.

.showSummaryServices

function(bool show = true): void Show services on the summary report.

.showSummaryInstances

function(bool show = true): void Show instances on the summary report.

.summaryGroupInstanceBy

function(string key): void Group the instances on the summary report by this key. The key argument should be one of: instances, services.

wait

.ms

function(int|float ms): Promise Wait for ms and then resolve the returned promise.

.networkIdle

function(int waitBefore = 100, int waitAfter = 100, int timeout = 60000): Promise Wait for the network stack to become idle, optionally specifying:

  • A timeout before starting to detect network traffic

  • A timeout after detecting that the network became idle

  • A timeout after which the promise will reject. Set to 0 to disable.

.syncComplete

function(): Promise Wait for data synchronization to complete.

PreviousIntegrateNextExamples

Last updated 3 years ago

Was this helpful?

function(bool show = true): void On the summary report, show only the single account set with .

Functions returning a to make it easier to determine the state of the GUI.

Promise
filterAccount