Main View |
The Integration Builder Main View is where you can configure the properties of an integration and select and configure the actions for the integration. It can be opened from the Start View by making a selection from the Start section or by opening a recently created integration from the Recent list of integrations.
The Main View includes the following components and controls:
The quick access toolbar is displayed by default at the top of the Main View window and provides the following controls:
: Saves the active integration using the same file name from which it was previously saved. If the integration is new and has not been previously saved, the Save As dialog will be displayed.
: Reverses the previous action.
: Reverses the previously undone action.
: When the Quick Access toolbar is located in its default position (at the top of the Main View window), this control allows you to relocate it to below the toolbar on the Home tab. When the toolbar is located on the Home tab, this control allows you to relocate it to the top of the Main View window.
The Administration tab provides access to the standard file functions such as New, Open, Save, Save As, and Close. It additionally provides access to views that enable you to open recently saved integrations, deploy integrations and create integration plans, and view and create global variables that can be used by any integration.
Click the option that you want in the left navigation pane:
New: Opens a new instance of Integration Builder to the Start View, from which you can choose to create a new integration file.
Open: Opens the Open File dialog, were you can navigate to and select an existing integration file to open.
Save: Saves the integration by using the same file name with which it was previously saved. If the integration is new and has not been previously saved, the Save As dialog will be displayed.
Save As: Displays the Save As dialog, which enables you to save the active integration by defining the name and specifying a location where it will be saved.
Close: Closes the active integration without exiting Integration Builder and displays the Start View. If you have not previously saved the changes that you made to the active integration, you will prompted to do so.
Recent: If you have previously created one or more integrations, those integrations will be listed here. You can click a listed integration to open it on the Home tab.
Deploy: Displays the Deployment page, where you can schedule deployments for integrations. By using this page, you can additionally save a deployment plan for later modifications rather than releasing it immediately as an active deployment schedule.
Options: Displays the Options page, where you can specify a name and description for the integration file. You can also view predefined global variables that are available for use by all integrations in the currently selected integration file and create your own custom global variables.
Help: The Help page contains options that enable you to access help and product information about BarTender.
Exit: Terminates the application. If you have not previously saved the changes that you made to the active integration, you will prompted to do so.
The Home tab enables you to configure the properties for the selected integration and the actions that you want the integration to perform. You can also test and deploy your integration on this tab.
The Home tab includes the following components and controls:
The integration toolbar is located at the top of the Home tab and provides the following controls:
: Opens a menu that displays recently added integration methods. Click one of these integration methods to add a new integration of that type to the integration file. Alternatively, click More Integrations to open the New Integration dialog, where you can select the integration that you want to add to the integration file.
: Opens the New Integration dialog, where you can select the integration you want to add to the integration file.
: Adds a Print Document action to the currently selected integration method.
: Opens a menu that displays recently added actions. Click one of these actions to add a new action of that type to the currently selected integration method. Alternatively, click More Actions to open the New Action dialog, where you can select the action that you want to add to the currently selected integration.
: Adds a Group action to the currently selected integration method.
: Opens the New Action dialog, where you can select the action that you want to add to the currently selected integration.
: Open the Test pane so that you can test the selected integration.
: Opens the New Deployment dialog, where you can specify when you want the integration deployed. When you click OK to close the New Deployment dialog, Integration Builder displays the Deployment page on the Administration tab, where you can verify that the integration is scheduled to be deployed.
The Integrations pane lists all the integrations that are part of the open integration file. When you click one of the integrations in this list, the name is highlighted, and information about this integration is displayed in the other panes of the Home tab.
The following options are available from the integrations context menu, which you can access by right-clicking an existing integration in the pane:
New: Opens the New Integration dialog, which enables you to add another integration to the integration file.
Duplicate: Creates a duplicate copy of the integration from which the context menu was opened.
Cut: Deletes the integration from which the context menu was opened and copies it to the clipboard.
Copy: Copies the integration to the clipboard.
Paste: Pastes an integration into the list that was previously copied to the clipboard.
Delete: Deletes the integration from which the context menu was opened.
Move Up: Moves the integration from which the context menu was opened up one level in the list of integrations.
Move Down: Moves the integration from which the context menu was opened down one level in the list of integrations.
|
The order that the integrations appear in the Integrations pane has no effect on the order in which they are run. When the integration file is deployed, the integrations that have been started run simultaneously. |
The Integration Settings pane provides access to the property pages of the integration that is currently selected in the Integrations pane. In the Actions section of the pane, you can add actions the integration. Selecting the action or a property page from this list results in the property page being displayed in the Properties pane, where you can configure the properties as needed.
The following options are available from the actions context menu, which you can access by right-clicking an existing action in the pane:
New: Opens the New Action dialog, which enables you to add another integration to the integration file.
Duplicate: Creates a duplicate copy of the action from which the context menu was opened.
Cut: Deletes the action from which the context menu was opened and copies it to the clipboard.
Copy: Copies the action to the clipboard.
Paste: Pastes an action into the list that was previously copied to the clipboard.
Delete: Deletes the action from which the context menu was opened.
Move Up: Moves the action from which the context menu was opened up one level in the list of actions.
Move Down: Moves the action from which the context menu was opened down one level in the list of actions.
The Properties pane enables you to configure the settings for the selected integration property page or for the selected action. You can access the Properties pane on the Home tab by clicking the Properties tab at the bottom of the window.
The properties that are available in the Properties pane depend on the property page or action that is selected. For more information about the available properties, refer to the Help page for the specific integration you are designing, because it will provide links to the property pages for that integration. Alternatively, if you are configuring an action, see the Help page for the specific action that you are configuring.
The Test pane enables you to test an individual integration in an integration file. Select the integration that you want in the Integrations pane, and then click the Test tab at the bottom of the window. If the selected integration has been configured to run immediately, it will begin running as soon as the Test pane is displayed.
On the Test pane, you can start and stop the integration and view general details about its execution. The pane further provides a view that shows each action that the integration runs and an output view where you can review logged messages for the integration and its actions, including errors, warnings, messages, and events.
For more information about using the Test pane to test your integrations, refer to Using the Test Pane.
The Manage tab provides a management toolbar that enables one-click access to Administration Console resources to help you manage your integrations with BarTender. Options include the following:
: Opens the Administration Console
: Opens the Administration Console
: Opens the Administration Console
: Opens the Administration Console Windows Services page, where you can
The Tools tab provides a tools toolbar that enables one-click access to the applications that are included in your BarTender Suite. Options may include the following:
: Opens
: Opens
: Opens
: Opens
: Opens
: Opens
: Opens
: Opens the Seagull License Server dialog so you can start your
: Opens