¶ Pipelines page details
The pipelines tab view is divided in 3 parts:
- On the left side, Pipeline menu allows users to create a new project. By opening a new project folder, users can create new pipelines and access all pipelines related to their profile (drafts, published, production, ....)
- The center part of the view displays pipelines as a list
- The right auxiliary panel displays pipelines details and documentation
¶ Pipeline menu
Managers and users with write pipelines permition have access to the Pipeline menu, located in the left panel of the Pipelines tab.
This menu organizes all pipelines by their state or category, providing a quick way to browse and access them.
The visibility of some directories depends on the user’s permissions and role.
Available Directories
-
Projects:
Lists all project containers that group pipelines. -
Draft:
Displays all personal draft pipelines that have not been published yet. -
Draft (Team):
Contains group draft pipelines shared between team members.
This directory is visible only for users with the Manager role. -
Published:
Lists all pipelines published by the user or by members of the same group. -
In Production:
Displays pipelines currently running in a production environment.
This section is visible only for Managers and for users with permissions to Manage Jobs. -
Favorites:
Contains pipelines marked as favorites by the user for quick access. -
Recent:
Shows recently created, edited, or executed pipelines. -
Trash:
Displays pipelines previously deleted by the user but still recoverable.
¶ Pipeline list
In the center of the Pipelines tab view, the Pipeline list displays all available projects or pipelines, depending on the selected directory from the left-hand menu.
When the Projects section is active, it shows all existing project containers, each grouping one or more pipelines.
Selecting a project updates the view to display the pipelines it contains, along with relevant details such as name, state, author, and last modification date.
The Draft directory lists all draft projects and their associated pipelines. Opening a project folder displays its pipelines for review and management. Available actions include Edit Pipeline, Publish, Copy Pipeline, Move to Trash, and Mark as Favorite.
When a project is selected, a right-side panel appears, displaying additional details and options related to the selected project or pipeline.
The sidebar provides two tabs:
- Info – shows general information such as project state, author, and modification dates.
- Doc – allows users to view or edit the pipeline documentation directly.
From the sidebar, several actions are available:
- Publish – moves the selected project to the Published directory, making it available to other users.
- Edit – opens the properties window, allowing you to change the project name or description.
- Move – relocates the project into another project folder.
- Export – downloads the selected project as a
.apzipfile, including assets, constants, databases, and sources. - Remove – deletes the selected draft project.
The Published directory displays all pipelines that have been published and are available for use or reference.
In this view, users can:
- Open and edit an existing published pipeline.
- Access its documentation or export it.
- Move the pipeline to another project or unpublish it when needed.
All actions are available from the action menu on the right side of each pipeline row.
When a project is selected, a right-side panel appears, providing details and quick actions related to the selected item.
The sidebar contains two tabs:
- Info – displays key information such as the project state, author, and modification date.
- Doc – allows users to open or edit the documentation associated with the selected project.
From the sidebar, users can perform the following actions:
- Unpublish – move the project back to the Draft directory.
- Edit – change the project name or description.
- Move – relocate the published project to another folder.
- Export – download the project as an
.apziparchive, including assets, constants, databases, and sources. - Remove – delete the selected published project.
The Production directory is accessible to Managers and users who have the Manage Jobs permission.
This section displays all pipelines that are deployed and ready for execution in the production environment.
The main view lists each pipeline along with key execution information — including version, status, next run, and performance metrics such as CPU, memory, and priority.
It allows users to quickly monitor the operational state of production pipelines.
Each pipeline row provides quick-action buttons to:
- View Logs – open the execution logs for the selected pipeline.
- Execute Now – trigger an immediate pipeline execution.
- Remove from Production – unpublish the pipeline and return it to the Published directory.
When selecting a pipeline, a right-side panel appears with multiple management tabs:
- Info – displays pipeline metadata such as version, creation date, and path.
- Schedule – allows setting up automatic or manual pipeline executions.
- Logs – provides access to previous run details and results.
- Files – lists output files available for download.
From this panel, users can perform the following actions:
- Execute – manually run the selected pipeline.
- Open – view the pipeline in read-only mode.
- Set Notification – define email alerts for specific run statuses (success, warning, or error).
- Remove from Production – move the pipeline back to Published.
In favorites, recent and trash directories, the pipeline list displays the name, state, and author. It also provides action buttons such as Copy, Move Pipeline to Trash and Mark Pipeline as Favourite.
Above the pipeline list, several action buttons are available:
- Publish: Makes your changes visible to others.
- Move: Move the currently selected pipeline to an other location.
- Copy: Duplicate the currently selected pipeline.
- Move to trash: Delete a pipeline in the list.
- Search engine: self-explanatory.
¶ Pipeline creation
This action is available for Managers and users with the Write Pipelines permission.
Pipeline creation is managed within the Draft directory. Users can first define a Project, which acts as a container for one or more pipelines. Each project includes a name and an optional description.
Once a project exists, new pipelines can be created inside it. The creation window allows defining the pipeline name and optional description, while the location is automatically linked to the selected project folder.
After creation, the pipeline appears in Draft state and becomes accessible through the Draft directory in the pipeline menu.
¶ Project export and import
The export feature allows users to create a backup or shareable version of a project in .apzip format.
This option is accessible from the More actions menu of any project.
When exporting, a dialog window appears where the user can choose which elements to include, such as Assets, Constants, Databases, Sources, and Disk images.
The selected items are packaged into a single .apzip archive file, which is automatically downloaded to the user’s device.
Projects and pipelines can later be imported back into the Draft directory.
The import supports:
- Projects in
.apzipformat - Pipelines in
.apjsonformat
To import, users simply drag and drop the exported file into the workspace.
Imported projects appear in the list with the suffix (imported), preserving the original structure and content.
¶ Pipeline deletion
From the pipelines list in the center of the view, user can send to trash one or several pipelines. This action is available through two buttons:
- By clicking the Trash button at the top center of the list, the user can select one or more pipelines by clicking the checkbox on the left side of the list entry and then clicking Trash to “delete” the selected pipelines. Alternatively, the user can expand the More Actions menu in the pipeline auxiliary menu and click Trash to “delete” the selected pipelines.
- By clicking the Trash button that appears when the user hovers the mouse over a pipeline name in the list, the pipeline is sent to trash.
All pipelines sent to trash with this action are stored in the Trash directory accessible through the pipeline menu. See pipeline restoration for more information.
¶ Pipeline restoration
Pipelines previously moved to trash by users are stored in a particular directory acessible through the pipeline left menu item; Trash. This directory helps to prevent from pipelines accidental deletion by keeping track of all designed pipelines
It also provides a restoration mecanism available through a button above the pipeline list.
User has to select one or several pipeline(s) in the list and click on the restoration button. When it is done, pipeline(s) selected are restored to their original location and state.
¶ Pipeline duplication
From the pipeline list in the center of the view, the user can duplicate one or more pipelines by clicking the Copy button. This action is available through two buttons:
- By clicking the Copy button at the top center of the list (for multiple duplications), the user can select one or more pipelines by checking the boxes on the left side of the list entries and then clicking Copy to duplicate them. Alternatively, the user can expand the More Actions menu in the pipeline auxiliary panel and click Copy to duplicate the selected pipelines.
- When clicking Copy, a new window opens allowing the user to choose in which project the duplicated pipeline will be placed — either in the same project or in a different one.
The pipeline is created with the same content, and its name is the original pipeline name followed by the string “(copy)”.
In this example, the test pipeline has been duplicated one time, resulting in a new test (copy) pipeline created in the selected project.
¶ Pipeline favorites
From the pipeline list in the center of the view, user can add as Favorite one pipeline.
When the user marks a pipeline as a favorite, it also becomes available in the Favorites menu on the left side.
¶ Pipeline search
From the pipeline in the center of the view, user can filter pipeline name by entering partial or complete string search in the dedicated form.
¶ Project publication
As described previously, when user create a project from the create action, resulting project is stored in a Draft state. This means that only the creator of the project is able to manage pipeline (open, modify, delete, ....). The publish action is available when the user hovers the mouse over the project name in the list; a publish button appears and can be clicked by the user.
¶ Pipeline version
Pipelines in published state can be tagged with a version name/number. This version tag will allow other group users to exploit several version of the same pipeline.
To tag a pipeline with a version, user has to select a pipeline in the pipeline list and select Versions tab in the pipeline auxiliary. At the top of this auxiliary tab, a Add button is available. Clicking on this button open a popup and let the user type a name for its version.
When the user click on the Apply button in the popup, the auxiliary Versions tab display the name of the previously created version. In this case v1.1 is the version of the pipeline.
¶ Pipeline production state
Only pipelines with version are able to be set in production state. User has to select a pipeline in the published pipeline list and open the Versions tab in the right auxiliary. In this tab, user can see all versions available for this pipeline and can put in production state a pipeline by switching on the corresponding button.
In this case, a version named 0.0.1 of test pipeline is published by switching on the toggle button.
All pipeline in production are listed in the In Production menu item in the pipeline menu (left side menu). test pipeline in 0.0.1 version is now in production and ready to be used by others users.
¶ Pipeline scheduling and execution
All pipeline in Production state can be immediately executed or scheduled for later execution.
¶ Pipeline immediate execution
User can start immediately a pipeline execution through:
- The action button available when user hovers the mouse over a pipeline name in the list.
- Action menu available at the bottom of the info tab of the right auxiliary.
When user starts pipeline execution, Suspend execution and Stop execution items switch to active mode and can be clicked to suspend temporarly the execution or stop it.
¶ Execution options pop-up
When clicking the Execute button in the Production view, a pop-up dialog appears that allows the user to configure additional execution options before starting the run.
This pop-up contains two parameters:
-
Priority:
Defines the execution priority of the pipeline in the job queue. Higher priority jobs are scheduled before lower priority ones. The default value is 5 (normal priority). Values can be adjusted depending on workload and urgency. -
RunToFinishLine pin to start from:
This parameter allows skipping parts of the pipeline.
By default, the value is 0, meaning the pipeline starts from the beginning.
If set to 2, for example, all transformations connected to pins 0 and 1 of theRunToFinishLinecomponent will be ignored, and execution will resume only from later pins.
This is useful for partial re-runs or bypassing heavy initialization steps.
Once the options are set, the user can press Start to enqueue the job. A confirmation message (“A job was queued, it will start as soon as possible”) will then be displayed at the top of the screen.
¶ Pipeline scheduled execution
User can create a new scheduled execution for a pipeline or edit a previously configured schedule. Two ways are available to create a new schedule:
- Through the Add button at the bottom of the schedule tab
- Through the action button displayed at the right of a the currently selected pipeline
Clicking on one of these button open the schedule popup window:
User has to define schedule parameters:
- Priority: assign a execution priority in cas of multiple execution schedule at the same time.
- Trigger: trigger execution on date or file presence.
- Occurence: execution frequency; once, monthly, weekly, daily, hourly.
- Remove after execution: non recurrent task, option combined with occurence value once.
- Calendar date:
- Approximative schedule: pipeline can be executed approximatively at time configured.
- Schedule time: self-explanatory.
Clicking on apply create the scheduling execution.
¶ Edit scheduling execution
To edit a previously configured scheduling, user has two posibilities:
- Click on the pen button in the schedule tab of the riht auxiliary
- Click on the clock button displayed at the right of a the currently selected pipeline
User can modify scheduling details (date, occurence, trigger, ....) in the same popup as scheduling execution creation.