Table of Contents

Table of Contents

Release Notes and History

FloWorks Release Notes and History

The following is a list of features and fixes that have been included in the latest FloWorks releases.

FloWorks 20.2.0 (20 August 2020)

  • FloWorks Process Flow templates added to Toolbox menu.
  • New chart templates for Dashboard Library and Pin buttons.
  • FloWorks Product Table is now globally accessible through the Toolbox.
  • FloWorks colors for new models are now determined by Color Palette.
  • Textures can be applied to products when using FloWorks Product Table.
  • All bug fixes included in FloWorks 20.0.2 below.

FloWorks 20.1.3 (August 2020)

FloWorks 20.1.2 (15 June 2020)

  • Bug fix: Fixed exception in release of Flow To Item.
  • Bug fix: Removed internal output to console.
  • Bug fix: Removed redundant license check in old solver.

FloWorks 20.1.1 (23 April 2020)

  • Bug fix: Update script for FloWorks Custom Action activities.
  • Bug fix / improvement: Library grid updated.

FloWorks 20.1.0 (17 April 2020)

  • Release for FlexSim 2020 Update 1.

FloWorks 20.0.2 (August 2020)

  • Bug fix: Set content activity uses FlowTank in code header. Added "Max. content" option to picklist.
  • Bug fix: Process Flow activity did not correctly set relative output trigger amount.
  • Bug fix: Flow item tank reset content at end of warmup.
  • Bug fix: Adding Process Flow activity created module dependency.
  • Bug fix: Documentation for flow processor updated.
  • Bug fix: Update script for FloWorks Custom Action activities.
  • Bug fix / improvement: Library grid updated.
  • Bug fix: Fixed exception in release of Flow To Item.
  • Bug fix: Removed internal output to console.
  • Bug fix: Removed redundant license check in old solver.

FloWorks 20.0.1 (04 February 2020)

  • Bug fix: Fixed incorrect berth configurations.
  • Bug fix: Removed popup during startup.
  • Bug fix: MODE_RESTART_FALLING was sometimes incorrectly #defined the same as MODE_RESTART_RISING.
  • Bug fix: Several bug fixes and improved stability for the new (beta) solver.
  • Documentation: updated Tank trigger levels description.

FloWorks 20.0.0 (13 December 2019)

  • Feature: Added Process Flow activities for FloWorks.
  • Feature: Added Process Flow templates for Basic Berth and Tank Pool.
  • User request: Added option not to checkout FloWorks license.
  • Bug fix: Removed inconsistent behavior after (de)activating license.
  • Bug fix: Tank level trigger could cause event list to become unsorted.
  • Bug fix: Max. Object Depth setting in FloWorks charts was ignored.

FloWorks 19.2.2 (13 December 2019)

  • Bug fix: FlexSim 19.2.4 removed node that was overridden in FloWorks
  • All changes included in version 19.0.8.

FloWorks 19.2.1 (18 October 2019)

  • Bug fix: allow objects to be created when no runtime license present.
  • All changes included in version 19.0.7.

FloWorks 19.2.0 (26 September 2019)

  • Flow pump / valve input and output can be set to balanced rate by % simultaneously.
  • Flow To Item can now buffer additional material before blocking.
  • New segmented flow pipe object.
  • Created new runtime license type.
  • All changes included in version 19.0.5.

FloWorks 19.1.5 (18 October 2019)

FloWorks 19.1.4 (09 October 2019)

  • Bug fix: Restored objects missing from library and icon grid.

FloWorks 19.1.3 (26 September 2019)

FloWorks 19.1.2 (19 July 2019)

  • Bug fix: dragging in a shape from a group will no longer create the first shape in the group.
  • All changes included in version 19.0.4.

FloWorks 19.1.1

FloWorks 19.1.1 was an internal release which has not been released publicly.

