EDK

Create, manage, build and deploy ELARA project's programmatically using the @elaraai/edk typescript libraries.

example

 import * as edk from '@elaraai/edk' // create a simple application to create a project, add a datasource, build and deploy const project_dir = 'path_to_workspace' async function run() {     // create a project     let project_config = await edk.init({          name: 'A project',          dir: project_dir      })      // add a deployment     project_config = edk.addDeployment({         dir: project_dir,         server: 'https://server_url',         name: 'test',         config: project_config     })      // add a datasource to the project     project_config = edk.addRangeDataSource({         name: "Datasource",         dir: project_dir,         def_dir: 'src/sources',         config: project_config,         start: 1.5,         stop: 1000,         step: 2.3     });      // build the schema     let build = edk.buildSchema({          dir: project_dir,          config: project_config      });     if(build === false) {         //...     }      // deploy the schema     let deploy = await edk.deploySchema({          dir: project_dir,          config: project_config,          deployment: 'test'      });     if(deploy === false) {         //...     }}
run()

Admin#

EnvironmentArguments#

Ƭ EnvironmentArguments: Object

Defines the arguments for addEnvironment command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the environment variable name
`overwrite`	`boolean`	true if the environment should be overwritten on deployment

UserArguments#

Ƭ UserArguments: Object

Defines the arguments for addUser command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`email`	`string`	the user's email
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the user's name

addEnvironment#

▸ addEnvironment(args): ELARAConfig | null

Create a new {@link EnvironmentDefinition}.

remarks This command will edit the entity if it exists already, otherwise will fail if a matching datasource doesnt exist.

Parameters#

Name	Type
`args`	`EnvironmentArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addUser#

▸ addUser(args): ELARAConfig | null

Create a new {@link UserDefinition}.

remarks This command will edit the entity if it exists already, otherwise will fail if a matching datasource doesnt exist.

Parameters#

Name	Type
`args`	`UserArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

Analytics#

ViewArguments#

Ƭ ViewArguments: Object

Defines the arguments for addView command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name

addView#

▸ addView(args): ELARAConfig | null

Create a new {@link ViewDefinition}.

remarks This command will edit the entity if it exists already, otherwise will fail if a matching datasource doesnt exist.

Parameters#

Name	Type
`args`	`ViewArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

Application#

ApplicationArguments#

Ƭ ApplicationArguments: Object

Defines the arguments for addApplication command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the application name

PageArguments#

Ƭ PageArguments: Object

Defines the arguments for the addPanelPage and addUserPage commands.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name

VisualArguments#

Ƭ VisualArguments: Object

Defines the arguments for the addVisual and {@link addUserVisual} commands.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name
`type`	`VisualType`	the visual type to create

addApplication#

▸ addApplication(args): ELARAConfig | null

Create a new {@link ApplicationDefinition}.

remarks This command will edit the entity if it exists already, otherwise will fail if a matching datasource doesnt exist.

Parameters#

Name	Type
`args`	`ApplicationArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addPanelPage#

▸ addPanelPage(args): ELARAConfig | null

