ASP.NET IIS Registration (ASPNET_REGIIS.EXE) Action
ASP.NET IIS Registration (ASPNET_REGIIS.EXE) Action
The ASP.NET IIS Registration action allows the registration or removal o=
f ASP.NET applications within IIS. It can also create ApplicationPools or g=
et the status of the installed ASP.NET framework.
ASP.NET IIS Registration
&nbs=
p;
On this page:
Wo=
rking Folder
The folder from which the ASPNET_REGIIS.EXE command will be ru=
n. This allows for easier referencing of source files in the AL command thr=
ough relative paths.
ASPNET_REGIIS.EXE Command line options
The parameters to pass to ASPNET_REGIIS.EXE. This can take the following=
form:
[options]
Due to the complexity of this tool=
and the number of options available we currently allow direct access to th=
e command arguments. These can be found on the MSDN website located here ASPNET_REGIIS.EXE.=
span>
Framework Version
Use default framework version (vX.X) / Use=
vX.X
Allows the selection of the .NET version to use for the tool. The minimu=
m is .NET v2.0.
U=
se 64-bit tools
This options specifies as whether to force the usage of 64-bit tools on =
a 64-bit system or not. As FinalBuilder is currently a 32-bit applica=
tion it will default to running the 32-bit version on a 64-bit system. &nbs=
p;Check this option if you require the 64-bit version to be run.
Specifies the parameters to pass t=
o ASPNET_REGIIS.EXE.
StartDir
Action.StartDir =3D 'C:\WebSi=
teA\';
any text
''
On save
Specifies the working directory fo=
r ASPNET_REGIIS.EXE to be called with.
Common Scripting Properties
Behavi=
our
Script Property
Example (Javascript)
Valid Values
Default
Persisted
Description
Enabled
Action.Enabled =3D false;
true, fals=
e
true
On save
Whether the action is enabled o=
r disabled. Disabled actions are not considered part of a script. When the =
script is run they are ignore completely.
Has to be set prior to the =
action being selected to run. This means the latest this can be set is in t=
he actions parent.
IgnoreFailure
Action.IgnoreFailure =3D true=
;
true, false
false
On save
When set to true, the action wi=
ll always report as having successfully completed. The actions run result i=
s ignored. Even if the action run result is failure, the build will continu=
e.
Has to be set before the action is run to have any affect.
PauseInterval
Action.PauseInterval =3D 2;=
pre>
0 to 18000000 (5 hours)
0
On save
The number of milliseconds to p=
ause after the completion of an action. The IDE allows users to skip pause =
intervals if required. The command line runner does not allow for the skipp=
ing of this interval.
Setting this is preferable to sleeping in a scr=
ipt as the action continues to be responsive, and handles termination reque=
sts.
Has to be set prior to the action run to have any affect.
MaxRetryAttempts
Action.MaxRetryAttempts =3D 3=
;
any positive 32-bit in=
teger
0
On save
The number of times to retry an=
action when it fails. Each failed run of the action is counted as a retry =
attempt. Once all the retry attempts are exhausted the action will return t=
he result of the last retry attempt.
On a successful run this counter=
is reset for the next time the action is called. This is important for loo=
ps which contain actions with retry attempts set.
Has to be set prior=
to the run of the action to have any affect.
RetryPauseInterval
Action.RetryPauseInterval =3D=
500;
any positive 32-bit in=
teger
1000
On save
The number of milliseconds to wait before running a retry of an action. =
This starts counting directly after the action fails and is not able to be =
skipped. Useful for waiting resources to become available, or locks to be r=
eleased.
Has to be set before to th=
e run of the action to have any affect.
Desc=
ription
Script Property
Example (Javascript)
Valid Values
Default
Persisted
Description
Comment
Action.Comment =3D 'Loads con=
fig for build';
any text=
(single line shown)
[blank]
On save
Allows you to add documentation to=
the action instance.
Description
Action.Description =3D 'Upload [ Installer =
]';
any text (single line =
shown)
[action dependent]
On save
The text shown in the IDE for the action. Descri=
bes the purpose of the action. Clear this property to revert to an automati=
cally generated description.
The name of the action which is sh=
own in the action types list. This is defined by the action and is not able=
to be changed. All actions of the same type will have the same name.
Sets a different description for t=
he action for logging purposes. This description is only ever used in the l=
og.
ExpandActionLogTitle
Action.ExpandActionLogTitle =
=3D false;
true, false
true
On save
Enables variables in the ActionLog=
Title to be expanded. The expansion occurs at the time of logging.
HideActionFromLog
Action.HideActionFromLog =3D =
true;
true, false
false
On save
Hides the action from the log. If =
the action execution results in an error the action is logged, effectively =
ignoring this setting.
LogActionProperties
Action.LogActionProperties =
=3D true;
true, false
false
On save
Records the properties of the acti=
on to the log before the action is run.
LogToVariable
Action.LogToVariable =3D 'MyV=
ariable';
text name of variable<=
/strong>
[blank]
On save
Specifies which variable should ha=
ve the output of the action written to it. The selected variable is require=
d to be available to the action, otherwise an error will be raised. The var=
iable will contain the actions output after the action has run.
SuppressStatusMessages
Action.SuppressStatusMessages =3D true;
true, fals=
e
false
On save
Stops the logging of all the actions status mess=
ages. This stops the action status messages from being generated, so OnStat=
usMessage events will not fire when this options is turned on.
Other
Script Property
Example (Javascript)
Valid Values
Default
Persisted
Description
ErrorCount
if (Action.ErrorCount > 0)=
Action.SendLogMessage('There were errors', stError);
any positive=
32-bit integer (read only)
0
No
Returns the number of errors the a=
ction has encountered during its run. Some actions can encounter more than =
one error before failing.
Returns the description of all the=
errors encounter by the action during it run. The error descriptions are c=
oncatenated with new lines between each entry.
Locked
Action.Locked =3D true;
=
true, false
false
On save
Locks the properties on the action=
so that they can not be changed through the action dialog. When turned on,=
the only property which can be altered is the locked property itself. Turn=
ing this off again means all other properties can be altered through the ac=
tions edit dialog.
Specifies additional command line parameters for=
the underlying tool. These are added before all command line parameters ad=
ded by the action.
Process<=
/h4>
Script Property
Example (Javascript)
Valid Values
Default
Persisted
Description
UseErrorDialogMonitor
=
td>
Action.UseErrorDialogMonitor =
=3D true;
true, false
false
On save
Specifies whether to automatically=
watch for an error dialog which has stalled the underlying tool. The dialo=
g will be closed, and if this is not possible the process will be terminate=
d. This option does not work with all underlying tools.
Specifies at what priority process=
es spawned by the action will have. Note that setting an idle priority will=
most likely mean the action will not progress. tpIdle is only included for=
completeness, typically it should not be used.
ProcessorAffinity
Action.ProcessorAffinity =3D =
243;
0 (<=
strong>unset), 1 to 255 (bit mask)
0
On save
Specifies which processors spaw=
ned processes of the action will be allowed to run on. The value is in the =
form of a bit mask. The mask depends on the number of processors available =
on the running machine.
A bit mask of 1101 1111 ( =3D 223 ) for a six=
processor machine would mean spawned processes could run all but the 6th p=
rocessor.
Specifies the user credentials =
with which to run processes spawned by the action. The user that FinalBuild=
er is running under, will require the permissions to elevate their rights a=
nd impersonate other users for this to be allowed.
ImpersonateUser ne=
eds to be set to true for this to be used.
ImpersonateUseNetCredOnly
ActionImpersonateUseNetCredOn=
ly =3D true;
true, false
false
On save
Specifies whether the impersona=
tion should only use the network component of the supplied users credential=
s. This allows for simpler access to network resources which have restricte=
d access.
ImpersonateUser needs to be set to true for this to be used=
.
ImpersonateUser
Action.ImpersonateUser =3D tr=
ue;
true, false
false
On save
Specifies whether processes spawne=
d by the action should be run under a different set of user credentials.
ExpandImpersonateToken
<=
/td>
Action.ExpandImpersonateToken=
=3D true;
true, false
false
On save
Specifies whether to expand variab=
les found within the impersonate user password. This is handy for setting t=
he password to a variable and then loading from a secure file, or using a p=
assed in variable when the script is run.
ImpersonateUserPassword
=
Action.ImpersonateUserPasswor=
d =3D '8as0dk9JLa!df';
any text=
[blank]
On save
Specifies the password to use for =
the user who is being impersonated. Once set the value is encrypted for sav=
ing into the project (if its saved after this script is called).
Timeout<=
/h4>
Script Property
Example (Javascript)
Valid Values
Default
Persisted
Description
EnableTimeout
Action.EnableTimeout =3D true=
;
true, false
false
On save
Specifies whether the action shoul=
d fail if the TimeoutLength expires. The TimeoutLength is counted from the =
start of the action running.
TimeoutLength
Action.TimeoutLength =3D 2;=
pre>
any positive32-bit integer=
1
On save
Specifies the number of minutes to=
wait after the start of an action to complete. If the action does not comp=
lete before the timeout length has expired the action is given a failure re=
sult, and the TimedOut property is set to true.
.NET Scripting Properties
Other
Script Property
Example (Javascript)
Valid Values
Default
Persisted
Description
OverrideSDKDefault
Action.OverrideSDKDefault =3D=
true;
true, fals=
e
false
On save
Specifies whether the default S=
DK version set in the FinalBuilder options should be overridden for this ac=
tion. Setting this to true will mean the SDK version will be taken from the=
SDKVersion property on the action.
Architecture
Action.Architecture =3D ta32;=
ta32, ta64
ta32
On save
Whether to use the 32-bit or 64=
-bit versions of the underlying tool. Note that some tools can not be run a=
s the 64-bit version from a 32-bit process. As a result these tools will ei=
ther report an error or simply link to the 32-bit version. Check each tools=
MSDN reference for more details.
SDKVersion
Action.SDKVersion =3D "v4.0";=
v2.0,=
v3.0, v3.5, v4.0, or
any other installed .NET version
set in options
On save
Sets the overridden SDK version=
for the underlying tool. The specified SDK version needs to be installed o=
n the machine otherwise an error will be raised saying the specific tool co=
uld not be found.
=
Scripting Events
Script Event
Parameters
Description
BeforeAction
Action : <TAction>
The instance of the current action. Allows ac=
cess to the action properties and methods.
All properties are set to =
the values provided by the action editor or their defaults.
SkipAction : Boolean
An out parameter which allows for the action to =
be skipped during a build. Default is false.
Called before the action is exe=
cuted. When called all properties on the action have been initialised =
to those provided in the action editor dialog. Properties which have not be=
en provided are set to their defaults.
Use this event to change anyth=
ing about the action or perform operations which need to occur before the a=
ction is run. Also this event can be used to skip an action entirely. If th=
e action is skipped it will report as such in the log, and no more processi=
ng of the action or its scripts will occur.
Run-time errors in this s=
cript will stop the action from running and the action will report as faile=
d.
AfterAction
Action : <TAction>
The instance of the current action. Allows ac=
cess to the action properties and methods.
All properties are set to =
the values used during the run of the action.
ActionResult : boolean
Indicates if the action succeeded or failed. All=
ows for the handling or overriding of the actions status during a build.
Continue : boolean
Indicates if the build should continue after =
this action has completed or not.
Return false to stop the build, ret=
urn true to ignore the build result and continue the build. Default is =
unset.
Called after the action has exe=
cuted. All properties on the action will be the same as when the action was=
run. Any properties which change during the run will be available at this =
point (e.g. Exit codes properties).
This event allows for the handlin=
g of action error states that where are not directly handled by the action =
itself. For example if an certain error code is acceptable it can be logged=
and ignored through this event.
Conversely a certain successful run =
condition that is not desirable could be reported through this event. To ac=
hieve these outcomes set the ActionResult and Continue parameters to values=
which reflect the true outcome of the actions run.
Run-time errors p=
roduced by this script will cause the action to report as failed. Setting o=
f either the ActionResult or Continue parameters will not override this.
OnStatusMessage
Action : <TAction>
The instance of the current action. Allows ac=
cess to the action properties and methods.
All properties are set to =
values used during the run of the action.
StatusMessage : TStatusMessage
The status message object contains all informati=
on relating to the message being logged (Lines, MessageText, MessageTitle, =
and Progress).
Called whenever the action gene=
rates a log message.
Actions will generate this event when the action=
has received output from the underlying tool, or when the action itself ha=
s something to report. The StatusMessage may contain zero-to-many lines of =
text and is in the format directly seen in the log.
As formatting dep=
ends on the tool being used we advise using the RegExp function to parse th=
e output if required. Also please review the TString object=
type for more information on how to access the contents of the messages.=
p>
Run-time errors produced by this script will cause the action to repor=
t as failed.