The main visual element on the home page is a list of existing Pipelines.
- Status - This icon indicates the current state of the Pipeline:
Stopped: The Pipeline is not currently forwarding data to the specified Target(s).
Running: The Pipeline is currently forwarding data from all specified Sources to the specified Target(s).
Partially Running: Some Sources within the Pipeline are running, others are stopped.
- Pipeline - This is the user-supplied name of the Pipeline. By clicking on the Name, the Edit Pipeline canvas will be displayed with a visual representation of the selected Pipeline including the Source, any Processes and the Target. The Pipeline can be edited and re-saved if required.
- Sources - The number of Sources that are defined within the Pipeline. For z/OS based Pipelines this will always be one Source but for IBM i based Pipelines this could be multiple Sources. IBM i based pipelines can be expanded to show individual entries in the table for each Source and the status of each Source can be controlled by using the context menu alongside the Source Name (see Context Menu).
- Source Type - The origin of the data, defined by the Source Type (i.e. either an IBM i or IBM z system).
- Target Type and Name - The destination of the data, defined by a Target Type (e.g. Splunk, QRadar) and the user-defined name of the Target. If a pipeline has multiple Targets, the list of types and names will all be shown. If this list extends beyond the width of the column, you can hover over the field and a list of all the Target Types and names will be shown. These are the Target Types:
- Last Saved - The timestamp of the last update made to the Pipeline.
Note:
- The list can be sorted by any of the columns by clicking the up and down arrows alongside the column header.
- Each line in the table will have a corresponding context menu, allowing you to control or alter the selected item, whether it is a Pipeline or a single data source.
- The options available on the context menu will depend on the type and status of the line. For example, a running Source line will have a different context menu than a stopped mainframe Pipeline.
The figure below shows a pop-up menu that appears alongside each Pipeline name and has the following Pipeline options available:
-
Start - This option will only be available for Pipelines or individual Sources that are in a ‘Stopped’ state. Selecting it will start the appropriate dataflow, assuming valid licences are in place. Appropriate messages will be displayed to indicate the success or failure of the action.Note:
- If a Pipeline is started, then the data flows for all sources contained within the Pipeline will be started.
- If an individual Source is started, then only that Source will be started, all others on the Pipeline will remain in their previous state.
-
Stop - This option will only be available for Pipelines or individual Sources that are in a ‘Running’ state. Selecting it will request the appropriate dataflow to stop after handling any ‘in flight’ data already being forwarded. A message will be displayed when the flow is successfully stopped.Note:
- If a Pipeline is stopped, then the data flows for all sources contained within the Pipeline will be stopped.
- If an individual Source is stopped, then only that specific Source will be stopped, all others on the Pipeline will remain in their previous state.
-
Edit - This option is only available at the Pipeline level, and will be enabled regardless of Pipeline status. Selecting it will load the selected Pipeline into the Pipeline Editor where changes can be made and the Pipeline re-saved.Important: A running Pipeline will need to be restarted if any changes are made.
-
View Log - This option will only be available at an IBM i Source level, where log files exist. Selecting it will display the LPAR specific log for the selected Source.Note: By default, individual Source level logging is not enabled. It will need to be turned on via the log tab on the IBM i Source configuration panel.
- View Latest Errors - This option will display a pop-up with a table that contains the most recent five errors for the selected Pipeline or Source. If there are fewer than five errors in the log, then all errors will be displayed. The table will show summary information of date, time, and error message. Expanding a row will display the complete error message as it appears in the log file. The complete error message may contain some additional, useful information to help diagnose or resolve the error.
- Delete - This option will be available for all Pipelines. Selecting it will trigger a confirmation dialog before the deletion is actually executed. The pipeline will be stopped and deleted, and a message will be displayed once the Pipeline has been successfully deleted.