Selecting Documents to Update

Use scripts that are provided or customized scripts to perform the transformation.

To select files or folders to update using the command line:

Navigate to the bin folder.
If the installation was not customized, the bin folder is under C:\Hyperion\products\biplus\bin. However, if the installation was customized, fix the path to be relative.
Select runTransformScript.bat, right-click, and select Edit.
This enables you to specify the script, parameters, and options to run.
The BAT file includes these lines:
```
set PARAM=%PARAM% -js ""
set PARAM=%PARAM% -param:name=""
```
The first line is the script to run and the second line is a parameter placeholder.
Specify the script.
The script to run must be entered after the -js option in the BAT file. For example, -js "JavaScriptUpdate.js".
Specify the script parameters using one of these two methods:
A script can have many or no parameters.
1. Using the -param option.
  All \ and " must be escaped.
  The -param option has this syntax for single values:
  -param:name="value"
  The -param option has this syntax for an array with two items:
  -param:name="[\"value\", \"C:\\Hyperion\\products\\biplus\"]"
  The first item is value and the second item is C:\Hyperion\products\biplus\.
  For example, JavaScript Update requires these parameters:
  - The configuration file (parameter name: updateConfig)
  - The new sections file (parameter name: newSectionFile)
  - The document or file to update (parameter name: targetBQYs)
  - The update folder (parameter name: updateFolder) OR the backup folder (parameter name: backupFolder)
  An example:
```
set PARAM=%PARAM% -js "C:\\Hyperion\\products\\biplus\\DDS\\scripts\\DDSUpdate\\JavaScriptUpdate.js"
set PARAM=%PARAM% -param:updateConfig="C:\\Hyperion\\products\\biplus\\DDS\\scripts\\DDSUpdate\\JavaScriptUpdateConfig_dds.js"
set PARAM=%PARAM% -param:newSectionFile="C:\\Hyperion\\products\bipPlus\\DDS\\scripts\\DDSUpdate\\newsections.bqy"
set PARAM=%PARAM% -param:targetBQYs="C:\\Folder or Document to update"
set PARAM=%PARAM% -param:updateFolder="C:\\Update folder"
```
  Optional: Replace the last line, if creating a backup folder:
```
	set PARAM=%PARAM% -param:backupFolder="C:\\Backup folder"
```
2. Using the -batch option.
  This option enables you to execute a script, multiple times with different parameters. Each line in the batch file represents one execution of a script. The parameters are comma-separated; for example, name1="value1", name2="value2".
  This example is an equivalent batch file for the JavaScript Update example in step 4a. It is an example of the contents of a BAT file:
```
	updateConfig="C:\\Hyperion\products\biplus\\DDS\\scripts\\DDSUpdate\\JavaScriptUpdateConfig_dds.js", newSectionFile="C:\\Hyperion\products\biplus\\DDS\\scripts\\DDSUpdate\\newsections.bqy", targetBQYs="C:\\Folder to update", updateFolder="C:\\Update folder"
```
  Use this code to point to the BAT file:
```
set PARAM=%PARAM% -js "C:\\Hyperion\products\biplus\\DDS\\scripts\\DDSUpdate\\JavaScriptUpdate.js"
set PARAM=%PARAM% -batch "C:\\Hyperion\products\biplus\\DDS\\scripts\\DDSUpdate\\batchFile.txt
```
  BatchFile.txt is used as an example name for the parameter file.
Optional: To include an instruction in the BAT file, to fail on error (foe), add the parameter:
```
set PARAM=%PARAM% -foe
```
If this parameter is included and the file encounters an error when running the transformation, the process will stop and an error message will be displayed in the log. If the line is not included, any errors that are encountered are skipped. The log alerts you to errors. This works only for JavaScript Update.
Optional: To include an instruction in the BAT file, to create a report, enter this line:
```
set PARAM=%PARAM% -rep "C:\\Hyperion\\products\\biplus\\DDS\\report"
```
A file path and folder must be specified; for example, C:\Hyperion\products\biplus\DDS\report.
Save and close the BAT file.
In Interactive Reporting Studio, open a Command window.
Navigate to the bin folder.
For example, navigate to C:\Hyperion\products\biplus\bin.
Run runTransformScript.bat.
The BAT file must be run from the bin directory.
The Command window displays output. If successful, a message is displayed.