In this module we’ll present what we consider to be Best Practices in working with Designer - your FLO-building interface. Above all, if you follow a few simple guidelines you can Stay Organized and Keep your FLOs (Human) Readable and easy to work with.


Course Material


In this module we’ll present what we consider to be Best Practices in working with Designer - your FLO-building interface. Above all, if you follow a few simple guidelines you can Stay Organized and Keep your FLOs (Human) Readable and easy to work with.

Overview

In this module we’ll present what we consider to be Best Practices in working with Designer - your FLO-building interface.

Above all, if you follow a few simple guidelines you can Stay Organized and Keep your FLOs (Human) Readable and easy to work with.

Naming Your FLOs - Organization

In the world of software development, naming conventions are often critical. Why? Primarily because it helps with efficiency … if you can easily make sense of what you’re working with (like filenames and code) you can focus on getting work done. In our case, this means creating great FLOs.

Let’s jump into the product and review some Best Practices …

Best Practices

Ultimately you want to be able to look at a name and know exactly what a FLO is doing. You can affect this in many ways such as:

  • Use prefixes to “group” FLOs together
  • Use numbers to help with sorting
  • Make FLO names descriptive enough to help with filtering

By using these techniques you can easily:

  • Maintain sort order
  • Enhance readability (e.g. I can “grok” what a FLO does at a glance)
  • Provide for versioning (if you preserve previous FLOs)
  • Utility/Helper FLOs

Also note that in the Card View you have additional means to sort your FLOs. You can toggle Card View by clicking the icon that looks like four squares (see image below).

Naming Your FLOs - Child / Utility FLOs

Child FLOs: FLOs which are used by other FLOs

Utility FLOs: A helper FLO which may be very generic and used by other FLOs

Some Tips:

Place Child/Utility FLOs in a seperate folder if there are many. This helps to aggregate groups of related FLOs in an easy-to-find manner.

Naming Child FLOs is often even more important than the parents. Why? Because it’s so easy to forget the parent FLO, thus it’s a good idea to use techniques such as:

  • Name Child FLOs that have clear parents
  • Leverage a prefix (such as “SubFLO”) if a flow is used by many other FLOs
  • Good descriptions can help document where a particular FLO is being called from

Naming Fields and Outputs

Veteran FLOGrammers will discover some lesser known features that also significantly enhance readability. Renaming fields and outputs are key in helping here!

Naming Fields

Each field within a Card may be renamed. Clicking the Type icon adjacent to the field name, then clicking “Customize” will grant you access to customize your field.

You can also add Help Text here which can further enhance understanding.

Naming Outputs

Similar to this you may customize / change names of Output fields.

This is particularly helpful in making sure you leverage the correct field.

Naming Cards

Also a lesser-known tip is that you can rename a card!

To do so, as you would with fields, - Click the gear icon at the bottom right of the card - Select the “Edit Card” option - You’ll be given the option to rename the card and even add a description!

Folders

Additionally one can leverage Folders to group collections of related FLOs.

Generally, using good naming conventions for your FLOs is better.

Folders, however, are helpful in a couple key ways:

1) If you know there are FLOs in a shared environment which you don’t want others to use (testing FLOs for example)

2) If you know you will need to export/import FLO packs, keeping all FLOs within the same Folder is a great practices so that all child FLO hookups stay intact.

The Notes Card (formerly the Compose Card)

As the product evolves we offer more capabilities for internal documentation. At the time of the video recording we found FLOGrammers leveraging a Compose card for in-FLO notes. This trick is no longer required with the inclusion of the Notes card.

You can simply add a Notes card via the “Add Note” option in Designer:3

Adding a Notes card does not contribute to run-time processing and can provide for a simple way to add quick notes about a FLO.

Benefits include:

  • A reminder (for you and others) of what is happening in FLO
    • This is really beneficial for when you’re building a FLO and have to stop
    • You can document what you were doing and be able to quickly pick up when you return!
  • To-do reminders
    • e.g. “change the folder ID before moving this from sandbox -> production”

Summary

With these Best Practices you should have a good idea on how Stay Organized and Keep FLOs (Human) Readable.