CLI Targets And How To Use Them

Targets mentioned here are for internal use only, and will not function by calling them from command line: importSingleApp_internal, exportSingleApp_internal, launchSingleApp_internal, stopSingleApp_internal, exportSingleApp_internalwithlibs, importSingleService_internal, exportSingleService_internal.
'migrate' target has been deprecated and is no longer in use. All its associated properties (EventProcessXMLPath, ComponentGUIDMapPath, ConfigMigrationPropPath, PortMigrationPropPath) are also not in use.
'\' is used as a marker to escape special characters (E.g: (space), @ , etc), hence any use of '\' in properties other than use to escape special characters is invalid.

importApps

Imports nStudio applications from a specified directory in to the application repository.

Usage: nStudio.properties

APPLICATION_IMPORT_DIR - Directory where the applications are present
IMPORT_APPLICATION_LIST - CSV of application file names
OVERWRITE - Can be either 'true' or 'false'. If set to 'true', the already existing application with the same GUID will be over-written

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO COMPOSE AN APPLICATION

importEStudioApps

Imports eStudio applications from a specified directory in to the application repository.

Usage: eStudio.properties

_ESTUDIO_APPLICATION_IMPORT_DIR - Directory where the application zip files are present
_ESTUDIO_IMPORT_APPLICATION_LIST - CSV of Application zip file names
_ESTUDIO_OVERWRITE - Can be either 'true' or 'false'. If set to 'true', the already existing application with the same GUID will be over-written (Default :true)
_ESTUDIO_OVER_WRITE_NAMED_CONFIG - Can be either 'true' or 'false'. If set to 'true', the already existing named configuration will be over-written while importing the application (Default :true)
_ESTUDIO_OVER_WRITE_REFERRED_APP - Can be either 'true' or 'false'. If set to 'true', the already existing application will be overwritten even it is referred by other applications (Default :false)
_ESTUDIO_TARGET_APPLICATION_LABEL - Can be 'Development/Testing/Staging/Production'. This label will be set to application after importing. If not specified anything, will keep the same as original label
_ESTUDIO_IMPORT_WHOLE_APPLICATION_CHAIN - Can be either 'true' or 'false'. If set to 'true', the given application chain will imported else options will be displayed so as to specify which are all applications to be imported in the specified application chain(Default : true)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO COMPOSE AN APPLICATION

exportApps

Exports nStudio applications from the application repository to the specified directory in zip format.

Usage: nStudio.properties

APPLICATION_EXPORT_DIR - Directory where the applications are to be exported
EXPORT_APPLICATION_LIST - CSV of application GUIDs. If the applications have different versions then user can use this format <Application GUID>:<Application version>,..
APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS

exportEStudioApps

Exports eStudio applications from the application repository to the specified directory in zip format.

Usage: eStudio.properties

_ESTUDIO_APPLICATION_EXPORT_DIR - Directory where the applications are to be exported
_ESTUDIO_EXPORT_APPLICATION_LIST - CSV of application GUIDs. If the applications have different versions then user can use this format <Application GUID>:<Application version>,..
_ESTUDIO_APPLICATION_VERSION - Version of the application (Default: 1.0)
_ESTUDIO_EXPORT_NAMED_CONFIG - Can be either 'true' or 'false'. Export named configurations associated with the applications (Default: true)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS

exportAllEStudioApps

Exports ALL eStudio applications from the application repository to the specified directory in zip format.

Usage: eStudio.properties

_ESTUDIO_APPLICATION_EXPORT_DIR - Directory where the applications are to be exported
_ESTUDIO_EXPORT_NAMED_CONFIG - Can be either 'true' or 'false'. Export named configurations associated with the applications (Default: true)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS

listAllAppsGUID

Needs FPS to be running.Lists the Application GUIDs of all applications which are in running state.

No properties are needed for this target. Works only for RMI Connections.

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS is needed on the application for it to be listed

launchApps

This is the default target.Needs FPS to be running.Launches the nStudio applications specified i.e. changes application state to 'running'.

Usage: nStudio.properties

