OrcaScript Commands
OrcaScript commands
are not case sensitive. The generic command parameters can include
only strings delimited by quotation marks, or predefined variables and
constants without quotation marks. White space is used to separate multiple
parameters for a single command. Any place a string is expected,
a name that has been previously defined (set) in an OrcaScript command
can be used.
In the OrcaScript command prototype syntax that follows, brackets
indicate a parameter is optional. A pipe character inside angle
brackets ( < | > ) indicates that a selection
must be made from one of the values inside the angle brackets. As
elsewhere in the PowerBuilder documentation, text in italic type
indicates a variable.
For commands where a string variable is required by the command
syntax but is not essential to the command function (such as pbrName for
the build library command), you can use an empty
string inside quotation marks for the string value. Most of the
OrcaScript commands and parameters are self-explanatory. For usage
notes and an example of an OrcaScript batch file for obtaining a PowerScript
target from source control, see “Usage notes for OrcaScript
commands and parameters”.
OrcaScript commands
OrcaScript supports the following commands:
- start session
- end session
- set name = value
- set name += value
- set liblist pbl_list [pbl_list …]
- set application pblName applicationName
- set exeinfo property <companyname | productname | copyright | description> propertyString
- set exeinfo property <fileversion | fileversionnum | productversion | productversionnum> versionString
- echo value [value …]
- file copy fromFile toFile
- regenerate pblName entryName entryType
- copy entry pblName entryName entryType toPblName
- build library pblName pbrName <pbd | 32>
- build executable exeName iconName pbrName pbdflags [machinecode] [newvstylecontrols]
- build application <full | migrate | incremental >
- build project pblName projectName [ serverName serverPort ]
- create library pblName pblComments
- scc get connect properties workspaceName
- scc set connect property deletetempfiles <true|false>
- scc set connect property provider sccProvider
- scc set connect property userid userID
- scc set connect property logfile logFileName
- scc set connect property project projectPath
- scc set connect property localprojpath localProjectPath
- scc set connect property auxproject auxProjectPath
- scc set connect property logappend < true | false >
- scc set connect
- scc set target targetName [refreshType][refreshOption][refreshOption]
- scc get latest version file_list [file_list …]
- scc exclude liblist pblName [ pblName …]
- scc refresh target <full | migrate | incremental >
- scc close
Argument description
Arguments for OrcaScript commands are described in the table
below:
| Argument | Description |
|---|---|
| name | String you define for an OrcaScript session. |
| value | Value of a string that you set for the OrcaScript session. |
| pbl_list | String containing the list of PBLs for the session application. PBL names can be separated by semicolons in a single string, or separated by a blank space in multiple strings. |
| pblName | Name of a PBL for an OrcaScript action or for the OrcaScript session application. |
| applicationName | Name of the application for an OrcaScript action. |
| propertyString | String for setting the company or product name, copyright owner, or application description. |
| versionString | String for setting the product or file version numbers. The FileVersionNum and ProductVersionNum strings must consist of four integer values representing the major version number, minor version number, fix version number, and build number, with each value separated by a decimal point, for example “9.0.0.5049”. |
| fromFile | File that you want to copy during an OrcaScript session. |
| toFile | File name for a file that you copy during an OrcaScript session. |
| entryName | Pointer to a string whose value is the name of the referenced object. |
| entryType | Value specifying the type of the referenced object. Values can be: app, dw, fn, menu, query, struct, uo, win, pipe, project, or proxy. |
| toPblName | Name of the PBL to which you copy an entry. |
| pbrName | Name of a resource file you want to include in a build. |
| pbd | 32 | Select PBD to generate PowerBuilder dynamic libraries. Select 32 to generate platform-specific machine code. You must enter a full path for a PBL or PBR if you select 32 as the value of this argument in an OrcaScript build library command. |
| exeName | Name of the executable you want to build. |
| iconName | Name of an icon to use for an executable you build with OrcaScript. |
| pbdFlags | String composed of a series of Y and N values for each library in the library list. A value of “nnyy” indicates that there are four libraries in the library list, the last two being PBDs. Objects from PBLs are copied into the executable; objects from PBDs are not copied. |
| machinecode | Use to compile a project as machine code. |
| newvstylecontrols | Use Microsoft XP visual style controls. |
| full | migrate | incremental | Build strategy for the session application. |
| projectName | Name of the project object you want to build and deploy. |
| serverName | Name of the server where you want to deploy a project. |
| serverPort | Port for the server where you want to deploy a project. |
| pbdName | Name of a PBD you append to an EXE. |
| pblComments | Comments for a PBL you create in an OrcaScript session. |
Arguments for source control commands
In addition to some of the arguments listed in the preceding
table, OrcaScript source control commands use the following arguments:
| Argument | Description |
|---|---|
| workspaceName | Name of the workspace to connect to source control. You must include the path to the workspace, although you can use a relative path. |
| sccProvider | Name of the source control provider. |
| userID | Name of the user registered to source control. |
| logFileName | Name of a log file used to record SCC transactions. |
| projectPath | Path to the source control project. |
| localProjectPath | Local root directory for the project. |
| auxProjectPath | Contains any string that the SCC provider wants to associate with the project. It has a different meaning for every SCC vendor. |
| targetName | Name of the target for source control operations. |
| true | false | Boolean value for appending to the source control log file. If this command is not used but a log file is specified, the session value defaults to true. |
| refreshType | Value can be:
|
| refreshOption | Value can be:
|
| file_list | String containing one or more file names using relative or absolute path specification. File names can be separated by semicolons in a single string, or separated by a blank space in multiple strings. |
