MicroStrategy ONE

Basic Enterprise Manager Commands

This section lists the basic commands you need to execute in Command Manager to begin capturing, analyzing, and reporting on data about your system with Enterprise Manager. For more examples, see the Command Manager Help Guide.

Start Monitoring

This command tells the Enterprise Manager service to start monitoring the specified Intelligence Server.

Syntax

START MONITORING SERVER "<machine_name>" IN PORT <port_number> USING USERNAME "<username>" PASSWORD "<password>" FOR ENTERPRISE MANAGER "<em_machine>" IN PORT <em_port>;

Options

  • machine_name: The name or IP address of the machine where the Intelligence Server is running.
  • port_number: The port number in which the Intelligence server can be contacted.
  • username: The metadata user name that is going to be used to establish the connection.
  • password: The password for the metadata user name.
  • em_machine name: The name or IP address of the machine where Enterprise Manager is running.
  • em_port: The port number in which Enterprise Manager is running.

Stop Monitoring

This command tells Enterprise Manager to stop monitoring the specified Intelligence Server.

Syntax

STOP MONITORING SERVER "<server_name>" IN ENTERPRISE MANAGER "<em_machine>" IN PORT <port>;

Options

  • server_name: The name or IP address of the machine to stop monitoring.
  • em_machine: The name or IP address of the machine where Enterprise Manager is running.
  • em_port: The port at which Enterprise Manager is running.

Create Data Load

This command will create a data load object in Enterprise Manager.

Syntax

CREATE DATA LOAD "<name>" FOR ENVIRONMENT "<server_name>" AND PROJECT "<project_name>" [, ENVIRONMENT "<server_name>" AND PROJECT "<project_name>" ...] DO ACTION [UPDATEWAREHOUSE] [CLOSESESSIONS] [REPOPULATETABLES] [UPDATESTATS] [UPDATEOBJECTDELETIONS] BEGIN DATE <date> [TO <date>] FREQUENCY (DAILY | WEEKLY | MONTHLY) ON [MONDAY] [TUESDAY] [WEDNESDAY] [THRUSDAY] [FRIDAY] [SATURDAY] [SUNDAY] FROM <time> TO <time> EVERY <number> (MINUTES | HOURS) (ENABLE | DISABLED) IN ENTERPRISE MANAGER "<em_machine>" IN PORT <port>;

Options

  • name: The data load name.
  • server_name: The server that will be associated with this data load. This server should previously be added to Enterprise Manager using the Start Monitoring command.
  • project_name: Specifies the project which data will be used.
  • DO ACTION [ ] The actions this data load will trigger.
  • Begin date: The start date in which this data load becomes active.
  • End date: After this date the data load can no longer be executed.
  • Frequency: How often the data load will be trigger.
  • ON: Indicates the day(s) of the week the data load will be triggered.
  • Start time: The start time of the data load in a 24 hour format.
  • End time: The end of the time frame for execution in 24 hour format.
  • EVERY: The number of minutes or hours between each execution.
  • ENABLE | DISABLE: If the data load is enabled or not.
  • em_machine: The name or IP address of the machine where Enterprise Manager is running.
  • em_port: The port at which Enterprise Manager is running.

Execute Data Load

This command will trigger the execution of a data load. The command will not wait for the completion of the data load. It will indicate a success status as long as the order was correctly sent to Enterprise Manager.

Syntax

EXECUTE DATA LOAD "<data_load_name>" [WITH DATA FROM <start_date> TO <end_date>] IN ENTERPRISE MANAGER "<em_machine>" IN PORT <port>;

Options

  • data_load_name: The name of the data load object to execute.
  • start_date: Indicates the date for the data load to start.
  • end_date: The last date the data load will be executed.
  • em_machine: The machine where Enterprise manager is running.
  • port: The port at which Enterprise manager is running.

Delete Data Load

This command will delete a data load object from Enterprise Manager.

Syntax

DELETE DATA LOAD "<data_load_name>" FROM ENTERPRISE MANAGER "<em_machine>" IN PORT <port>;

Options

  • data_load_name: The name of the data load to be deleted.
  • em_machine: The name or IP address of the machine where Enterprise Manager is running.
  • port: The port at which Enterprise Manager is running.

Alter Data Load

This command modifies the settings of an existing data load. This command will overwrite all the settings of the old data load with the new definition provided.

Syntax

ALTER DATA LOAD "<name>" [NEW NAME "<new_name>"] [FOR ENVIRONMENT "<server_name>" AND PROJECT "<project_name>" [, ENVIRONMENT "<server_name>" AND PROJECT "<project_name>" ...]] [DO ACTION [UPDATEWAREHOUSE] [CLOSESESSIONS] [REPOPULATETABLES] [UPDATESTATS] [UPDATEOBJECTDELETIONS]] [BEGIN DATE <start_date> [TO <end_date>]] [FREQUENCY (DAILY | WEEKLY | MONTHLY) ON [MONDAY] [TUESDAY] [WEDNESDAY] [THURSDAY] [FRIDAY] [SATURDAY] [SUNDAY]] [FROM <start_time> TO <end_time> EVERY <number> (MINUTES | HOURS)] [(ENABLE | DISABLED)] IN ENTERPRISE MANAGER "<em_machine>" IN PORT <port>;

Options

  • name: The name of the data load to change.
  • new_name: The new name of the data load.
  • server_name: The server that will be associated with this data load.
  • project_name: Specifies the project which data will be used.
  • DO ACTION [ ]: The actions this data load will trigger.
  • start_date: The start date on which this data load becomes active.
  • end_date: After this date the data load can no longer be executed.
  • FREQUENCY: How often the data load will be triggered.
  • ON: Indicate the day(s) of the week the data load will be triggered.
  • start_time: The start time of the data load in a 24 hour format.
  • end_time: The end of the time frame for execution in 24 hour format.
  • number: The number of minutes or hours between each execution.
  • ENABLE | DISABLE: If the data load is enabled or not.

List Enterprise Manager Properties

This command lists the environments and the projects that are currently being monitored by Enterprise Manager.

Syntax

LIST PROPERTIES FOR ENTERPRISE MANAGER "<em_machine>" IN PORT <port>;

Options

  • em_machine: The name of the Enterprise Manager machine.
  • port: The port at which Enterprise Manager is running.

List Current Data Load Properties

This command will list the properties of the current data load. If no data load is currently being executed the result set will be empty.

Syntax

LIST PROPERTIES FOR CURRENT DATA LOAD IN ENTERPRISE MANAGER "<em_machine>" IN PORT <port>;

Options

  • em_machine: The name of the Enterprise Manager machine.
  • port: The port at which Enterprise Manager is running.

List Last Data Load Properties

This command will list the properties of the last executed data load. If the Enterprise Manager server has never executed a data load the result set will be empty.

Syntax

LIST PROPERTIES FOR LAST DATA LOAD IN ENTERPRISE MANAGER "<em_machine>" IN PORT <port>;

Options

  • em_machine: The name of the Enterprise Manager machine.
  • port: The port at which Enterprise Manager is running.

List All Data Load

This command will list the all the data loads available in Enterprise Manager.

Syntax

LIST ALL DATA LOADS IN ENTERPRISE MANAGER "<em_machine>" IN PORT <port>;

Options

  • em_machine: The name of the Enterprise Manager machine.
  • port: The port at which Enterprise Manager is running.