LAUNCH_APPLICATION_LIST - CSV of nStudio application GUIDs to be launched. If the applications have different versions then user can use this format <Application GUID>:<Application Version>, ..
APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO LAUNCH AN APPLICATION

launchEStudioApps

Needs FPS to be running.Launches the eStudio applications specified i.e. changes application state to 'running'.

Usage: eStudio.properties

_ESTUDIO_LAUNCH_APPLICATION_LIST - CSV of eStudio application GUIDs to be launched. If the applications have different versions then user can use this format <Application GUID>:<Application Version>, ..
_ESTUDIO_APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO LAUNCH AN APPLICATION

stopApps

Needs FPS to be running.Stops the already launched nStudio applications specified.

Usage: nStudio.properties

STOP_APPLICATION_LIST - CSV of nStudio application GUIDs to be stopped. If the applications have different versions then user can use this format <Application GUID>:<Application Version>, ..
APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO KILL AN APPLICATION

stopEStudioApps

Needs FPS to be running.Stops the already launched eStudio applications specified.

Usage: eStudio.properties

_ESTUDIO_STOP_APPLICATION_LIST - CSV of eStudio application GUIDs to be stopped. If the applications have different versions then user can use this format <Application GUID>:<Application version>,..
_ESTUDIO_APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO KILL AN APPLICATION

stopAllServices

Needs FPS to be running.Stops all the services (components) of all specified applications.Does not stop the applications, only its services.

Usage: nStudio.properties

STOP_ALLSERVICES_OFAPPLICATION_LIST - CSV of application GUIDs. If the applications have different versions then user can use this format <Application GUID>:<Application version>,..
APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO KILL AN APPLICATION

stopAllEStudioServices

Needs FPS to be running.Stops all the services (components) of all specified applications.Does not stop the applications, only its services.

Usage: eStudio.properties

_ESTUDIO_STOP_ALLSERVICES_OFAPPLICATION_LIST - CSV of eStudio application GUIDs whose services are to be stopped. If the applications have different versions then user can use this format <Application GUID>:<Application version>,..
_ESTUDIO_APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO KILL AN APPLICATION

startAllServices

Needs FPS to be running.Starts all the services (components) of all specified applications.

Usage: nStudio.properties

START_ALLSERVICES_OFAPPLICATION_LIST - CSV of application GUIDs. If the applications have different versions then user can use this format <Application GUID>:<Application version>,..
APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO LAUNCH AN APPLICATION

startAllEStudioServices

Needs FPS to be running.Starts all the services (components) of all specified applications.

Usage: eStudio.properties

_ESTUDIO_START_ALLSERVICES_OFAPPLICATION_LIST - CSV of application GUIDs. If the applications have different versions then user can use this format <Application GUID>:<Application version>,..
_ESTUDIO_APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO LAUNCH AN APPLICATION

compile

Needs FPS to be running.Compiles (performs CRC) the application which is specified.

Usage: nStudio.properties

APPLICATION_GUID - GUID of the single application which is to be compiled
APPLICATION_VERSION - Version of the application (Default: 1.0)

sync

Needs FPS to be running.Synchronises the application which is specified.

Usage: nStudio.properties

APPLICATION_GUID - GUID of the single application which is to be synchronised
APPLICATION_VERSION - Version of the application (Default: 1.0)

syncEStudioApps

Needs FPS to be running.Synchronises the application which is specified.

Usage: eStudio.properties

_ESTUDIO_SYNC_APPLICATION - GUID of the single application which is to be synchronised
_ESTUDIO_APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO LAUNCH AN APPLICATION

exportAppsWithLibs

Exports the listed nStudio applications along with all its dependencies (jar files).

Usage: nStudio.properties

EXPORT_APPLICATION_LIST - CSV of application GUIDs. If the applications have different versions then user can use this format <Application GUID>:<Application version>,..
APPLICATION_EXPORT_DIR_LIB - Directory where the applications are to be exported
APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS

exportEStudioAppsWithLibs

Exports the listed eStudio applications along with all its dependencies (jar files).

Usage: eStudio.properties