FloWorks 19.1.0 (01 April 2019)

  • Added support for unconstrained flows.
  • All changes included in version 19.0.2.
  • Option "Unchanged" removed from "Set flow rate" triggers -- this is now considered as "Unconstrained". Use the "Set maximum input/output rate" option instead of "Set maximum rates" if you only want to change either the input or the output rate.
  • Bug fix: Removed old-style statistics from library, causing several issues like utilization resetting at model end time.
  • Bug fix: FloWorks flow bin items no longer show up in Create Person Process Flow activity (class type changed from Operator to Flow Task Executer).
  • Bug fix: Flow conveyor resume did not correctly close ports.
  • Bug fix: Flow conveyor could get negative content due to rounding error.
  • Bug fix: Flow conveyor stop, impact, resume did not stop content on conveyor when inflow and outflow were zero.
  • Bug fix: Fixed issue when stopping or starting conveyor during Product Change event.

FloWorks 19.0.8 (13 December 2019)

  • Bug fix: Tank level trigger could cause event list to become unsorted.
  • Bug fix: Max. Object Depth setting in FloWorks charts was ignored.

FloWorks 19.0.7 (18 October 2019)

  • Request: Added Waiting for Transport state to Loading Point.
  • Bug fix: Flow Content Histogram was broken.
  • Bug fix: Fixed rounding errors when inflow very close to outflow.
  • Bug fix: Fixed rounding error in tank top/bottom duration calculation.
  • Bug fix: Avoid duplicate event when recalculation requested before Flow Control resets.

FloWorks 19.0.6 (09 October 2019)

  • Bug fix: Restored objects missing from library and icon grid.

FloWorks 19.0.5 (26 September 2019)

  • Bug fix: Removed old-style statistics from library, causing several issues like utilization resetting at model end time.
  • Bug fix: FloWorks flow bin items no longer show up in Create Person Process Flow activity (class type changed from Operator to Flow Task Executer).
  • Bug fix: Flow conveyor resume did not correctly close ports.
  • Bug fix: Flow conveyor could get negative content due to rounding error.
  • Bug fix: Flow conveyor stop, impact, resume did not stop content on conveyor when inflow and outflow were zero.
  • Bug fix: Fixed issue when stopping or starting conveyor during Product Change event.

FloWorks 19.0.4 (19 July 2019)

  • Various bug fixes to the Mass Flow Conveyor.
  • Bug fix: Utiliation returns (flow rate)/(max flow rate) at time zero.
  • Bug fix: Solved exception when dragging different object shape into the model.

FloWorks 19.0.3 (30 April 2019)

  • Loading arm state will show Blocked and Starved instead of Idle while transporter is connected.
  • "Pass product downstream" option added to product change trigger of flow processors.
  • Bug fix: Transporters were sometimes positioned incorrectly when entering Loading Point.
  • Bug fix: Flow object states were not updated.
  • Bug fix: Fixed error when calling state() with no arguments.
  • Bug fix: On Entry and On Exit in trigger list of Flow To Item and Item To Flow fixed.
  • Bug fix: "Pass product downstream trigger" threw exception when connected to Flow To Item.

FloWorks 19.0.2 (01 April 2019)

  • Feature: Flow tank can scale in both directions (elliptical) instead of only using x-size for diameter.
  • Bug fix: Various bug fixes to beta version of new optimizer/solver.
  • Bug fix: Removed "content is larger than max. content" message during reset.
  • Bug fix: Fixed exception in "Pass product downstream" when pipe is not connected to anything.
  • Bug fix: Corrected normals on flow blender and flow splitter shapes.
  • Bug fix: FlowObject.input/output.ports[index] now accepts Variant (e.g. token.Port) as index and does bounds checking on index.
  • Bug fix: Spheres no longer drawn outside flow pipes shorter than 2 m.
  • Bug fix: Quick Properties only shows a single flow rate for flow pipes; output rate set to input rate on reset.

