Basic Scripting

Ideate Automation provides Ideate Software customers with programmatic access to our solutions through scripting. In this topic the basics of script editing are covered. For more advanced scripting help please contact our support team via email at [email protected].

Ideate Automation will install with several sample scripts that can be edited to fit your needs. These sample scripts install to C:\Program Files\Ideate\Ideate Automation\en-US\Samples by default and can be edited with any text editor such as Notepad. Some of the easiest items to edit are:

Edit the task name or description

You should consider editing the task name or description to better serve the end user in their understanding of each script. The name of the script file itself (#1) can be edited within Windows Explorer to suit your needs. The task name (#2) can be more descriptive if needed. The purpose of the task name is to identify the task later in the task queue. Additionally the task name comes in handy for troubleshooting. The task name can always be manually edited when the task is run from the Ideate Automation Queue, as shown below. The description (#3) helps the end-user understand the purpose of each script.

Editing Ideate Software scripts

Edit the file and path locations

Most scripts will have variables that define the Revit file or files to be referenced, a location for output, and a source for referencing product-specific content, such as the link definitions used within Ideate BIMLink.

In the script shown below there is a variable called export_folder (#5) which has a default value of “${revit_file:directory}\COBie Review”. This value means that the export results (in this case from Ideate BIMLink) will be placed in a subfolder called “COBie Review” which is located underneath the specified Revit file location (#4). You can easily edit the name of that subfolder or remove the subfolder name from the script to alter the location of the export results.

The variable called export_file (#6) controls the name of the file being exported. In the example below, the file name is prefixed with “Ideate_COBie_Review” and is suffixed with the date of the export. You can rename the prefix as appropriate and use or delete the date as needed. 

Script variables for Ideate Automation

Allow User Input

When Ideate Automation scripts are used within the Automation Queue, shown above at right, the Script Variable options are made available for user input when the prompting=”true” is included within the script.

Sample export_file variable with prompting:

  <export_file prompting="true"> ${revit_file:revit.filename.noextension} ${today.yyyy-MM-dd}.xlsx</export_file>

Sample export_file variable without prompting:

  <export_file> ${revit_file:revit.filename.noextension} ${today.yyyy-MM-dd}.xlsx</export_file>

For more advanced scripting help please contact our support team via email at [email protected].

Submit feature or issue request for Ideate Software

Thank you for taking time to inform us about a bug or feature request.