_ESTUDIO_EXPORT_APPLICATION_LIB_LIST - CSV of application GUIDs. If the applications have different versions then user can use this format <Application GUID>:<Application version>,..
_ESTUDIO_APPLICATION_EXPORT_DIR_LIB - Directory where the applications are to be exported
_ESTUDIO_APPLICATION_VERSION - Version of the application (Default: 1.0)
_ESTUDIO_EXPORT_NAMED_CONFIG - Can be either 'true' or 'false'. Export named configurations associated with the applications (Default: true).

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS

migrateEventProcessEnvironment

Migrates the eStudio Event Process environment.EP environment can be any of DEVELOPMENT, TESTING, STAGING, PRODUCTION

Usage: eStudio.properties

_ESTUDIO_MIGRATE_APPLICATION_LIST - CSV of application GUIDs. If the applications have different versions then user can use this format <Application GUID>:<Application version>,..
_ESTUDIO_APPLICATION_VERSION - Version of the application (Default: 1)
_ESTUDIO_TARGET_ENVIRONMENT - New environment of the application (Can be either development, testing, staging or production)
_ESTUDIO_OVER_WRITE_NAMED_CONFIG - Can be either 'true' or 'false'. If set to 'true', the already existing named configuration will be over-written while importing the application (Default : true)
_ESTUDIO_MIGRATE_COPY_NAMED_CONFIGS - Can be either 'true' or 'false'. If set to 'true', the named configuration will also be copied while importing the application (Default : true)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO COMPOSE AN APPLICATION

importAppsWithLibs

Imports a sinle nStudio application along with all its dependencies (jar files).

Usage: nStudio.properties

APPLICATION_ZIP - Name of the single application zip file
APPLICATION_IMPORT_DIR_LIB - Directory where the application is present
OVERWRITE - Can be either 'true' or 'false'. If set to 'true', the already existing application with the same GUID will be over-written (Default : true)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO COMPOSE AN APPLICATION

importEStudioAppsWithLibs

Imports the listed eStudio applications along with all its dependencies (jar files).

Usage: eStudio.properties

_ESTUDIO_IMPORT_APPLICATION_LIB_LIST - CSV of Application zip file names
_ESTUDIO_APPLICATION_IMPORT_DIR_LIB - Directory where the application zip files are present
_ESTUDIO_OVERWRITE - Can be either 'true' or 'false'. If set to 'true', the already existing application with the same GUID will be over-written (Default : true)
_ESTUDIO_OVER_WRITE_NAMED_CONFIG - Can be either 'true' or 'false'. If set to 'true', the already existing named configuration will be over-written while importing the application (Default : true)
_ESTUDIO_OVER_WRITE_REFERRED_APP - Can be either 'true' or 'false'. If set to 'true', the already existing application will be overwritten even it is referred by other applications (Default :false)
_ESTUDIO_TARGET_APPLICATION_LABEL - Can be 'Development/Testing/Staging/Production'. This label will be set to application after importing. If not specified anything, will keep the same as original label
_ESTUDIO_IMPORT_WHOLE_APPLICATION_CHAIN - Can be either 'true' or 'false'. If set to 'true', the given application chain will imported else options will be displayed so as to specify which are all applications to be imported in the specified application chain.
_ESTUDIO_RETAIN_OLD_RESOURCES - Can either be 'true' or 'false'. If set to true, the resources for the service which is present in old but not in new Service will be retained (Default : true)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO COMPOSE AN APPLICATION

importServices

Imports services (available components) to the Micro Service Palette.

Usage: nStudio.properties

IMPORT_SERVICES_LIST - CSV of service zip file names
SERVICE_IMPORT_DIR - Directory where the services are present
OVERWRITE_IMPORT_SERVICE - Can be either 'true' or 'false'. If set to 'true', the already existing services with the same GUIDs will be over-written (Default : true)

Authorization Permissions Needed:

PERMISSION TO CREATE OR UPDATE AND DELETE A SERVICE

stopServices

Needs FPS to be running.Stops the specified services of a specified application.

Usage: nStudio.properties

STOP_SERVICES_LIST - CSV of service names
STOP_SERVICES_OF_APPLICATION - GUID of the single application whose services are to be stopped
APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO KILL AN APPLICATION

