Shell commands reference

Thi page lists shell commands you can use to administer Axway Decision Insight (DI). Such commands must be executed in the DI shell. Shell commands are not case sensitive.

For information about how to access the shell, see Access the shell.

Help

helplist

Display the list of all available commands.

g! helplist
calcium:createCheckpoint - Creates a consistent checkpoint in the storage and wait for it to be fully processed by all nodes in the platform.
calcium:decodeTransactionTime - Decode a given transaction time
calcium:encodeTransactionTime - Encode a transaction time from a given timeStamp, counter and nodeId
calcium:getAutomaticCheckpointCreationInterval - Gets the interval that separates automatic checkpoint creations.
...

platform:help

Display the manual of a command.

Shortcuts: h

g! platform:help displayLicence
displaylicence - Displays the current active licence
   scope: platform


g! h displayLicence
displaylicence - Displays the current active licence
   scope: platform

General purpose

displayLicence

Display the product license you are currently using. Useful information is validity dates and cluster ID.

g! displayLicence
2013-02-04 13:42:49,126 [Gogo shell] INFO platform.licenceCommand - -------------------------------------------------------------------------------
2013-02-04 13:42:49,127 [Gogo shell] INFO platform.licenceCommand - Licence currently installed...
2013-02-04 13:42:49,129 [Gogo shell] INFO platform.licenceCommand -
2013-02-04 13:42:49,130 [Gogo shell] INFO platform.licenceCommand - licenceId:
2013-02-04 13:42:49,131 [Gogo shell] INFO platform.licenceCommand -     groupId      com.systar.licence-bundle.systar-rd
2013-02-04 13:42:49,132 [Gogo shell] INFO platform.licenceCommand -     artifactId   tornado-dev
2013-02-04 13:42:49,133 [Gogo shell] INFO platform.licenceCommand -     versionId    1.0.0
2013-02-04 13:42:49,135 [Gogo shell] INFO platform.licenceCommand -
2013-02-04 13:42:49,137 [Gogo shell] INFO platform.licenceCommand - validity:
2013-02-04 13:42:49,139 [Gogo shell] INFO platform.licenceCommand -     after        2013-02-01T01:00:00+0100
2013-02-04 13:42:49,140 [Gogo shell] INFO platform.licenceCommand -     before       2013-08-01T02:00:00+0200
2013-02-04 13:42:49,141 [Gogo shell] INFO platform.licenceCommand -
2013-02-04 13:42:49,142 [Gogo shell] INFO platform.licenceCommand - roles:
2013-02-04 13:42:49,144 [Gogo shell] INFO platform.licenceCommand -     role         development
2013-02-04 13:42:49,145 [Gogo shell] INFO platform.licenceCommand -
2013-02-04 13:42:49,146 [Gogo shell] INFO platform.licenceCommand - licensor:
2013-02-04 13:42:49,147 [Gogo shell] INFO platform.licenceCommand -     name         Systar S.A.
2013-02-04 13:42:49,148 [Gogo shell] INFO platform.licenceCommand -     contact      tornado@systar.com
2013-02-04 13:42:49,149 [Gogo shell] INFO platform.licenceCommand -
2013-02-04 13:42:49,150 [Gogo shell] INFO platform.licenceCommand - licensee:
2013-02-04 13:42:49,151 [Gogo shell] INFO platform.licenceCommand -     name         Systar S.A.
2013-02-04 13:42:49,154 [Gogo shell] INFO platform.licenceCommand -     contact      tornado@systar.com
2013-02-04 13:42:49,159 [Gogo shell] INFO platform.licenceCommand -
2013-02-04 13:42:49,160 [Gogo shell] INFO platform.licenceCommand - platform:
2013-02-04 13:42:49,161 [Gogo shell] INFO platform.licenceCommand -     clusterId    0000000B-0001-0000
2013-02-04 13:42:49,162 [Gogo shell] INFO platform.licenceCommand -
2013-02-04 13:42:49,163 [Gogo shell] INFO platform.licenceCommand - -------------------------------------------------------------------------------


exit 0

Stop DI and create a checkpoint.

g! exit 0
2013-02-04 15:40:47,643 [FelixStartLevel] INFO platform - Stopping Gluon platform
2013-02-04 15:40:47,647 [FelixStartLevel] INFO platform.extender - Stopping all domains
...
2013-02-04 15:40:50,931 [FelixStartLevel] INFO platform - Gluon platform stopped
2013-02-04 15:40:50,935 [FelixStartLevel] INFO platform - Stopping JMX connector at address service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi
2013-02-04 15:40:50,936 [FelixStartLevel] INFO platform - ###############################################################################
2013-02-04 15:40:50,937 [FelixStartLevel] INFO platform - #                                                                             #
2013-02-04 15:40:50,938 [FelixStartLevel] INFO platform - #   PLATFORM STOPPED                                                          #
2013-02-04 15:40:50,939 [FelixStartLevel] INFO platform - #                                                                             #
2013-02-04 15:40:50,940 [FelixStartLevel] INFO platform - ###############################################################################

