• Content — Select the Name key part of a navigation rule.
• Format — Select the format for the navigation rule.
• Sub-Menu Alignment — Specify Left or Right to indicate how you want to horizontally align the top-level menu border with respect to control's image or label. For example, assume that you create a link control labeled Link Menu. If you select Right alignment, the menu's right border aligns with the letter "u" when the user opens the menu.
• Maximum Width — Select either of the following:
  • Auto — The menu width at each level expands to the width of the menu item with the greatest number of characters. By default, there is no limit.
  • Custom — The menu width at each level is determined by the number of text characters that you enter in the Ellipsis After field. For example, if you enter a value of 7, a menu item named Resolve Work truncates at Resolve and is followed by three dots.

When using this action, the menu contents are generated each time they are requested. This eliminates on-load processing and ensures that the items are always up-to-date. As a best practice, use the Menu action for complex menus (such as the Actions link in a flow action) and in repeating layouts.

• Target — Specify the element that you want to refresh:
  • Section — Refreshes the section.
  • Other Section — Refreshes the section specified in the Section field.
  • Harness — Refreshes the harness.
• Disable submit on refresh — Select this option if you do not want to submit edited data to the clipboard. For example, you may want to use this option to reset either a form (harness) or a section in a form by populating it with data from the clipboard – without submitting data that the user entered.
• Class — Specify the class of the section that you want to refresh. This option is displayed when Other Section is selected.
• Section — Specify the Name of the section to refresh. This option is displayed when Other Section is selected.
• Data Transform — Optional. Enter the Name key part of a data transform that might affect the content of the refreshed section. The prompt is based on information on the Pages and Classes tab of the current section. Parameters listed on the Parameters tab of the Data Transform form are displayed beneath this field. Enter the values that you want pass to the data transform. For more information, see Data Transforms.
• Activity — Optional. Enter the Activity Name key part of an activity. Specify an activity that might affect the content of the refreshed section. The prompt is based on the Pages and Classes tab of the current section. This activity is processed after a data transform. Parameters listed on the Parameters tab of the Activity rule form are displayed beneath the field. Enter the values that you want pass to the activity.

• Target — Enter a Page List or Page Group property reference: .propertyName

  Additional fields are displayed, enabling you to refresh the Active Row, First Row, or Last Row, or to specify an index position within a table, tree, or tree table. To refresh a specific row index, select Other in the Target field, and then specify the Row index to refresh.

  .PageList.propertyName.PageList (15)

• Target — Enter a property reference: .propertyName

  If you specify a Page List or Page Group property, additional fields are displayed, enabling you to set focus on the First Row or Last Row, or to a specific index position within a table, tree, or tree table.

  To set focus to an index position, select Other in the Set focus field and then use a constant or property reference:

  .PageList.propertyName.PageList (15)

  Examples:

  • If a section or layout becomes visible on click of a button, set focus to an editable control in the now visible section.
  • Set focus to the first row in a list of search results.

  Optionally, set Conditions. For more information, see the description for Conditions, below.

  Not all browsers visually indicate that a control has focus, for example, a check box or radio button. If you want to set focus from within a row in a repeating grid to an editable control outside of the grid, provide the full path to the property, beginning with the parent page, and represent it on the Pages & Classes tab of the layout containing the repeating grid.

• Property — Enter a property reference target.

  For Value List, Value Group, Page List, and Page Group properties, enter a literal, property reference or symbolic index value (subscripts):

  .myList(15)

  .myGroup("Massachusetts")

• Value — Enter a property reference or a literal constant (source).

  Click the Add a row icon to add more properties and values.

  Examples:

  • Use multiple properties to populate a form quickly.
  • Set the value of a hidden property (in a cell using the pxHidden control), which triggers an event such as making a layout visible.

  To set a value from within a row in a repeating grid to an editable control outside of the grid, provide the full path to the property, beginning with the parent page, and represent it on the Pages & Classes tab of the layout containing the repeating grid.

• Section — Select the section that you want to include in the pop-up.
• Title — Optional. Enter a phrase that displays in the header area.

Specify the Header Source, if applicable, and the Tip Source (the body of the smart tip) as one of the following: Message, Property, Field value, or Plain text.

• Message — If you select Message as the header source or tip source, press the Down Arrow key in this field to select a blank or tip category Keystores. You can enter literal strings or property references in the Value field if the specified message supports parameters.
• Property — If you select Property as the header source or tip source, press the Down Arrow key in this field to select the property value that you want to display.
• Field value — If you select Field value as the header source or tip source, press the Down Arrow key in this field to select the field value that you want to display.
• Plain text — If you select Property as the header source or tip source, use this field to enter the text that you want to display.