stopEStudioServices

Needs FPS to be running.Stops the specified services of a specified application.

Usage: eStudio.properties

_ESTUDIO_STOP_SERVICES_LIST - CSV of service names
_ESTUDIO_STOP_SERVICES_OF_APPLICATION - GUID of the single application whose services are to be stopped
_ESTUDIO_APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO KILL AN APPLICATION

startServices

Needs FPS to be running.Starts the specified services of a specified application.

Usage: nStudio.properties

START_SERVICES_LIST - CSV of service names
START_SERVICES_OF_APPLICATION - GUID of the single application whose services are to be started
APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO LAUNCH AN APPLICATION

startEStudioServices

Needs FPS to be running.Starts the specified services of a specified application.

Usage: eStudio.properties

_ESTUDIO_START_SERVICES_LIST - CSV of service names
_ESTUDIO_START_SERVICES_OF_APPLICATION - GUID of the single application whose services are to be started
_ESTUDIO_APPLICATION_VERSION - Version of the application (Default: 1.0)

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO LAUNCH AN APPLICATION

exportServices

Exports services (available components) from the Micro Service Palette.

Usage: nStudio.properties

EXPORT_SERVICES_LIST - CSV of service GUIDs, Multiple versions can be provided as JMSIn:5.0,chat,Feeder:4.0. If version is not specified for any service in the list, value of SERVICE_VERSION variable will be used.
SERVICE_EXPORT_DIR - Directory where the services are to be exported
SERVICE_VERSION - Version of the services to be exported

Authorization Permissions Needed:

None

exportAllServices

Exports all the services available in the Micro Service Palette.

Usage: nStudio.properties

SERVICE_EXPORT_DIR - Directory where the services are to be exported

Authorization Permissions Needed:

None

exportAllEStudioServices

Exports all the services available in the Micro Service Palette.

Usage: eStudio.properties

_ESTUDIO_EXPORT_SERVICE_DIR - Directory where the services are to be exported

Authorization Permissions Needed:

None

exportEStudioServices

Exports EStudio service(s) available in Micro Service Palette to a single zip file.

Usage: eStudio.properties

_ESTUDIO_EXPORT_SERVICE_DIR - Directory where services are to be exported.
_ESTUDIO_EXPORT_SERVICE_LIST - CSV of service GUIDs, Multiple versions can be provided as JMSIn:5.0,chat,Feeder:4.0. If version is not specified for any service in the list, value of _ESTUDIO_SERVICE_VERSION variable will be used.
_ESTUDIO_SERVICE_VERSION - Default version of the services to be exported

Authorization Permissions Needed:

None

importEStudioServices

Imports EStudio service(s) from a zip file(s) to component repository.

Usage: eStudio.properties

_ESTUDIO_IMPORT_SERVICE_DIR - Directory of the zip file(s) from which services are to be imported.
_ESTUDIO_IMPORT_SERVICE_ZIP_LIST - CSV service zip file names.
_ESTUDIO_RESYNC_SERVICES - Can either be 'true' or 'false'. If 'true' it will stop running instances of the service being imported and synchronize the dependent applications after completed import. If 'false' user will have to manually stop running instances and synchronize to reflect changes to the repository (Default : true)
_ESTUDIO_OVERWRITE - Default value 'true'. Can either be 'true' or 'false'. If 'true' it will overwrite the existing services in the repository (Default : true)
_ESTUDIO_RETAIN_OLD_RESOURCES - Default value 'true'. Can either be 'true' or 'false'. If set to true, the resources for the service which is present in old but not in new Service will be retained (Default : true)
_ESTUDIO_IMPORT_ALL_SERVICES - Default value 'true'. Can either be 'true' or 'false'. If set to 'true', all the service(s) present in zip file will be imported. If 'false' user will be prompted on the console as to which services are to imported (Default : true)

Authorization Permissions Needed:

PERMISSION TO CREATE OR UPDATE AND DELETE A SERVICE

replace

Replaces properties with new properties in EventProcess.xml of specified exported nStudio application.Performs a Find-Replace on the xml file.