User management

listUsers

List the existing users.

g! listUsers
Users:
	hharris
	jlewis
	mtaylor

readUser

Display information of a user. This command takes the name of the user as parameter.

g! readUser hharris
User 'hharris':
	First name: Helen
	Last name: Harris
	Email: helen.harris@systar.com
	Description: 
	Development mode: false
	Account disabled: false

createUser

Create a user.

This command takes the following parameters:

name Name of the user, cannot be empty
firstName First name of the user, can be empty
lastName Last name of the user, can be empty
email E-mail of the user, can be empty
description Description of the user, can be empty
password

Password of the user, can be empty

If empty, a password is randomly

generated.

creationDate Date using ISO8601 format without milliseconds and timezone (ex: "2013-08-06T14:00:00"). Some special values are also accepted: "today", "yesterday", "FROM_START". Cannot be in future, can be empty (default: "NOW")
g! createUser rmartin "Ruth" "Martin" "" "" "" NOW
User 'rmartin' created

updateUserAttribute

Update an attribute of the user. Supported attributes are: firstName, lastName, email, description.

This command takes the following parameters:

name Name of the user, cannot be empty
attribute Name of the attribute, cannot be empty
value New value of the attribute, can be empty
g! updateUserAttribute rmartin email rmartin@systar.com
User 'rmartin' updated

enableUser / disableUser

Enable or disable a user. Disabled users cannot log on to DI. These commands take the name of the user as a parameter.

g! disableUser rmartin
User 'rmartin' disabled

changePassword

Change the password of a user. The current password must be specified and verified in order to perform the operation.

The command takes the following parameters:

name Name of the user, cannot be empty
currentPassword Current password of the user, cannot be empty
newPassword New password of the user, cannot be empty
g! changePassword rmartin 'systar' 'QPgKb3kDw2jc+'
Password changed on user 'rmartin'

setUserPassword

Set the password of a user.

The command takes the following parameters:

name Name of the user, cannot be empty
newPassword New password of the user, cannot be empty
g! setUserPassword rmartin 'QPgKb3kDw2jc+'
Password changed on user 'rmartin'

deleteUser

Delete a user.

The command takes the following parameters:

name Name of the user, cannot be empty
g! deleteUser rmartin
User 'rmartin' deleted

resetPassword

Reset the password of a user. The new password takes a random value, it is only displayed in the console. This command takes the name of the user as parameter.

g! resetPassword rmartin
Password reset to 'xwA+-aByaeo3q-8' on user 'rmartin'

exportUsers

Export all users defined in the deployment into a file that you can then import into another deployment.

g! exportUsers "C:\\export.user.xml"
Users successfully exported into [C:\export.user.xml]

importUsers

Import all users defined in a file into the deployment.

If a user present in the file already exists in the deployment, its properties and password are overwritten.

g! importUsers "C:\\export.user.xml" NOW
Users from [C:\export.user.xml] successfully imported into the platform.

Applications management

listApplications

List all applications installed on the deployment.

g! listApplications
Applications: 
- 00000002-0001-0001-13a9-323f1b301801 : HVP for Operational Supervisor (Intraday)

listApplicationSpaces

List the spaces of an application.

g! listApplicationSpaces 00000002-0001-0001-13a9-323f1b301801
Spaces of HVP for Operational Supervisor (Intraday): 
- hvp
- hvpConfiguration
- hvpClassifier
- hvp analysis
- 5a3c3ae2-1019-4e0f-853a-b41c41149424 : HOME
- bacd4274-1e40-4c56-8c76-9026dfa1227a : DEADLINE - CURRENT
- 226718c2-5e9f-4668-bc51-fdb468c73a87 : PAYMENT DETAILS
- 567cbe46-5948-4076-96c5-d61d683e5554 : DEADLINE - DONE
- decd55b5-5032-457d-88c4-fb5c7899c15f : PILING UP
- 052c1914-7fcc-4893-b062-7ab2e70d1763 : MISSING WORK
- 39314efb-2d87-4787-b9fc-fca070bc7462 : MINI DASHBOARD
- 215c5012-341f-4853-966d-fa1ac5eb0680 : ABOVE PROFILE

importApplication

Import an application from a file.

g! importApplication "C:\backup\hvp.appx" 2013-01-01T00:00:00
Application file 'hvp.appx' successfully imported into the platform

For more information read: Importing an application from the shell

exportApplication

Export an application to a file.

g! exportApplication "C:\backup\hvp.appx" 00000002-0001-0001-13a9-323f1b301801
Application 'HVP for Operational Supervisor (Intraday)' successfully exported into 'C:\backup\hvp.appx'

For more information read: Exporting an application from the shell

generateIndicatorUsageReport