FloWorks 19.0.1 (08 March 2019)

  • FlowToItem and ItemToFlow added to script so that rates and impact factors can be read and set.
  • Added more shapes for Flow Tank and Mixer.
  • Added "Change product by case" to trigger options.
  • Bug fix: Flow conveyors now have state profile consistent with that of Flow Tank.
  • Bug fix: Product color picker samples colors instead of objects again.
  • Bug fix: Fixed incorrect layers being drawn during filling of Flow Mixer when multiple steps require input from the same port.
  • Bug fix: Fixed incorrect states on Loading Point due to duplicate state_current node.
  • Bug fix: Product field or dropdown will now preserve selected value instead of resetting to current product when switching property tab pages.
  • Bug fix: Flow Task Executer connects itself to default network navigator on creation.
  • Bug fix: Flow statistics now behave correctly under model warmup.
  • User manual: Corrected description of FlowObject.stop() in documentation.
  • User manual: Documented manual loading feature when Loading Points have 0 loading time.
  • Loading point continues with next transporter after releasing completed item instead of waiting for it to exit.

FloWorks 19.0.0 (27 February 2019)

  • Beta: Flow control can optimize network before solving. (Optimization is disabled by default, can be enabled for models with many (effective) single connections.)
  • Content-holding objects now have On Trigger Level event that allows e.g. Process Flow to wait for a specific level trigger.
  • Optimized event scheduling: obsolete events are removed from the event list instead of ignored.
  • Statistics are now kept in standard FlexSim tracked variables under the stats node. If you use dashboards, you may need to rebuild some charts. You can mostly use the standard FlexSim chart templates, listening to the On Rate Change event or the On Content Change Update (not Change).
  • Tank trigger levels rewritten:
    • Trigger levels are now specified using absolute level instead of percentage.
    • Legacy limitations (max. 20 levels, no duplicate levels, 0% or 100%) have been removed.
    • Separate trigger condition has been added to avoid coding (if(mode == falling) { ... }).
    • Modes rising and falling are now called MODE_RISING and MODE_FALLING.
    • Bug fix: Sometimes input and output triggers would not fire if trigger was reached precisely when flow was recalculated.
  • (Mass) flow conveyor now closes input/output when stopped, instead of input/output ports.
  • Bug fix: (Mass) flow conveyor only closed input when stopping; now closes both output and input.

FloWorks 18.2.1 (6 September 2018)

  • Chart templates keep their shared property on save (after reset / build).
  • "Duplicate MTBF/MTTR" also duplicates member list.
  • Fixed crash when opening product table.
  • Added FloWorks Compartments options back to Source's On Creation picklist.
  • Added missing ItemToFlow and FlowToItem triggers.
  • Fixed exception when starting / ending impact factor event in upgraded model.

FloWorks 18.2.0 (10 August 2018)

For FlexSim version 18.0.x use FloWorks 18.0.2. For FlexSim version 18.1.x use FloWorks 18.1.1.

  • All features and bug fixes in FloWorks 18.1.1.

In anticipation of some major changes to FloWorks 2019, this release of FloWorks does not include any new features or bug fixes.

FloWorks 18.1.1 (18 April 2018)

For FlexSim version 18.0.x use FloWorks 18.0.2.

  • Bug fix: "Change" field should be hidden on all Task Executers except Flow Task Execture.
  • Bug fix: Changing configuration of Flow Task Executer would cause strange behavior because the window was closed before all scripts had finished executing.
  • Bug fix: Some objects like Berth and Loading Arm no longer worked because code properties got untoggled.

FloWorks 18.1.0 (9 April 2018)

For FlexSim version 18.0.x use FloWorks 18.0.2.

  • Pumps, valves, blenders and splitters are now different shapes of the same "Flow Processor".
  • Truck loading points and Berths are now different shapes of the same "Loading Point".
  • Cylindrical tanks, rectangular tanks, tanks with polygon base area and flow piles are now different shapes of the same "Flow Tank".
  • Added button to flow tank to calculate physical size based on specified max. content.
  • Flow pipe has animation to help visualize if material is flowing and how fast.
  • Added post-step delay and trigger to multi-compartment loading controller steps.
  • Added Start Impact Event and End Impact Event triggers.
  • FloWorks chart templates have been added to the library.

FloWorks 18.0.2 (9 April 2018)

For FlexSim version 18.1.x use FloWorks 18.1.0.

  • Bug fix: Conveyor sometimes stops incorrectly.
  • Improvement: Objects try to avoid On State Change when state has not changed.

FloWorks 18.0.1 (22 December 2017)

