Production Parameters

When a DivePort event such as visiting a page or activating a click action causes a Production script to run, DivePort passes along some portal parameters. DiveLine also passes parameters to Production, specifically two automatic parameter values:

_USER

_diveline_dataroot

When a DivePort page includes a QuickView portlet, shared QuickView selections are passed to the Production script. The DivePort QuickViews are added to the parameter space at run time as auto-generated parameters; that is, $(QUICKVIEW_VALUE <dimension>) is sent to the Production engine and applied to the script automatically.

  • All parameters that are passed consist of the QuickView name preceded by an underscore. For example, the parameter for the Sales Region QuickView is $(_Sales Region). In the Production script, you can reference $(_Sales Region) to obtain the QuickView value being sent.

  • When DivePort opens a Production script with QuickView with multiple values selected, the values are written to a file, and the parameter is replaced with the name of that file. The script needs to handle the file, rather than multiple values.

  • In the case of All Values, the literal string All Values is passed.

  • For Run Production Script click actions, row selection takes precedence over saved QuickView values.

To view the parameter values being passed from DivePort to the Production script:

  1. Use Workbench to create a Production script that references the DivePort QuickView of interest.

  2. In DivePort, edit the page to add a click action that runs the Production script.

  3. Save the page, and then use the click action to trigger the script.

  4. Use Workbench to open the Production script in Results mode.

    The most recent log shows the execution just performed.

  5. Click View Log.

    All possible parameter values that the DivePort page can pass to Production are listed in the Main or Start threads.

DiveLine uses the _USER parameter to specify the user name currently logged into DivePort when running a script. Some node types, such as Delete node, allow you to reference _USER directly. However, an Integ node must explicitly declare the parameter named _USER before it can be passed to the Data Integrator. For example:

_USER = $(_USER)

Without this declaration, no _USER parameter is set when the Integrator script is run, proxy or otherwise.

NOTE: The user name is the name as it appears in Workbench Server Settings. That is, a user can log on using lower case while the user name in Workbench may be mixed case or all upper case. The values passed to the Production script come from Workbench, not from what the user typed.

TIP: DiveLine and Workbench are insensitive to case when validating a user name, but Productions scripts are case sensitive when using the _USER parameter in cross platform applications.

Production scripts which are run from a Measure Factory DivePort receive the special Measure Factory QuickViews: Time Range, Current Date, and Calendar. These parameters are accessed by using $(_Time Range), $(_Current Date), or $(_Calendar).

These same QuickViews are set in DivePort when passed by Production using a DivePort URL that includes a dive-key.

 

For more information about Production scripts, see Workbench Help.