Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# Studio Tools Commands Reference

You can perform a variety of tasks from the command line using studio tools commands and their options. To use the commands mentioned below, navigate to BE_HOME/studio/bin/. Open the `studio-tools` utility. On the command prompt, run the required command.

## `generateDTClass`

You can use the following `generateDTClass` command to generate class files for decision tables:

    studio-tools -dt generateDTClass [-h]-d Decision Table Path -p Project Path -o <Output Directory for generated classes> -x -e EAR Path -pl <project lib path><path separator><project lib path> -cp <Optional extended classpath>

Option | Description
--- | ---
`-dt generateDTClass` | Specifies the `generateDTClass` operation for generating class files for decision tables.
`-h` | (Optional) Prints usage help.
`-d` | Specifies the path to the decision table.
`-p` | Specifies the path of the project to which the decision table belongs.
`-o` | (Optional) Specifies the output folder for the generated class files.
`-x` | (Optional) Overwrites the specified output class file if it exists.
`-e` | Specifies the path to the ear of the project to which the decision table belongs.
`-pl` | (Optional) Specifies the list of project library file path separated by a path separator.
`-cp` | (Optional) Specifies the extended classpath.
`-lc` | Use this option if you want to use the legacy compiler.

## `importExcel`

You can use the following `importExcel` command to import a Microsoft Excel file to create a decision table:

    studio-tools -dt importExcel [-h]-studioProjPath <Studio Project Path> -excelPath <Excel File Path> -dtName -folderPath <Path relative to project path> -vrfPath <Path relative to project path> -wsPath <Existing Studio workspace folder>

importExcel Options
Option | Description
--- | ---
`-dt importExcel` | Specifies the `importExcel` operation for importing a Microsoft Excel file to create a decision table.
`-h` | (Optional) Prints usage help.
`-studioProjPath` | Specifies the path to the TIBCO BusinessEvents Studio project to which you want to import the file.
`-excelPath` | Specifies the path to the Microsoft Excel (`.xls` or `.xlsx`) file that you want to import to TIBCO BusinessEvents Studio.
`-dtName` | Specifies name of the decision table that you want to create using the Microsoft Excel file.
`-folderPath` | Specifies the output folder for the created decision table. Specify the output folder path relative to the path of the TIBCO BusinessEvents Studio project path.
`-vrfPath` | Specifies the path of the virtual rule function that the imported decision table uses. Specify the virtual rule function path relative to the path of the TIBCO BusinessEvents Studio project path and exclude the .vrf extension in it.
`-wsPath` | (Optional) Use this option if you want to specify the location of the existing TIBCO BusinessEvents Studio workspace folder to which the decision table is added. The best practice is to leave this option blank so that the project is not stale.

## `convertCSV2Excel`

You can use the following `convertCSV2Excel` command to convert a CSV file to a Microsoft Excel file:

    studio-tools -dt convertCSV2Excel [-h]-csvPath <CSV File Path> -excelPath <Excel File Path> -s <Column Separator>

Option | Description
--- | ---
`-dt convertCSV2Excel` | Specifies the `convertCSV2Excel` operation for converting CSV files to Microsoft Excel files.
`-h` | (Optional) Prints usage help.
`-csvPath` | Specifies the absolute path to the source CSV file.
`-excelPath` | Specifies the absolute path to the Microsoft Excel file.
`-s` | (Optional) Specifies the output folder for the generated class files.

## `validateTable`

You can use the following `validateTable` command to validate a decision table using the command line:

    studio-tools -dt validateTable [-h] -studioProjPath <Studio Project Path> -dtPath <Path relative to project path> -wsPath <Existing Studio workspace folder>

validateTable Options
Option | Description
--- | ---
`-dt validateTable` | Specifies the `validateTable` operation for generating class files for decision tables.
`-h` | (Optional) Prints usage help.
`-studioProjPath` | Specifies the path to the TIBCO BusinessEvents Studio project which contains the decision table that you want to validate.
`-dtPath` | Specifies path of the decision table that you want to validate. Specify this path relative to the path of the TIBCO BusinessEvents Studio project path and exclude the .dt extension in it.
`-wsPath` | (Optional) Use this option if you want to specify the location of the existing TIBCO BusinessEvents Studio workspace folder. The best practice is to leave this option blank so that the project is not stale.

## `validateWSTable`

You can use the following `validateWSTable` command to generate class files for decision tables:

    studio-tools -dt validateWSTable [-h] -r <Path of SCS> -p <project Name> -e <EAR archive path> -t <DecisionTable Temp File Path>

Option | Description
--- | ---
`-dt validateWSTable` | Specifies the `generateDTClass` operation for generating class files for decision tables.
`-h` | (Optional) Prints usage help.
`-r` | Specifies a path to the decision table.
`-p` | Specifies a path of the project to which the decision table belongs.
`-e` | (Optional) Specifies the output folder for the generated class files.
`-t` | (Optional) Overwrites the specified output class file if it exists.

## `exportToExcel`

You can use the following `exportToExcel` command to export decision tables as Microsoft Excel files(`.xlsx`):

     studio-tools -dt exportToExcel [-h] -studioProjPath <Studio Project Path> -dtPath <Decision Table Path(File/Folder)> -excelPath <Exported Excel Path)> -useColumnAlias <Export Column Alias> [-legacy]  -e <Ear path>

Option | Description
--- | ---
`-h` | (Optional) Prints usage help.
`-studioProjPath` | Specifies the path to the TIBCO BusinessEvents Studio project that contains the decision table that you want to export.
`-dtPath` | Specifies the path of the decision tables that you want to export. Specify this path relative to the path of the TIBCO BusinessEvents Studio project path and exclude the .dt extension in it. If you want to export multiple decision tables, specify the path to the folder containing them.
`-excelPath` | Specifies the path of the Microsoft Excel file where you want to export the decision tables.
`-useColumnAlias` | (Optional) Use this option if you want to print column alias as column names in the decision table.
`-legacy` | (Optional) Use this option to export a decision table in the `.xls` format instead of the default `.xlsx` format.
`-e` | (optional) Specifies the path of the EAR file of the project.

## `importXSDs`

You can use the following `importXSDs` command to generate concept definitions based on XSD schema elements:

     studio-tools -core importXSDs [-h] -s <xsdSourceDir> -o <outputDir> -p <projectName> [-x]

Option | Description
--- | ---
`-h` | (Optional) Prints usage help.
`-s` | Specifies the path to the source directory that contains the XSD files.
`-o` | Specifies the absolute path to the output directory of the converted concepts and events.
`-p` | (Optional) Specifies the target TIBCO BusinessEvents project name for the converted concepts and events. If omitted, the target directory is assumed to be the TIBCO BusinessEvents Studio project, and the project name is derived from the output directory name.
`-x` | (Optional) Use this option to overwrite the specified output files if they exist.

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.