For FlexSim version 18.1.x use FloWorks 18.1.0.

  • Bug fix: FloWorks broke double click in the Process Flow view to open the quick library.

FloWorks 18.0.0 (15 December 2017)

For FlexSim version 17.1.x use FloWorks 17.1.3.
For FlexSim version 17.0.x (LTS) use FloWorks 17.0.6.

  • Quick Properties panels added.
  • Added three FloWorks tutorials to user manual.
  • Added impact, stop and resume functions on FlowObject.
  • Added FLOW_STATE_* constants for use in stop and optionally impact.
  • Bug fix: In unlicensed version, license info is now correctly shown instead of “Unknown”.
  • All bug fixes in version 17.2.2 and 17.0.7.

FloWorks 17.2.2 (15 December 2017)

For FlexSim version 18.0.0 use FloWorks 18.0.0.
For FlexSim version 17.0.x (LTS) use FloWorks 17.0.7.

  • Bug fix: FlowTank's isEmpty and isFull return 0 and 1.
  • Bug fix: Statistics collectors pick up content changes by content property setter.
  • Bug fix: Cannot change mixer recipe while running.
  • All bug fixes in version 17.0.7.

FloWorks 17.2.1 (18 September 2017)

For FlexSim version 17.1.x use FloWorks 17.1.3.
For FlexSim version 17.0.x (LTS) use FloWorks 17.0.6.

  • Bug fix: Adding charts using "Pin" buttons would show error message.
  • Bug fix: Incorrect reference in Wait For Event activity in Mixer recipe schedule template for Process Flow; disabled Repeat Schedule by default.
  • Bug fix: FloWorks objects remove pending events from the list when they are destroyed.

FloWorks 17.2.0 (1 September 2017)

For FlexSim version 17.1.x use FloWorks 17.1.3.
For FlexSim version 17.0.x (LTS) use FloWorks 17.0.6.

  • Added FlowObject class interface ("dot syntax") for majority of FloWorks objects.
  • Can now access products by name when using FloWorks product table
    (e.g. source.product = "Raw material" instead of source.product = 3).
  • Can define recipes for products in the products table and dynamically load / execute them on Flow Mixers.
  • Added Process Flow templates for mixers executing production schedule and flow tank with cleaning / certification.
  • Updated Pin to Dashboard buttons to use Statistics Collectors to collect data.
  • Revised most of the user manual (tutorials are missing, will be re-released in a future version).
  • Bug fix: Calling SelectFlowIp and SelectFlowOp with multiple ports produced FlexSim error.
  • Bug fix: When using a product table, sometimes the Product dropdown would not show the correct product when opening Properties.
  • Bug fix: Flow Conveyor would not suspend correctly when output flow restricted.

FloWorks 17.1.3 (1 September 2017)

For FlexSim version 17.1.x use FloWorks 17.1.3.
For FlexSim version 17.0.x (LTS) use FloWorks 17.0.5.

  • Bug fix: Calling SelectFlowIp and SelectFlowOp with multiple ports produced FlexSim error.
  • Bug fix: When using a product table, sometimes the Product dropdown would not show the correct product when opening Properties.
  • Bug fix: Flow Conveyor and Mass Flow Conveyor can cause FlexSim to crash, when used in combination with a product table.
  • Bug fix: Flow Conveyor would not suspend correctly when output flow restricted.

FloWorks 17.1.0 (April 11, 2017)

This version of FloWorks supports FlexSim version 17.1.0.

  • Added a multi-compartment loading controller to allow multiple tanks on the same Task Executer to be loaded in sequence and/or in parallel.
  • Added the mass flow conveyor, an accumulating version of the Flow Conveyor.
  • Instead of using numeric product IDs, you can now pre-define a product table in your model, with fixed product names and colors. See the Products page for more information.
  • As of now, FloWorks license versions will need to be upgraded with every release, similarly to your FlexSim license.
    (Existing users will automatically be requested to upgrade their license using the Request Upgrade button in the FlexSim License Activation window.)
  • All bug fixes included in version 17.0.2, see below.

FloWorks 17.0.7 (15 December 2017)

