Command-Line Parameters
The following parameters are available for use in the Post-Processing Command text field.
|
Parameter |
Description |
Report Types |
|
|
|
$outputDir |
Name of the output directory of the external copy of the generated report |
All |
Report Output Directory |
Enter a location; test to validate that spaces in the location are correctly substituted. |
|
$outputFiles |
Comma-separated list of names of output report files |
All |
None |
Dependent on report type. Note that the ReportConfigurationName.fns file will always be present, containing the report generation log. |
|
$errorStatus |
Indicates whether a report ran successfully. |
All |
None |
An error number of 0 indicates that the report ran successfully; all other numbers indicate an error. |
|
$errorLine |
Error description (can be empty). |
All |
None |
Contains the error description when $errorStatus<>0; otherwise contains an empty string "". |
|
$reportType |
The report type that was run. |
All |
None |
One of: FLEXnet.Usage.Raw, FLEXnet.Usage.ServerCoverage, FLEXnet.Usage.Summary, FLEXnet.Usage.Efficiency, FLEXnet.Usage.SummaryBarchart, FLEXnet.Usage.HighWaterMark, FLEXnet.Usage.OverTime |
|
$user |
The FlexNet user who ran the report. |
All |
None |
Example: admin |
|
$features |
Comma-separated list of features included in the report. |
All |
Features selection on page 2 of the report wizard |
Example: feature1,feature2 |
|
$servers |
Comma-separated list of license servers included in the report |
All |
License Server Hosts on page 1 of the report wizard |
Example: host1,host2 |
|
$vendorDaemons |
Comma-separated list of vendor daemons included in the report |
All |
Vendor Daemons on page 1 of the report wizard |
Example: avend,bvend,cvend |
|
$startDate |
Start date of the report. |
All |
Date/Time Range on page 1 of the report wizard |
Example: |
|
$endDate |
End date of the report |
All |
Date/Time Range on page 1 of the report wizard |
Example: |
|
$showZero |
Indicates where unused features are included |
High Water Mark, Summary Barchart, Usage Over Time, Usage Summary |
Usage setting with Show Zero Usage selected (Summary Options page of report wizard) |
True or False; dependent on whether this option was selected in the FlexNet Manager for Engineering Applications interface |
|
$filter |
Comma-separated list of filter expressions |
Raw |
Event Types (Filter Properties page of the report wizard |
Used, Queued, Denied, and Exceptions (dependent on selections made in the FlexNet Manager for Engineering Applications interface) |
|
$eventFilter |
Comma-separated list of event filters |
All |
Filters specified in the Filter Properties page of the report wizard |
Example:
|
|
$delimiter |
Field delimiter on reports |
All reports except Summary Barchart and Server Coverage |
Output Format (wherever the output format can be represented as RIF) |
The delimiter can be a space, tab, or any other value. |
|
$showAvail |
Indicates whether a group of available licenses is also on graphs (Usage Over Time) |
High Water Mark, Usage Over Time |
Additional Options: Show Available Options setting selected (Output Options page of the report wizard) |
True or False; dependent on whether this option was selected in the FlexNet Manager for Engineering Applications interface |
|
$elimFalseDenials |
Denial elimination algorithm is turned on and has the specified window |
Raw, Usage Summary |
Denial Filtering: “Eliminate spurious denials” option (Filter Properties page of the report wizard) |
True or False; dependent on whether this option was selected in the FlexNet Manager for Engineering Applications interface |
|
$sortOrder |
Sort order of the records on the report |
All |
Sort Order on Output Options page of the report wizard |
f or fb or empty |
|
$featureUniq |
Mode of feature identification |
All |
Value in “Describe Features by” field (Feature Selection page of the report wizard |
name, name_ver, name_asset, name_key |
|
$timeInSeconds |
Show time value in RIF files as UNIX seconds since 00:00:00 January 1, 1970 GMT |
Raw |
Output Format: “Time as Seconds” set to Yes (Output Properties page of the report wizard) |
True or False; dependent on whether this option was selected in the FlexNet Manager for Engineering Applications interface |
Note:You should use parameters that are applicable to the report type you are defining. Using parameters not applicable to the report type will result in indeterminate values at run time.
Parameters that can have an empty value ($features, $servers, $vendorDaemons, $filter, $eventFilter) should be used only in cases where the corresponding report configuration values are not empty. If the report configuration setting does not contain a value for a specified parameter, no argument will be emitted, which can cause the argument interpreter in the post-processing script to confuse the next argument with the value of the current argument.
Example: The list of servers is specified ($servers), but in the License Server Host selection on the Naming page (step 1) of the Report Configuration Wizard, none has been selected (indicating to run the report for all license server hosts). Then no argument will be emitted by the post-processing invocation. In case another parameter is specified, the argument evaluation logic can easily mistake the value for the next argument as the list of servers.
After you specify the post-processing expression, you can complete the report configuration. When you finish the report configuration, FlexNet Manager for Engineering Applications validates the external output directory and the post-processing expression.
After saving the report configuration, you can run the report. FlexNet Manager for Engineering Applications will generate the report, copy the report to the external directory, and then invoke the post-processing script.
See Also
Specifying Post-Processing Options