Create a new {@link PanelPageDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`PageArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addUserPage#

▸ addUserPage(args): ELARAConfig | null

Create a new {@link UserPageDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`PageArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addVisual#

▸ addVisual(args): ELARAConfig | null

Create a new {@link VisualDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`VisualArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

DataSource#

ArrayDataSourceArguments#

Ƭ ArrayDataSourceArguments: Object

Defines the arguments for addArrayDataSource command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name

ClockDataSourceArguments#

Ƭ ClockDataSourceArguments: Object

Defines the arguments for addClockDataSource command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`future_cycles`	`number`	the number of cycles in the future to include in the output
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name
`past_cycles`	`number`	the number of cycles in the past to include in the output
`period`	`number`	the time period in units between rows
`unit`	`TimeUnit`	the unit of time for each row

CsvDataSourceArguments#

Ƭ CsvDataSourceArguments: Object

Defines the arguments for addCsvDataSource command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name
`uri`	`URIString`<`"file://"` \| `"ftp://"` \| `"sftp://"`>	the ftp, sftp or file uri

ExcelDataSourceArguments#

Ƭ ExcelDataSourceArguments: Object

Defines the arguments for addExcelDataSource command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name
`uri`	`URIString`<`"file://"` \| `"ftp://"` \| `"sftp://"`>	the ftp, sftp or file uri

JsonDataSourceArguments#

Ƭ JsonDataSourceArguments: Object

Defines the arguments for addJsonDataSource command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name
`uri`	`URIString`<`"file://"` \| `"ftp://"` \| `"sftp://"`>	the ftp, sftp or file uri

RangeDataSourceArguments#

Ƭ RangeDataSourceArguments: Object

Defines the arguments for addRangeDataSource command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name
`start`	`number`	the first number in the range
`step`	`number`	the step size for each {@link Row}
`stop`	`number`	the last number in the range

RestApiDataSourceArguments#

Ƭ RestApiDataSourceArguments: Object

Defines the arguments for addRestApiDataSource command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name

SqlChangeTrackingDataSourceArguments#

Ƭ SqlChangeTrackingDataSourceArguments: Object

Defines the arguments for addSqlChangeTrackingDataSource command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`initialize`	`string`	the string for initialize stored procedure name
`name`	`string`	the entity name
`password`	`string`	the string for the password
`tables`	`string`[]	the strings for table names
`update`	`string`	the string for update stored procedure name
`uri`	`URIString```"mssql://"``\	the mssql uri
`username`	`string`	the string for the username

SqlDataSourceArguments#

Ƭ SqlDataSourceArguments: Object

Defines the arguments for addSqlDataSource command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name
`password`	`string`	the string for the password
`uri`	`URIString```"mssql://"``\	the mssql uri
`username`	`string`	the string for the username

addArrayDataSource#

▸ addArrayDataSource(args): ELARAConfig | null

Create a new {@link ArrayDataSourceDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`ArrayDataSourceArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addClockDataSource#

▸ addClockDataSource(args): ELARAConfig | null

Create a new {@link ClockDataSourceDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`ClockDataSourceArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addCsvDataSource#

▸ addCsvDataSource(args): ELARAConfig | null

Create a new {@link CsvDataSourceDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`CsvDataSourceArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addExcelDataSource#

▸ addExcelDataSource(args): ELARAConfig | null

Create a new {@link ExcelDataSourceDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`ExcelDataSourceArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addJsonDataSource#

▸ addJsonDataSource(args): ELARAConfig | null

Create a new {@link JsonDataSourceDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`JsonDataSourceArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addRangeDataSource#

▸ addRangeDataSource(args): ELARAConfig | null

Create a new {@link RangeDataSourceDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`RangeDataSourceArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addRestApiDataSource#

▸ addRestApiDataSource(args): ELARAConfig | null

Create a new {@link RestApiDataSourceDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`RestApiDataSourceArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addSqlChangeTrackingDataSource#

▸ addSqlChangeTrackingDataSource(args): Promise<ELARAConfig | null>

Create a new {@link SqlChangeTrackingDataSourceDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`SqlChangeTrackingDataSourceArguments`

Returns#

Promise<ELARAConfig | null>

the updated project {@link ELARAConfig}.

addSqlDataSource#

▸ addSqlDataSource(args): ELARAConfig | null

Create a new {@link SqlDataSourceDefinition}.

remarks This command will create the entity if it doesnt exist already, otherwise will fail if a matching directory already exists.

Parameters#

Name	Type
`args`	`SqlDataSourceArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

Pipeline#

PipelineArguments#

Ƭ PipelineArguments: Object

Defines the arguments for addPipeline command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the entity name

addPipeline#

▸ addPipeline(args): ELARAConfig | null

Create a new {@link PipelineDefinition}.

remarks This command will edit the entity if it exists already, otherwise will fail if a matching datasource doesnt exist.

Parameters#

Name	Type
`args`	`PipelineArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

Plugin#

PluginArguments#

Ƭ PluginArguments: Object

Defines the arguments for addPlugin command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the plugin name

addPlugin#

▸ addPlugin(args): ELARAConfig | null

Create a new {@link ELARASchema}.

remarks This command will edit the entity if it exists already, otherwise will fail if a matching datasource doesnt exist.

Parameters#

Name	Type
`args`	`PluginArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

Solution#

AssetSchemaArguments#

Ƭ AssetSchemaArguments: Object

Defines the arguments for {@link getAssetSchema} command.

Type declaration#

Name	Type	Description
`asset`	`string` \| `null`	the asset to remove
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`dir`	`string`	the ELARA solution directory absolute or relative path

BuildArguments#

Ƭ BuildArguments: Object

Defines the arguments for buildSchema command.

Type declaration#

Name	Type	Description
`clean`	`boolean` \| `null`	set to true if the build should commence with a clean
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`dir`	`string`	the ELARA solution directory absolute or relative path

DeployArguments#

Ƭ DeployArguments: Object

Defines the arguments for deploySchema command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`deployment`	`string`	the deployment asset name to deploy
`dir`	`string`	the ELARA solution directory absolute or relative path
`flush?`	`FlushType`[]	flush the specified services
`overwrite?`	`boolean`	set to true if all environments should be overwritten
`restart?`	`boolean`	set to true if a reset of all service should occur
`verbose?`	`boolean`	set to true if the deployment should show verbose logging

DeploymentArguments#

Ƭ DeploymentArguments: Object

Defines the arguments for addDeployment command.

Type declaration#

Name	Type	Description
`application?`	`string`	the application to include in the solution
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`dir`	`string`	the ELARA solution directory absolute or relative path
`iterations_gp`	`bigint` \| `undefined`	the number iterations when training a Guassian Process
`iterations_utility_est`	`bigint` \| `undefined`	the number iterations to train the utility rate estimator
`iterations_xgb_opt`	`bigint` \| `undefined`	the number of iterations when training with XGBoost
`loglevel?`	`LogLevel`	the log level to apply to the deployment
`name`	`string`	the deployment name
`optimization_iterations`	`bigint` \| `undefined`	the number of iterations optimization should use
`optimization_randomness`	`number` \| `undefined`	the scale of randomness optimization should allow when exploring the cost surface (in units of the total objective function)
`optimization_serial_iterations`	`bigint` \| `undefined`	the number of serial mini-iterations optimization should use per iteration
`optimization_trajectories?`	`bigint`	the number of simulation trajectories for optimizations for the deployment
`samples?`	`bigint`	the number of training samples for the deployment
`sensitivity_trajectories?`	`bigint`	the number of simulation trajectories for sensitivity calculations for the deployment
`server`	`string`	the ELARA server url
`trajectories?`	`bigint`	the number of simulation trajectories for the deployment
`warn?`	`boolean`	set to true if the cli should prompt before deployment

FlushType#

A deployment FlushType.

param the desired {@link }.

remarks Deploying a {@link ELARASchema} requires that a deployment existing in the configuration, and the EDK_CLIENT_ID and EDK_CLIENT_SECRET system environment variables have been set with a valid ELARA server key value pair.

InitArguments#

Ƭ InitArguments: Object

Defines the arguments for the init command.

Type declaration#

Name	Type	Description
`dir`	`string`	the ELARA solution directory absolute or relative path
`name`	`string`	the ELARA solution name
`version`	`string`	the EDK version

LinkedArguments#

Ƭ LinkedArguments: Object

Defines the arguments for linkedAssets command.

Type declaration#

Name	Type	Description
`asset`	`string`	the asset to find the dependancies/dependants for
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`dir`	`string`	the ELARA solution directory absolute or relative path

RemoveArguments#

Ƭ RemoveArguments: Object

Defines the arguments for removeAsset command.

Type declaration#

Name	Type	Description
`all`	`boolean` \| `null`	set to true if a all assets should be removed
`asset`	`string` \| `null`	the asset to remove
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`dir`	`string`	the ELARA solution directory absolute or relative path

TokenArguments#

Ƭ TokenArguments: Object

Defines the arguments for getToken command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`deployment`	`string`	the deployment asset name to deploy
`dir`	`string`	the ELARA solution directory absolute or relative path

UpdateArguments#

Ƭ UpdateArguments: Object

Defines the arguments for updateAssets command.

Type declaration#

Name	Type	Description
`asset?`	`string` \| `null`	the name of an asset to update
`clean`	`boolean` \| `null`	set to true if a clean should occur
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`dir`	`string`	the ELARA solution directory absolute or relative path
`type?`	`string` \| `null`	the type of assets to update

addDeployment#

▸ addDeployment(args): ELARAConfig | null

Create a deployment asset in the {@link ELARAConfig}.

Parameters#

Name	Type
`args`	`DeploymentArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

assetSchema#

▸ assetSchema(args): ELARASchema | null

Get an asset schema from a solution.

Parameters#

Name	Type
`args`	`AssetSchemaArguments`

Returns#

ELARASchema | null

the related asset {@link ELARASchema}.

buildSchema#

▸ buildSchema(args): boolean

Build the solution {@link ELARASchema}.

Parameters#

Name	Type
`args`	`BuildArguments`

Returns#

boolean

true if the update was successful.

config#

▸ config(dir): Promise<ELARAConfig | null>

Load the config for an ELARA solution.

Parameters#

Name	Type
`dir`	`string`

Returns#

Promise<ELARAConfig | null>

the {@link ELARAConfig} for the project.

deploySchema#

▸ deploySchema(args): Promise<boolean>

Deploy the solution {@link ELARASchema}.

truen

Parameters#

Name	Type
`args`	`DeployArguments`

Returns#

Promise<boolean>

getToken#

▸ getToken(args): Promise<string | null>

Get an authentication token {@link ELARASchema}.

truen

remarks Getting a token requires that a deployment existing in the configuration, and the EDK_CLIENT_ID and EDK_CLIENT_SECRET system environment variables have been set with a valid ELARA server key value pair.

Parameters#

Name	Type
`args`	`TokenArguments`

Returns#

Promise<string | null>

init#

▸ init(args): Promise<ELARAConfig | null>

Initialise a new ELARA solution and generate base artefacts.

remarks This command will create the solution directory if it doesnt exist already, otherwise will fail if an existing solution exists in the directory.

Parameters#

Name	Type
`args`	`InitArguments`

Returns#

Promise<ELARAConfig | null>

the {@link ELARAConfig} for the new project.

linkedAssets#

▸ linkedAssets(args): ELARAConfig | null

Find the linked assets in a solution.

Parameters#

Name	Type
`args`	`LinkedArguments`

Returns#

ELARAConfig | null

the project {@link ELARAConfig}.

removeAsset#

▸ removeAsset(args): ELARAConfig | null

Remove an asset from a solution.

Parameters#

Name	Type
`args`	`RemoveArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

updateAssets#

▸ updateAssets(args): Promise<boolean>

Update the generated assets in a solution.

Parameters#

Name	Type
`args`	`UpdateArguments`

Returns#

Promise<boolean>

true if the update was successful.

Structure#

AgentArguments#

Ƭ AgentArguments: Object

Defines the arguments for addAgentStructure command.

Type declaration#

Name	Type	Description
`concept`	`string`	the agent concept
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file

ProcessArguments#

Ƭ ProcessArguments: Object

Defines the arguments for addProcessStructure command.

Type declaration#

Name	Type	Description
`concept`	`string`	the process concept
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file

ResourceArguments#

Ƭ ResourceArguments: Object

Defines the arguments for addResourceStructure command.

Type declaration#

Name	Type	Description
`concept`	`string`	the resource concept
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file

ScenarioArguments#

Ƭ ScenarioArguments: Object

Defines the arguments for addScenario command.

Type declaration#

Name	Type	Description
`config`	`ELARAConfig`	the current {@link ELARAConfig}
`def_dir`	`string`	the relative dir path for the definition file
`dir`	`string`	the ELARA solution directory absolute or relative path
`gen_dir`	`string`	the relative dir path for the generated file
`name`	`string`	the scneario name

addAgentStructure#

▸ addAgentStructure(args): ELARAConfig | null

Create a new {@link AgentDefinition}.

remarks This command will edit the entity if it exists already, otherwise will fail if a matching datasource doesnt exist.

Parameters#

Name	Type
`args`	`AgentArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addProcessStructure#

▸ addProcessStructure(args): ELARAConfig | null

Create a new {@link ProcessDefinition}.

remarks This command will edit the entity if it exists already, otherwise will fail if a matching datasource doesnt exist.

Parameters#

Name	Type
`args`	`ProcessArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addResourceStructure#

▸ addResourceStructure(args): ELARAConfig | null

Create a new {@link ResourceDefinition}.

remarks This command will edit the entity if it exists already, otherwise will fail if a matching datasource doesnt exist.

Parameters#

Name	Type
`args`	`ResourceArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.

addScenario#

▸ addScenario(args): ELARAConfig | null

Create a new {@link ScenarionDefinition}.

remarks This command will edit the entity if it exists already, otherwise will fail if a matching datasource doesnt exist.

Parameters#

Name	Type
`args`	`ScenarioArguments`

Returns#

ELARAConfig | null

the updated project {@link ELARAConfig}.