For FlexSim version 18.0.0 use FloWorks 18.0.0.
For FlexSim version 17.2.x use FloWorks 17.2.2.

  • Bug fix: FloWorks objects remove pending events from the list when they are destroyed.
  • Bug fix: Fixed an issue in the LP solver.
  • Bug fix: Minor fix to internal treenode naming on reset.
  • Bug fix: Avoid a rounding issue in utilization calculation.
  • Bug fix: Mixer correctly resets visuals to empty in manual mode.
  • Bug fix: Can start mixer recipe from Reset or On Empty trigger.
  • Bug fix: Fixed reset error when opening model without flow trucks in a FlexSim installation without FloWorks.

FloWorks 17.0.6 (1 September 2017)

For FlexSim version 17.2.x use FloWorks 17.2.0.
For FlexSim version 17.1.x (LTS) use FloWorks 17.1.3.

  • Bug fix: Calling SelectFlowIp and SelectFlowOp with multiple ports produced FlexSim error.

FloWorks 17.1.2 and 17.0.5 (June 28, 2017)

For FlexSim version 17.1.x use FloWorks 17.1.2.
For FlexSim version 17.0.x (LTS) use FloWorks 17.0.5.

  • Bug fix: Fixed errors when loading FloWorks with other modules dependent on Process Flow, such as the Emulation module.

FloWorks 17.1.1 and 17.0.4 (May 25, 2017)

For FlexSim version 17.1.x use FloWorks 17.1.1.
For FlexSim version 17.0.x (LTS) use FloWorks 17.0.4.

  • Bug fix: Fixed exception when changing to first product of product table using scripting
  • Bug fix: Flow To Item releases item when pulling object downstream is unblocked
  • Bug fix: Flow To Item now uses item.Type labels instead of deprecated setitemtype.
  • Bug fix: Flow Conveyor with multiple inputs sometimes created too many update events.
  • Bug fix: Flow Conveyor now allows input port at end of conveyor.
  • Usability improvement: Pick list options updated to dot syntax, e.g.centerobject(current, 1) is now current.centerObjects[1].
  • Usability improvement: Changed object list dropdown to be more descriptive about input, output and center connections.
  • Usability improvement: Changed input/output amount trigger template to increase current input/output instead of previous trigger amount
  • Usability improvement: Added FloWorks options to User Event code dropdown.

FloWorks 17.0.2 (April 11, 2017)

This version of FloWorks supports all LTS releases of FlexSim 17 (FlexSim versions 17.0.x).

  • Bug fix: Code headers correctly use Object instead of treenode for current and item so pick list items like "Object connected to center port" work again.
  • Bug fix: Utilization no longer reported as -100% for object with maximum flow set to 0 on reset.
  • Bug fix: Flow control no longer breaks down indefinitely once run with one connected object.
  • Bug fix: Fixed exception when copy/pasting object with Flow Arrows enabled.
  • Bug fix: Added missing icons for options in FloWorks submenu of Toolbox.
  • Bug fix: Flow Conveyor now correctly detects changes in ratio of incoming components where total flow stays the same.
  • Bug fix: ChangeTeEdgeSpeed command no longer throws exception when used on Task Executer not attached to Travel Network.
  • Bug fix: Berth and loading point clear their contents on reset, like all Fixed Resources do.

FloWorks 17.0.1 (January 23, 2017)

  • Bug fix: Missing names and items in Flow Item Bin fixed.
  • Bug fix: Properties window for Flow Tank flow item now opens correctly.
  • Bug fix: Resolved some minor issues with "Add to dashboard" pins.

