Configuring the Action Button to run an action

You can run a process, an AI job, or both from an Action Button, and navigate immediately or navigate after the run completes.

The configuration settings for Action Buttons are available under Properties. Enable any process to see the available settings.

You can configure each process and navigation to run on its own or in any combination with each other. For example, you can configure:
  • A process to run and then navigate
  • An AI Job to run after a process completes successfully
  • An AI Job to run and navigate immediately
  • A process to run and after successful completion, run an AI Job and navigation at the same time
  • A process and an AI Job to run and then navigate after their successful completion.

Run process

Use Run process to define the process that is run when you click the Action Button.
  1. In Edit mode, select the Action Button that you want to configure and under Properties > Configure, enable Run process.
  2. Select the database on which the process resides.
  3. Select the process that you want to run.
  4. If the process includes parameters that must be set before execution, click Set parameters to set the parameter values or configure user prompts that can be answered to set parameter values.
  5. Select Refresh after execution if you want to refresh the current book after the process finishes running. The refresh updates any views, websheets, visualizations, or selectors in the target book.
  6. If you want the process to use a file when it is run, select Allow file upload. This option allows you to upload a file to the database when you click the Action Button.
    Note: The process runs only if the file is uploaded successfully.
  7. If you want to configure custom notifications to display the status of the TurboIntegrator process when it is run from an Action Button, click Customize notifications. You can create a notification to display when a process completes successfully, completes with a warning, or fails.
    1. Choose the notification type that you want to customize.
    2. Enter the notification message and select the amount of time it displays on the screen. Select Until close for Time on screen if you want to close the notification manually.
  8. Select one of the following Execute second click options to configure the action button for additional clicks:
    1. Cancel process - When an action button that is already running a process is clicked again, the process is canceled, and a related message is displayed. This is the default behavior, which is known from previous versions of the product.
    2. Do nothing - When an action button that is already running a process is clicked again the process continues to run. A new process is not started.
    3. Run processes in parallel - When an action button that is already running a process is clicked again a new process is started, and the previous process or processes continue to run. This option is useful when the book user wants to run a series of overlapping processes by using the same action button.
      Note: You can run a maximum of 5 processes in parallel. If you attempt to run the 6th process, a message about this limit is displayed.

Run an AI job

Use Run AI Job to define the job that is run when you click the Action Button.

  1. In Edit mode, select the Action Button that you want to configure and under Properties > Configure, enable Run AI Job.
  2. Select the deployment and job that you want to run.
  3. Select Refresh after execution if you want to refresh the current book after the process finishes running.

Navigation

Use Navigation to specify the destination that is opened when you click the Action Button.
  1. In Edit mode, select the Action Button that you want to configure and under Properties > Configure, enable Navigation.
    1. To navigate immediately upon clicking the Action Button, choose Immediately and select the destination.

      1. To go to a tab in the current book, click Tab, then select the tab that you want to open from the list of available tabs.

      2. To go to a tab in a different book, click Book and select a book, and the tab you want to open. Click Pass context to pass context for any items that have synchronization that is enabled in both the current tab and the destination tab.

        If you configure an Action Button to navigate to a tab in another book, you can rename the target book and/or sheet without having to update the button properties. The button automatically resolves any name changes to target tabs or books.

      3. Click Refresh target book option to refresh a target book you are navigating to, if the book is already open. When the Pass context is also enabled, context passes for any items that have synchronization enabled and the target book refreshes. If Pass context is enabled but no context is being passed on navigation, the target book still refreshes, if it is already open.

      4. To open a URL, click Hyperlink, then enter a fully qualified URL.

    2. To navigate after a process completes, select After process completes and select where you want to navigate to when the process completes successfully and when the process completes with errors.

      If you run a process and an AI job, then both must complete successfully for you to select the navigation options for when the process completes successfully. If the process or the AI job fails, then you need to specify the navigation options for when the process completes with error.