Format — Select the format for the smart tip. You can style smart tips and create additional smart tip formats in the skin rule.

• The specified flow action and the current flow action have the same interface (reference the same named section).
• The flow action does not use HTML to render the interface (an autogenerated action with No HTML selected on form's HTML tab). Otherwise, clicking the control renders the flow action form only.

For Flow Action, select the Name key part of a flow action.

The Apply button on the update form sends changed user inputs to the server, but does not commit these changes. Users must select and complete a flow action to cause these changes to save.

When the user starts a modal flow, it runs on its own thread on the primary page of the harness containing the control.

When the user submits the modal flow's final assignment, the flow's page merges into the parent flow primary page. The following then occurs:

• The modal thread is deleted.
• The modal dialog automatically closes.
• The system refreshes the section on the user form containing the control. You can update other areas on the user form by appending actions such as Refresh Section (other), or Set Value to this control. These actions are triggered after the modal closes (canceled or submitted).

Specify the following:

• Using Page — Optional. If you want to run the flow in the context of an included section that uses either an embedded page such as .pyWorkParty(Originator), or another top-level page, enter a Page or Page List name that is defined on the section's Pages & Classes tab. When this control is used in a grid, and this field does not contain a value, then the primary page becomes the row page.
• Flow Name — Enter the Flow Name key part of a flow rule.
• Parameters — Optional. Displays parameters listed on the Parameters tab of the Flow rule form. Specify the values to pass to the flow.

Use auto-generated controls within modal dialogs. This ensures accurate server processing if a modal dialog is launched from a list or grid of work items configured with actions. An action on a work item in a list is created in a temporary work processing thread. Auto-generated controls default to this temporary thread. However, non-auto-generated controls may default to use the thread of the base document for AJAX interactions, instead of the temporary thread. Using auto-generated controls ensures accurate server processing.

More on modal flows:

• The modal displays only the action sections of the flow actions. Harnesses are not displayed. The Harness Name settings on the Assignment shape properties panels are ignored. You do not need to create modal-specific harnesses.
• If an assignment has multiple flow actions, only the default flow action (the one with the highest likelihood) appears in the modal dialog.
• A modal flow does not create its own pzInsKey or pyID. The Creates a new work object? setting on the Flow rule form's Process tab is ignored.
• If the parent primary page has a pyID, the system applies the modal Flow rule form's Temporary object? check box setting as follows:
  • Selected (create temporary object) — The modal flow does not save and commit the work item between modal screens. Assignments are not created. The modal flow page is merged with the parent primary page only when the final modal assignment is submitted. This configuration is useful for screen flows, and prevents hanging assignments if the user cancels the modal.
  • Not selected — The modal flow saves and commits the work item at each assignment, and can create assignments. This configuration is useful when the flow in the modal is routed to another operator who needs to perform the assignment.
• If the parent flow is a temporary work item (no pyID ), the modal flow always runs as a temporary work item, regardless of the Temporary object? check box setting.
• You can define styles and create custom formats for modal dialogs in the skin. Styles that you set in the modal dialog format in the skin are applied to the modal dialog templates, pyModalTemplate or pyGridModalTemplate. For more information, see Skin form — Components tab — General — Modal dialogs.

  To customize the modal's buttons, copy the appropriate template, standard section Work-.pyModalFlowTemplate to your application (do not change the Purpose key part). Modal flow actions use the buttons in this template. These are styled using the settings in the Standard Button format in the skin.

• The implementation and CSS classes for modal dialog formats differ, depending upon whether the application is rendered in HTML5 document type — standards mode or in quirks mode. For example, in HTML5 document type–standards mode, modal dialogs honor the design time width of the layout, while, in quirks mode, modal dialogs shrink to the minimum width and height possible. Drag and drop is not supported in modal dialogs rendered in standards mode. If your application contains modal dialogs and is rendered in both standards and quirks modes, generate test cases for each.
  Note: If this control is located in a repeating layout row, then settings for sorting, filtering, and expand-pane display will be lost when the section refreshes.

• Target — Define where the system will render the specified harness.
  • Replace Current — Replaces the current tab or dynamic container contents with the new harness. In a multidocument container, this setting replaces the harness that is currently open.
  • Pop-Up Window — Displays the harness in a new pop-up window.
  • New Document — Opens the harness and replaces the current dynamic container contents. In a multidocument container, this setting opens the harness as a new tab.
  • Ajax Container — Opens the harness in an Ajax container.
• Ajax Container Target — Optional. If no Ajax container exists, harness opens in a dynamic container. If no dynamic container exists, the harness opens in a new browser window.
  • Default — Opens the harness in the primary Ajax container.
  • Secondary — Opens the harness in the secondary Ajax container.
  • Tertiary — Opens the harness in the tertiary Ajax container.
• Harness — Select the harness that is displayed.
• Tab Name — Optional. Select a property or enter a text string that identifies a tab. If this value matches the name of an open tab, the new harness replaces the tab. Otherwise, the new harness is displayed in a new tab. Used when the Target option is set to New Document or Replace Current.
• Class — Select the class to which the harness belongs.
• Read Only — Select if you want the harness contents to display in read-only mode. If set to No, you must enter a window name. Used when the Target option is set to Pop-Up Window.
• Submit Current — Select to save the harness data before the system replaces the harness. Used when the Target option is set to Replace Current.
• Window Name — Optional. Enter a name that the system uses to identify a browser window. If a window of that name is open, the new harness replaces the contents of that window. Otherwise, the harness appears in a new window. Used when the Target option is set to Pop-Up Window.
• Window Width — Optional. Enter a positive integer to set the window width in pixels. If you leave this and the Window Height field blank, the system replicates the dimensions of the current window. Used when the Target option is set to Pop-Up Window.
• Window Height — Optional. Enter a positive integer to set the window height in pixels. Used when the Target option is set to Pop-Up Window.
• Key — Optional. Enter the key value (pzInsKey) of a data instance that you want to open automatically as the new primary page when the harness is displayed. The system uses this value to identify the record. This action executes before a pre-activity (if defined). Used when the Target option is set to New Document.
• Data Transform — Optional. Enter a Name key part of a data transform that might affect the content of the harness. Parameters listed on the Parameters tab of the Data Transform form are displayed beneath this field. Enter the values that you want pass to the data transform. For more information, see Data Transforms.
• Activity — Optional. Enter the key part Activity Name to cause the system to execute it before rendering the harness. This activity is processed after a data transform. Click the Open icon to open the rule. Parameters listed on the Parameters tab of the Activity rule form are displayed beneath the field. Enter the values that you want pass to the activity.
• Always display harness from the server — Optional. This option is only applicable to offline-enabled applications. When selected, it allows the offline-enabled application to explicitly display a harness from a server instead of the one from the client store.

• Action — Select one of two settings:
  • Display — Opens a landing page for display.
  • CreateNewWork — Creates a new work item based on a landing page.
• Name — Enter a unique name for the landing page. Attempting to open a landing page while a landing page with the same Name value is open results in the new landing page overriding the tab in which the already open landing page was displayed.
• Class — Enter one of the following, based on the action:
  • If Action is set to Display, enter the class on which the harness for the landing page is based.
  • If Action is set to CreateNewWork, enter the class on which the flow run is based to create the work item is based
• Harness Name — If Action is set to Display, select the harness that the landing page is built on.
• Data Transform — If Action is set to Display, select the data transform used to generate the landing page.
• Page — If Action is set to Display, specify an existing page.
• Read Only — If Action is set to CreateNewWork, specify the name of the flow used to create new work.
• Level A, Level B, Level C — Enter a value to work with a when condition on the harness to open the selected item in a specified tab on the landing page.

You can also specify additional parameters and corresponding values to pass to the harness or flow.

• Modal dialog — Requires the user to complete or dismiss the dialog before continuing work.
• Overlay — Launches the local action in a panel overlaying the current window. The user can dismiss it by clicking outside the overlay area or through an explicit DisplayClose action, configured in the local action. Use an overlay to display information such as simple forms or flows. You can use this in conjunction with actions on other controls; for example, a Text Input box, to create an advanced picker as shown in the UI Gallery. Some of the more advanced flow action features are not supported for overlays. For example, a flow action can launch a Dynamic Container-based harness. Launching this flow action in an overlay is not supported.
• Replace current — Appears in the current action section (.pyActionArea).

Although similar to local actions, you use Perform actions to advance the flow in those flow actions that do not have a user interface.

If you are using local actions in offline-enabled applications, see also Actions in offline mode.

Action

• Use Alternate Domain — Select to specify an alternate domain for the URL to open. Select a URL in the Alternate Domain URL field. Optionally, use the Querystring area to specify the names and values of query strings for the alternate domain URL.
• User Primary Page — Optional. Select to invoke an activity based on the contents of the primary page when this node is selected.
• Data Transform — Optional. Enter a Name key part of a data transform. Parameters listed on the Parameters tab of the Data Transform form are displayed beneath this field. Enter the values that you want pass to the data transform. For more information, see Data Transforms.
• Activity — Select an activity to return an HTML stream that displays in the opened window. This activity is processed after a data transform. Click the Open icon to open the rule. Parameters listed on the Parameters tab of the Activity rule form are displayed beneath the field. Enter the values that you want pass to the activity.

Window Properties

• Window Name — Specify a text string to define the name of the opened window.
• Replace History — Select to erase the history of the opened browser window.
• Height — Enter a numeric value to represent the height in pixels of the opened window
• Width — Enter a numeric value to represent the width in pixels of the opened window
• Top — Enter a numeric value to represent the offset in pixels from the top of the screen
• Left — Enter a numeric value to represent the offset in pixels from the left of the screen.
• Resizable — Select to enable the opened window to be resized.
• Scrollbars — Select to enable scrollbars in the opened window.
• Location Bar — Select to enable the location bar in the opened window.
• Menu Bar — Select to enable the browser's menu bar in the opened window.
• Status Bar — Select to enable the browser's status bar in the opened window.
• Tool Bar — Select to enable the browser's tool bar in the opened window.

Report actions

• Run Report — Runs the report specified in the Report name field.
• Run shortcut: — Opens a report shortcut to retrieve the specified report.
• New report: — Creates a new report

Target — Define where the system will render the specified report.

• Pop-up window — Displays the report in a new browser window.
• Replace current — Replaces the current tab contents with the new report definition.
• New document — Opens the report definition in a new tab that uses a separate thread and does not overwrite contents of a previously run report.

• Flow Action — Select the flow action that will be invoked.
• After Action — Select Refresh Current Item (recommended) to refresh only the current row after the flow action has ended. In most cases, leave this selection (default). Select Refresh All Items to refresh the entire layout.

Use auto-generated controls if you plan to configure actions on a list of work items. An action on a work item in a list is created in a temporary work processing thread. Auto-generated controls default to this temporary thread. However, non-auto-generated controls may default to use the thread of the base document for AJAX interactions, instead of the temporary thread. Using auto-generated controls ensures accurate server processing.

Disable submit on refresh — Select if you do not want to submit edited data to the clipboard. For example, you may want to use this option to reset the row by populating it with data from the clipboard, without submitting data that the user entered.

Current Item is the default action for Click events.

You can use Set focus with Keyboard events to enable users to navigate within a repeating grid using the Up and Down arrow keys. For example, configure the Keyboard Event Up to Set Focus to the Previous Item in the grid and the Keyboard Event Down to Set Focus to the Next Item in the grid. Use the Keyboard Event Enter to take an action, such as edit the selected item (Handle List ItemsEdit Item.)

If you want to set focus from within a row in a repeating grid to another grid or to an editable control outside of the current grid, select Set Focus in the Display category and provide the full path to the property, beginning with the parent page, and represent it on the Pages & Classes tab of the layout containing the repeating grid.

• Open rule by handle
• Open work by handle
• Get next work
• Show harness
• Open landing page
• Create new work
• Open rule by keys
• Open rule by class name
• Open rule specific

• Action to take – Select whether the action starts the tour or dismisses the tour.
• Always continue where left off – Select this check box to continue the tour where the user exited, if the user exited the tour at an intermediate stop.
• Tour applies to – Specify the class in which the tour is defined.
• Tour name – Specify the name of the tour to run.
• Override default tour stop container template – Select this check box to override the default template. Specify the template that you want to use in the Template name field.

• Handle — A pzInsKey key value in the rule you want to open.
• Resolve By — To determine how the system locates the rule, enter one of the following:
  • Name – A Property Name key value.
  • Handle — Value entered in the Handle field.
  • Handle By Condition — A when condition that qualifies the value entered in the Handle field.

• Page — Select Auto to keep the primary page context. Select Other to use another page context.
• Name — Appears if you select Other on the Page field. Enter the page name.
• Data Transform — Enter the Name key part. Parameters listed on the Data Transform form's Parameters tab appear beneath the field. Enter the values you want pass to the data transform.

• Function Name — Select the property or literal reference that contains the function you wish to run. (In the Control form, only @ baseclass properties appear).

  Enter the JavaScript file using this function on the Harness rule form's Scripts and Styles tab. The Run Script action instructs the browser to find a JavaScript function with that name and then pass those parameters. If the same function is used in multiple files in the list, the last file is used (the last function overwrites the others with that name). The browser uses the defined function when it executes the JavaScript file.

  Do not use ( ) in the function or parameter names.

  You can specify a property that stores the name of the function.

  To use javascript object references, prepend script: or javascript: to name of the javascript function.

  For example script:window.alert

  Use “ ” to specify literal values.

  You can also use script:MyObject.MyField to access objects in function parameters.

• Parameter area — Optional. Enter parameter names and values (constants or properties). Order is important; if necessary, reorder the list by selecting a row and moving it.