Navigating FlexFiles Architect

Owned by Former user (Deleted)
Last updated: May 04, 2020
7 min read

Note: SoftNAS® FlexFiles Architect is a part of our legacy SoftNAS Platinum offering. It will not be visible in versions above 4.4.1 of our SoftNAS product, and is included here for legacy purposes.


Label

Add a label to any workflow you create, to see at a glance the purpose and function, or to label the location it represents. Click and drag to the location on the workspace you wish to label. A label will appear.

Right-click and select Configure to configure the label text.


To change the label color, select Change color.




Select the desired color using the provided custom color selector.



Add Template

Add Template is the go-to icon within FlexFiles Architect, allowing you to apply a template to common workflows. Simply click the icon and drag into the workspace. This will open the Add Template window, where you can select your desired template from the existing list. New templates will be added over time, check back with each update.


Simply select the template you wish to add, and it will appear in the workspace. More templates will be added over time. 


Funnel

Here you can create a data funnel, and connect disparate data sources to a single repository. Click and drag the funnel icon to the center of the workspace and connect the data sources to the funnel, as well as the receiving downstream connection. 



Remote Processor Group

Remote Process Groups appear and behave similar to Process Groups. However, the Remote Process Group (RPG) references a remote instance of FlexFiles Architect. When an RPG is dragged onto the canvas, rather than being prompted for a name, the Data Flow Manager (DFM) is prompted for the URL of the remote FlexFiles Architect instance. If the remote FlexFiles Architect is a clustered instance, the URL that should be used is the URL of any instance in that cluster. When data is transferred to a clustered instance of FlexFiles Architect via an RPG, the RPG will first connect to the remote instance whose URL is configured to determine which nodes are in the cluster and how busy each node is. This information is then used to load balance the data that is pushed to each node. The remote instances are then interrogated periodically to determine information about any nodes that are dropped from or added to the cluster and to recalculate the load balancing based on each node’s load. 


Process Group

Process Groups can be used to logically group a set of components so that the dataflow is easier to understand and maintain. When a Process Group is dragged onto the canvas, the DFM is prompted to name the Process Group. All Process Groups within the same parent group must have unique names. The Process Group will then be nested within that parent group.

Once you have dragged a Process Group onto the canvas, you can interact with it by right-clicking on the Process Group and selecting an option from context menu.The options available to you from the context menu vary, depending on the privileges assigned to you.

While the options available from the context menu vary, the following options are typically available when you have full privileges to work with the Process Group:

  • Configure: This option allows the user to establish or change the configuration of the Process Group.

  • Enter group: This option allows the user to enter the Process Group. It is also possible to double-click on the Process Group to enter it.

  • Start: This option allows the user to start a Process Group.

  • Stop: This option allows the user to stop a Process Group.

  • Group: This option allows the user to create a new Process Group that contains the selected Process Group and any other components selected on the canvas.

  • Status History: This option opens a graphical representation of the Process Group’s statistical information over time.

  • Upstream connections: This option allows the user to see and "jump to" upstream connections that are coming into the Process Group.

  • Downstream connections: This option allows the user to see and "jump to" downstream connections that are going out of the Process Group.

  • Center in view: This option centers the view of the canvas on the given Process Group.

  • Copy: This option places a copy of the selected Process Group on the clipboard, so that it may be pasted elsewhere on the canvas by right-clicking on the canvas and selecting Paste. The Copy/Paste actions also may be done using the keystrokes Ctrl-C (Command-C) and Ctrl-V (Command-V).

  • Delete: This option allows the DataFlow Manager (DFM)to delete a Process Group

Under General, you can provide optional information (comments) on the purpose of your Processor Group. Click Apply to add your comments.


Under Controller Services, you can add the controller services that will make up your Processor Group. Click the plus symbol ('+') to add these services.


Add the controller services desired. Either type key words to find the controller services you need, or filter based on the common tags provided, as shown below. 


Input Port 

Input Port allows you to define the port or ports that will be used to allow data to flow into an existing workflow. Click and drag the icon into your workspace to create the input port, name it, and click Add.



Right-click the Input Port and select Configure to configure your port.





Output Port

Output Port allows you to define the port or ports that will be used to allow data to flow into an existing workflow. Click and drag the icon into your workspace to create the input port, name it, and click Add.


Right-click the Output Port and select Configure to configure your port.





Processor

The Processor is the most commonly used component, as it is responsible for data ingress, egress, routing, and manipulating. There are many different types of Processors, and many more are added regularly.  Here you can add a processor to your workflow, or to an existing Process Group by clicking and dragging to the desired location. Select the type of processor you wish to add. Either type key words to find the processor you need, or filter based on the common tags provided, as shown below. 


  • Configure: This option allows the user to establish or change the configuration of the Processor.

  • Start or Stop: This option allows the user to start or stop a Processor; the option will be either Start or Stop, depending on the current state of the Processor.

  • Enable or Disable: This option allows the user to enable or enable a Processor; the option will be either Enable or Disable, depending on the current state of the Processor.

  • Status History: This option opens a graphical representation of the Processor’s statistical information over time.

  • Data provenance: This option displays the NiFi Data Provenance table, with information about data provenance events for the FlowFiles routed through that Processor.

  • Upstream connections: This option allows the user to see and "jump to" upstream connections that are coming into the Processor. This is particularly useful when processors connect into and out of other Process Groups.

  • Downstream connections: This option allows the user to see and "jump to" downstream connections that are going out of the Processor. This is particularly useful when processors connect into and out of other Process Groups.

  • Usage: This option takes the user to the Processor’s usage documentation.

  • Change color: This option allows the user to change the color of the Processor, which can make the visual management of large flows easier.

  • Center in view: This option centers the view of the canvas on the given Processor.

  • Copy: This option places a copy of the selected Processor on the clipboard, so that it may be pasted elsewhere on the canvas by right-clicking on the canvas and selecting Paste. The Copy/Paste actions also may be done using the keystrokes Ctrl-C (Command-C) and Ctrl-V (Command-V).

  • Delete: This option allows the DFM to delete a Processor from the canvas.



Navigate Panel 

The Navigate Panel  allows you to shrink and enlarge the workspace view, as well as to scroll over large workspaces to find items, or center items that are off-screen. 



Operate Panel

The Operate Panel displays the selected item or level of hierarchy you are currently on, and the operations that are available for that item or hierarchy. For example, in the image below, the Operate panel relates to the selected Remote Factory Aggregation, and presents the actions applicable to this processor group.