Special Button Parameters
To run an executable file from a form, the data to pass to the application is entered on the Button Event page for the button control. For Parameters, you can enter plain text or use the parameters described in the following table. In the Enterprise Edition, Parameters is available only to system administrators.
|
Parameter
|
Description
|
||
|---|---|---|---|
|
@UserName
|
The name of the current user. This parameter is available only in the Enterprise Edition.
|
||
|
@UserGroup
|
The name of the group to which the current user belongs. This parameter is available only in the Enterprise Edition.
|
||
|
@ProjectName
|
The name of the current Project.
|
||
|
@SystemName
|
The name of the current System file.
|
||
|
@TableName
|
The name of the table from which the button was clicked. Because you can assign custom names to tables and subtables, using this parameter outputs the table display name.
|
||
|
@RecordIdentifier
|
The identifier of the currently selected record.
|
||
|
@ParentIdentifier
|
The identifier of the parent record. For instance, an incident has a parent record in the System Tree Items table.
|
||
|
@SecondParentIdentifier
|
The identifier of the second parent record. For instance, an incident has a parent record in the System Tree Items table and a second parent record in the Configurations table.
|
||
|
@FieldValue()
|
The display value for any field in the current record. For example, to pass the value for Description, Incident, you would enter:
@FieldValue(Description, Incident)
If the default prompt for this field is changed to Incident Description, which is the case in the Tablet PC Sample Project, you would enter:
@FieldValue(Incident Description)
|
||
|
@FieldName()
|
The internal Windchill Risk and Reliability database field name. For example, @FieldValue(User Text 1) would give you IncUserText1. This is useful for integration work because it does not matter if the field is renamed in the Project’s Data Definition file. You always get IncUserText1 out.
|
||
|
@ProjectPath
|
For the Team Edition only, the path to the current Project's RSN file.
|
||
|
@TableNumber
|
The internal number that corresponds with the current table. For example, for a button on the FRACAS Incidents table, you get 12. This is useful for integration work because it does not matter if the field is renamed in the Data Definition file. You always get the same number out.
|
||
|
@WebServerAddress
|
For the Enterprise Edition only, the address set in the Options window in the Administrator application. This makes it easier for integrations to find the API address.
|
||
|
@SessionToken()
|
Returns a string that can be used to login to the API using the current user’s credentials. You must specify a number inside the parentheses to determine how long the token is valid. The units are in seconds. For example, entering @SessionToken(60) makes the token valid for 60 seconds. During that minute, an integration executable can use the string to log into the API and perform actions. To get a non-expiring token, you would enter 0.
|