FloWorks 17.0.0 (December 22, 2016)

  • FloWorks updated for FlexSim 2017
  • Flow Mixer now has a manual mode, that will put it in Idle mode after each batch until you manually call StartMixerRecipe.
  • Allow Input Rate and Output Rate to be plotted versus time.
  • New Workability and Level Triggered Event objects added with focus in particular on modelling of ports and offshore processes.
  • Unfilled part of Flow Tank is no longer necessarily gray but takes the object color.
  • When Impact Events are active on a FloWorks object, they will show a box around the object similar to the "stopobject" behavior in standard FlexSim. The color of the box varies from red (0) through yellow to green (1) to black (infinity) depending on the impact factor of the event.
  • Dropdown lists for port actions improved. For example, you can now open or close a single port (OpenFlowIp c.s.), select an individual port to open, close input and open output, etc.
  • Increased limits on number of objects and events when running unlicensed version in FlexSim Educational version.
  • Bug fix: Can now add Object Groups to FloWorks charts.
  • Bug fix: When changing a Flow Task Executer from vessel to truck, the TE's flow tank is correctly scaled and positioned on reset.
  • Bug fix: The State display in the Quick Properties did not correctly show the state of the Loading Arm.
  • Bug fix: Arrow heads can now be dragged by holding 'X' key instead of Alt.
  • User commands consolidated and documentation updated:
    • ConnectFlowObjectToOtherObject command rewritten and documented.
    • All documentation in modules\FloWorks\help\Commands reformatted and automatically generated based on actual user commands. These help pages often provide more explanation on the parameters and their optional values, the return types, and more extensive examples than the FlexSim Command Helper pages.
  • Integration with the Process Flow module:
    • FloWorks options added to "Listener Initialized" trigger of "Wait for event" action.
    • Dropdown lists for port actions improved. For example, you can now open or close a single port (OpenFlowIp c.s.), select an individual port to open, close input and open output, etc.
  • The Item To Flow's OnItemEmptied trigger is now fired before the actual item is destroyed, so that you are still able to reference it in the trigger code.

FloWorks 16.2.0 (August 25, 2016)

  • FloWorks updated for FlexSim 16.2.0.
  • Flow Utilization added (GetFlowUtilization command, charts)
  • OnInput and OnOutput trigger added to Pipe Triggers.
  • Pipe Out product event can be used in Process Flow.
  • Bug fix: Arrows don't work on Flow Mixer.
  • Bug fix: FloWorks "pin to chart" broke that functionality non-FloWorks objects
  • Bug fix: Model exhibited undefined behavior when balanced flow is zero for all ports.
  • Bug fix: Pipe's On Product In trigger fired incorrectly on Outflow Product change

FloWorks 16.1.1 (July 14, 2016)

  • Bug fix: Sometimes flow rates would be set to zero when clicking Apply
  • Bug fix: Sometimes "Outflow rule" dropdown would become empty for pumps.
  • Bug fix: SetFlowMaxContent would sometimes misbehave in OnReset triggers.

FloWorks 16.1.0 (June 23, 2016)

  • FloWorks now supports Process Flow! FloWorks triggers can be selected in Wait For Event and Event Triggered Source activities. New "FloWorks action" activity was added to the library.
  • Fixed an issue with setting maximum flow rates through interface and SetFlowRatesMaximum
  • Flow Content-Time diagram now supports more statistics than just content. Actual flow rates are also shown in Quick Properties.
  • FloWorks options in Trigger Fields are now grouped into submenus
  • Berths now position first ship at the front of the berth, so vessels dock front-to-back instead of back-to-front.
  • Fixed Shared Resource capacity field disappearing on click.
  • Visualization of cylindrical mixer is fixed.
  • Allow Item To Flow to produce 0 flow for a flow item. "Different time for Nth item" option in triggers was broken and removed.
  • Fixed a bug where Loading Arm would sometimes not detect end of loading (target tank full) event correctly.

FloWorks 16.0.1 (April 25, 2016)

  • Allow changing of histogram title and number of bins during run, added axis titles
  • Fixed issues with "Flow Control" dropdown of all objects, including new "Not connected" option/
  • Fixed issues with Shared Resource member list.
  • Changes to user interface: made tooltips, code editors and GUI layout more consistent.
  • Fixed bug with Input or Output Amount Trigger sometimes not firing.
  • Allow center port connections between all objects (e.g. loading arm and loading point) in both directions.
  • SetNewFluidRates is now deprecated and replaced by SetFlowRatesMaximum.

FloWorks 16.0.0 (April 13, 2016)

  • Fixed some issues with statistics and quick properties panels
  • Added Flow Histogram chart
  • Fixed bug with timing of transporters travelling to berths