Usage: Create a file specifying the 'Find' and 'Replace' text strings.

Format: find=replace
if either of the find or replace text strings contain special characters('\','='), precede them with a '\'

nStudio.properties

PROPERTIES_FILE - Path to the file in which the find-replace text strings are provided
INPUT_FILE - Path to the input application
OUTPUT_FILE - Intended path to the application after the properties have been replaced

Authorization Permissions Needed:

None

replaceInZip

Replaces properties with new properties in EventProcess.xml of specified exported eStudio application.Performs a Find-Replace on the xml file.

This target is meant for eStudio applications. This is not applicable for service exports or other Fiorano related archives.

Usage: Create a file specifying the 'Find' and 'Replace' text strings.

Format: find=replace
if either of the find or replace text strings contain special characters('\','='), precede them with a '\'

eStudio.properties

_ESTUDIO_PROPERTIES_FILE_ZIP - Path to the file in which the find-replace text strings are provided

Set 1:

_ESTUDIO_INPUT_ZIP_FOLDER - Directory to the input application zip files
_ESTUDIO_OUTPUT_ZIP_FOLDER - Directory to the output application zip files

Set 2:

_ESTUDIO_INPUT_ZIP_FILE - Path to the input application zip
_ESTUDIO_OUTPUT_ZIP_FILE - Intended path to the application zip after the properties have been replaced

In above mentioned properties, if "Set 1" properties are empty "Set 2" properties are considered for the target execution. If both are provided then "Set 1" properties are considered.

Authorization Permissions Needed:

None

checkoutAppFromSVN

Checks out a single specified application from the SVN repository into the specified import directory, in zip format.

Usage: eStudio.properties

_ESTUDIO_SVN_IMPORT_APPLICATION - GUID of a single application

If application GUID contains '@'symbols, manually replace them with '%40'
_ESTUDIO_SVN_IMPORT_APPLICATION_REVISION - SVN Revision of the application (Can either be a specific revision number or HEAD)
_ESTUDIO_APPLICATION_IMPORT_DIR - Directory where the application is to be checked out
_ESTUDIO_SVN_IMPORT_APP_RETAIN_VERSION - Can be either 'true' or 'false'. If set to 'false' svn checkout revision will be set as application version (Default : false)

svn.properties

svn.username - Your SVN authentication username
svn.password - Your SVN authentication password
svn.repository - URL of the SVN repository where the application is present

Authorization Permissions Needed:

None

importApplicationFromSVN

Imports a single specified application from the SVN repository.

Usage: eStudio.properties

_ESTUDIO_SVN_IMPORT_APPLICATION - GUID of a single application

If application GUID contains '@'symbols, manually replace them with '%40'
_ESTUDIO_SVN_IMPORT_APPLICATION_REVISION - SVN Revision of the application (Can either be a specific revision number or HEAD)
_ESTUDIO_APPLICATION_IMPORT_DIR - Directory where the application is to be checked out and made available for import
_ESTUDIO_OVERWRITE - Can be either 'true' or 'false'. If set to 'true', the already existing application with the same GUID will be over-written (Default : true)
_ESTUDIO_OVER_WRITE_NAMED_CONFIG - Can be either 'true' or 'false'. If set to 'true', the already existing named configuration will be over-written while importing the application (Default : true)
_ESTUDIO_OVER_WRITE_REFERRED_APP - Can be either 'true' or 'false'. If set to 'true', the already existing application will be overwritten even it is referred by other applications (Default :false)
_ESTUDIO_SVN_IMPORT_APP_RETAIN_VERSION - Can be either 'true' or 'false'. If set to 'false' svn checkout revision will be set as application version (Default : false)
_ESTUDIO_TARGET_APPLICATION_LABEL - Can be 'Development/Testing/Staging/Production'. This label will be set to application after importing. If not specified anything, will keep the same as original label.

svn.properties

svn.username - Your SVN authentication username
svn.password - Your SVN authentication password
svn.repository - URL of the SVN repository where the application is present

Authorization Permissions Needed:

PERMISSION TO VIEW RUNNING AND SAVED APPLICATIONS
PERMISSION TO COMPOSE AN APPLICATION