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 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 debug <true | false>
-
set exeinfo property <companyname | productname | copyright | description> propertyString
-
set exeinfo property <fileversion | fileversionnum | productversion | productversionnum> versionString
-
echo value [value …]
-
file copy fromFile toFile [ clobberAttribute ]
-
file delete fileName [ clobberAttribute ]
-
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 logID
logPass] -
create library pblName pblComments
-
deploy winform project pblName entryName [iconName]
-
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 password password
-
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 connect [offline]
-
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 |
|
pbl_list |
String containing the list of PBLs for the session application. PBL names can be separated by semicolons |
|
pblName |
Name of a PBL for |
|
applicationName |
Name of the application for an OrcaScript |
|
true | false |
Boolean value for enabling or disabling |
|
propertyString |
String for setting the company or product |
|
versionString |
String for setting the product or file |
|
fromFile |
File that you want to copy during an |
|
toFile |
File name for a file that you copy during |
|
fileName |
File that you want to delete during an |
|
clobberAttribute |
Determines whether the file copy command
|
|
entryName |
Pointer to a string whose value is the |
|
entryType |
Value specifying the type of the referenced |
|
toPblName |
Name of the PBL to |
|
pbrName |
Name of a resource file you want to include |
|
pbd | 32 |
Select PBD to generate PowerBuilder dynamic |
|
exeName |
Name of the executable you want to build. |
|
iconName |
Name of an icon to use for an executable |
|
pbdFlags |
String composed of a series of Y and |
|
machinecode |
Use to compile a project as machine code. |
|
newvstylecontrols |
Use Microsoft XP visual style for controls. |
|
full | migrate | incremental |
Build strategy for the session application. |
|
projectName |
Name of the project object you want to |
|
serverName |
Name of the server where you want to |
|
serverPort |
Port for the server where you want to |
|
logID |
Login ID for the server where you want |
|
logPass |
Login password for the server where you |
|
pbdName |
Name of a PBD you append to an EXE. |
|
pblComments |
Comments for a PBL you |
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 |
|
sccProvider |
Name of the source control provider. |
|
userID |
Name of the user registered to source |
|
password |
Password for the user ID. |
|
logFileName |
Name of a log file used to record SCC |
|
projectPath |
Path to the source control project. |
|
localProjectPath |
Local root directory for the project. |
|
auxProjectPath |
Contains any string that the SCC provider |
|
targetName |
Name of the target for source control |
|
true | false |
Boolean value for appending to the source |
|
offline |
Keyword indicating that an actual SCC |
|
refreshType |
Value can be:
Combining values
You can combine compatible refreshType and refreshOption values |
|
refreshOption |
Value can be:
|
|
file_list |
String containing one or more resource |