Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 26 Next »

Sisense supports executing ElastiCube related commands using the Windows command line.

To access the shell (psm.exe):

  • Open the command line and go to C:\Program Files\Sisense\Prism. Type in psm.exe to access the main menu.

psm

Available Commands

Note

The attributes and their examples below are case sensitive.


CommandDescriptionParameters
ecube buildBuilds an ElastiCube from an ecube file or server-hosted ElastCube.
  • filename: defines the name of the ecube file that contains the ElastiCube schema to use for building the ElastiCube on the target server

    About ecube files

    Your data model or schema is saved in an ecube file. ecube files contain the schema and the data connection settings required for building your ElastiCube. The ecube file does not contain raw data. After building your ElastiCube from an ecube file, your ElastiCube data is stored in an ecdata file.

  • name: Defines the name of the ElastCube to be built on the target server.
  • serverAddress: Defines the target server address on which the ElastCube should be built.
  • mode: Defines the mode in which the ElastCube should be built. Available modes:
    • mode=restart: Rebuilds the ElastiCube from scratch.
    • mode=full: Rebuilds the ElastiCube and accumulates data for tables defined as accumulative. This mode should only be used for accumulative builds.
    • mode=changes: Rebuilds from scratch tables that have changed in the ElastiCube schema.
    • mode=metadataonly: Updates the ElastiCube server with the ElastiCube schema, without building.

doc Changedatasource

Note: This command works with Sisense version 4.

Changes the data source to another data source.
  • file:  The prism document file name to open and convert.
  • prev: The previous data source.
  • new: The new data source.
ecube edit connection database

Modifies the the database connection attributes.

The following data sources are supported:

  • MS SQL Server
  • Oracle
  • MySQL
  • PostgreSQL
  • DB2
  • Teradata
  • Salesforce
  • Zendesk
  • Splunk
  • ecube: defines the ecube file name to edit
  • server: defines the source database to modify (leave empty to modify all databases in server)
  • database: defines the source database to modify
  • newserver: defines the new server address (leave empty to keep previous value)
  • newdatabase: the new database (leave empty to keep previous value)
  • newusername: defines the new username (leave empty to keep previous value)
  • newpassword: defines the new password (leave empty to keep previous value)
  • backup: defines whether to back up the ElastiCube file (defaults is true)
Example
psm ecube edit connection database ecube="c:\users\myuser\documents\mycube.ecube"server="10.0.0.1" database="tracking" newserver="localhost" newdatabase="trackingX" newusername="mynewuser" newpassword="newpassword"
ecube deleteDeletes an ElastiCube from the target server.
  • name:  Defines the name of the ElastiCube to be removed from the target server.
  • serverAddress: Defines the target server address from which the ElastiCube should be removed.
ecube restartRestarts an Elasticube on the target server.
  • name: The name of the ElastiCube to be restarted.
  • serverAddress: Defines the target server address on which the ElastiCube should be restarted.

Example

psm ecube build filename=”c:\mycube.ecube” serverAddress=”localhost” mode=restart
ecube startStarts an ElastiCube on the target server.
  • name: Defines the name of the ElastiCube to be started.
  • serverAddress: Defines the target server address on which the ElastiCube should be started.
ecube stopStops a running ElastiCube on the target server.
  • name: Defines the name of the ElastiCube to be stopped.
  • serverAddress: Defines the target server address on which the ElastiCube should be stopped.
ecube attachAttaches an ElastiCube folder to the local server.
  • path: Defines the full path of the folder you want to attach. Example: psm.exe ecube attach path=C:\ProgramData\Sisense\PrismServer\ElastiCubeData\…
  • serverAddress (when working with a remote server): Defines the address of a remote serverIf not used, the fallback value localhost will be used. Example: psm.exe ecube attach path=s:\elasticubedata\acheck1 serverAddress=192.168.1.xxx
ecube detachDetaches an ElastiCube from the local server.
  • name: Defines the name of the ElastiCube you want to detach.
  • serverAddress (when working with a remote server): Defines the address of a remote serverIf not used, the fallback value localhost will be used. Example: psm.exe ecube detach name=check1 serverAddress=192.168.1.xxx

psm ex

ecdata 62downgradeDowngrades ElastiCube files created and encrypted in Sisense version 6.2 to ElastiCube files compatible with versions prior to 6.2 without encryption. This is useful if you have created ElastiCubes in 6.2 and wish to downgrade while still using all of your ElastiCubes.
  • Filename: Address and filename of the .ecube file.
ecube infoReturns information about the ElastiCube.
  • name:  Defines the name of the ElastiCube.
  • serverAddress: Defines the target server address of the ElastiCube.
ecube renameRenames local ElastiCube files.
  • Ecube: Address and filename of the .ecube file.
  • Name: The new name of the ElastiCube file.
  • Backup: (Optional) Boolean value that creates a .bak file of the ecube when renaming it. The backup file created has the format name.ecube.bak. By default, this value is false.

Example: c:\Program Files\Sisense\Prism>psm.exe ecube edit rename ecube="c:\test.ecube" name="newname" backup=true

ecs startStarts the ElastiCube server.
ecs stopStops the ElastiCube server.
sysinfoReturns system information (server hardware) and ElastiCube details (number of cubes, size, etc.).
scale analysis

Performs a scale analysis of ElastiCubes or tables within an ElastiCube without building a new ElastiCube.

The scale analysis returns two CSV files, Columns and Tables, that provides a data regarding the type, size and standard deviation of the data within the files.

Scale analysis is supported for MySQL, PostGreSQL, and Oracle-based tables.

  • Name = Address and filename of the .ecube file.
  • Table = The name of the table to be analyzed. When this parameter is blank all the tables are analyzed.
convert

Converts ElastiCube XMLs files or encrypted ElastiCube XMLs files into ElastiCube files or ElastiCube files into ElastiCube XMLs (unencrypted). The converted file is created in the same folder as the source file.

  • Name= Address and filename of the source file.

Example: c:\Program Files\Sisense\Prism>psm.exe ecube convert name="c:\test.ecube"Result: c:\test.xml

CubeConverterExe

This command together with an executable file lets you convert ecube files to XML and vice versa. This can be useful for editing ecube parameters such as the data source name and location, table names, dimension names, etc. You can convert the .ecube file to xml, edit the .xml file using any editor, and then simply convert it back to an .ecube file.

Click here to learn more.

 

 

  • No labels