Say what a type and its properties mean
Every type and property has a short meaning in plain words, the meaning of each value it can hold, and an example. Agents read all of it before they work on an object, and the code editor shows it as help. Clear meanings are the biggest single thing you can do to make actions work well.
You need Manage types and links. Ask your Flowstate admin.
Why meanings matter
An agent sees a HubSpot deal property called dealstage holding appointmentscheduled. It can guess. With a meaning it doesn’t have to:
- What it means: “Where the deal is in our sales process.”
- What
appointmentscheduledmeans: “We’ve booked a first call. Nothing is agreed yet, so there’s no Work to link.” - An example:
contractsent
Write the way you’d explain it to someone on their first day. Say what the property is for, not just what it is, and call out anything that would surprise a newcomer. Keep each one to a sentence or two.
Say what a type means
- Open the type on the Types tab.
- Open the menu beside Add property and select Edit what this type means.
- Write What it is and An example. For a type from an app or from files, you can also change its Name.
- Select Save.
You can’t change what Flowstate’s own types mean, apart from Advanced Resourcing profile types.
Say what a property means
- Open the type and select the property on its Properties tab.
- Write What it means.
- For a choice, write what each value means. Stored as is the value itself, and beside it, what it means.
- Write An example of a real value.
- Select Save.
You can write the meaning of any property except Flowstate’s own. A property that comes from an app keeps the app’s name and kind.
Add a property
Add a property when every object of a type should hold something extra, like whether a person is free for new work. Actions can change properties you add, so this is also how you give an action somewhere to write its answer.
- Open the type and select Add property.
- Give it a Name, such as “Bench status”.
- Choose its Kind.
- Write What it means: “Whether the person is on client work now, or free to take some.”
- For a choice, add each value with Add value. For example,
on_clientmeans “On client work: billable now” andbenchedmeans “Free for new work: not on any client engagement”. - Write An example, such as
benched. - Select Save.
What you can add depends on the type.
| Type | Kinds you can add |
|---|---|
| Work, People and Teams | Text, Number, Date, Choice and Currency |
| A type from an app or from files | Every kind except Link and File |
| Team assignments, Work assignments and profile types | None |
A property you add to Work, People or Teams is also a custom attribute, so it shows wherever custom attributes do in Flowstate. Its name and kind are changed in Settings → Resourcing → Custom Attributes, and its meaning here. It takes a moment to appear: the meaning is saved when it does.
A Currency or Text property on Work is also a Work value: it can be picked under Display on the Work list. See Show Work values in the Work list.
If something’s not right
“A custom attribute is already called Bench status”. Names are shared with custom attributes. Choose another name.
“The meaning of Bench status wasn’t saved”. The property took too long to appear. Open it and write the meaning again.
“This type has as many properties as it can have”. Talk to your Flowstate account manager.