Short command is giur.

Generate the indicator usage report.

The results are displayed in CSV format.


Column Description
1
Indicator UUID
The internal key of the indicator
2
Entities
The entity containing the indicator
3
Name
The name of the indicator
4
Type
The type of the indicator
5
Is configured
Boolean saying if the indicator is configured (manually or computed)
6
Is computed
Boolean saying if the indicator is a computed one
7
Dashboard usages
The number of dashboards that use this indicator/attribute
8
Indicator usages
The number of indicators that depend on this indicator
9
Event usages
The number of events based on this indicator
10
Queries usages
The number of queries using this indicator
11
Mapping usages
The number of mappings writting on this indicator
12
Read usages
The number of components (dashboards, indicators, queries, events) that read this indicator
13
Write usages

The number of write usages - A write usage is a configured indicator or a mapping usage.

14
Total usages
The number of read and write usages
15
Useful read usages
The number of useful components (dashboards, useful indicators, queries, events) that read this indicator
16
Useful write usages
The number of useful write usages - A useful write usage is a configured indicator with all input having at least one useful write usage or a mapping usage
17
Useful total usages
The number of useful read and write usages
g! giur
Indicator UUID;Entities;Name;Type;Is configured;Is computed;Dashboard usages;Indicator usages;Event usages;Queries usages;Mapping usages;Read usages;Write usages;Total usages;Useful read usages;Useful write usages;Useful total usages
00000002-0001-0001-13a9-32491c500001;Process;inProcessCountThresholdLevel;ThresholdLevel;true;false;0;1;0;0;0;1;1;2;1;1;2
00000002-0001-0001-13a9-324a0c100001;Process;acquiredCurrentDayCountBaselineMultiplier;BaselineThresholdMultiplier;true;false;1;1;0;0;0;2;1;3;2;1;3

Computing

changeDefaultComputingRhythm

Change the default computing rhythm.

This command takes the following parameters:

Scalar Scalar value, cannot be empty
Duration type Duration type : (hours/minutes/seconds), cannot be empty
g! changeDefaultComputingRhythm 1 hours
Change default computing rhythm to {1 hours}

For more information read: Default computing trigger management

displayDefaultComputingRhythm

Display the default computing rhythm.


g! displayDefaultComputingRhythm
Default computing rhythm {1 hours}

For more information read: Default computing trigger management

changeDefaultComputingLag

Change the default computing lag.

This command takes the following parameters:

Scalar Scalar value, cannot be empty
Duration type Duration type : (hours/minutes/seconds), cannot be empty
g! changedefaultcomputinglag 2 seconds
Change default lag to {2 seconds}

For more information, see Default computing trigger management.

displayDefaultComputingLag

Display the default computing lag.

g! displaydefaultcomputinglag
Default lag {2 seconds}

For more information, see Default computing trigger management.

Security

printSecurityReport

Generate a report and display its content in the shell.

For more information, see Security reports

exportSecurityReport

Generate a report and create a file with its content.

For more information, see Security reports

Data management

purgeStorage

Launch a purge command to all stores of all nodes.

For more information, see Purge data

validateCheckpoint

Validate the checksum of all HV files referenced in a checkpoint. Because HV files can be huge, their checksum is not automatically validated at run time, this command allows you do to it. The checkpoint name is passed as parameter, it can be found by the listCheckpoints command.

truncateApplications

This command must not be used on a production server. It must only be executed on a development server.

Clear all applicative data. It might be useful if you want to reinject monitoring data again from an empty database.

This command does not clear the following:

  • Instances (and their attribute values) of Entities of type Configuration
  • Images
  • IconSets
  • Classifiers
  • Deployment data (users, applications, spaces, rhythms, ...)

The size of the database is not reduced with this command. Data is still present on disk but ignored.

Debugging

resolveInstanceId

Resolve an instance by its ID at most current Transaction Time and display its details.

This command takes the following parameters:

instanceId The instance ID, cannot be empty
g! resolveInstanceId 1518325978083887105
Id 1518325978083887105 corresponds to UUID 00000002-0001-0001-13a9-325356e00001 of entity 00000001-0000-0000-12e0-a9e9d3600000 (Indicator).

resolveInstanceUUID

Resolve an instance by its UUID at most current Transaction Time and display its details.

This command takes the following parameters:

instanceUUID The instance UUID found in log error messages, cannot be empty
g! resolveInstanceUUID 00000002-0001-0001-13a9-325356e00001
UUID 00000002-0001-0001-13a9-325356e00001 corresponds to Id 1518325978083887105 of entity 00000001-0000-0000-12e0-a9e9d3600000 (Indicator).

Data integration

resendEventsByName

Resend events for one particular event endpoint. For more information, see Resend events for one particular event endpoint.

resendEventsBySpaceKey

Resend events for all event endpoints of a space. For more information, see Resend events for all event endpoints of a space.

Related Links