ReportMagic

[Toggl.ClientList:]

Obtains one or more properties of all Toggl Clients.

Compatibility

The macro can be used in all input document types and in Report Studio.

Usage

Admins can set a default Workspace ID in the Toggl Connection (Configuration section), instead of specifying the 'workspaceId' parameter in the macro (which when set takes precedence), like this: { "DefaultWorkspaceId" : 1234567 }. See the Connecting to Toggl help for more details.

Updates

2 years ago · May 2024

BREAKING CHANGES: available properties have changed with the move to Toggl API v9, and the macro now always provides object output.

Parameters (33)

Grouped View

Mandatory (1)

Parameter	Type	Purpose	Options	Default
properties	List<String>	The property or properties to obtain, each separated by a semi-colon e.g. properties=id;propertyA;propertyB.	All AllAsJObject AllAsJson CreatorId DeletedAt Id IsArchived LastModified Name permissions TotalCount WorkspaceId	N/A

Behaviour (11)

Parameter	Type	Presence	Purpose	Options	Default
calculate	String	Optional	Post processing formula. Use {value} for the macro output, e.g. {value}/1024.	N/A	N/A
desiredExecutionResult	List<ExecutionResult>	Optional	If specified, asserts the expected execution result of the macro. Accepts a single value or a semicolon-separated list of acceptable values (e.g. 'Success;Warning'). The macro executes normally; if the actual result matches any of the desired values, the result is converted to Success. If the actual result does not match, the result is converted to MacroError with a descriptive message. This is primarily used for testing and diagnostic purposes. Valid values are: 'Unknown', 'Success', 'MacroError', 'WorkerStopped', 'Running', 'Warning', 'NeverRun', 'Cancelled', 'Pending', 'Paused', 'SystemError', 'Deferred' and 'Stopped'.	Cancelled Deferred MacroError NeverRun Paused Pending Running Stopped Success SystemError Warning WorkerStopped	N/A
errorOnOverflow	Boolean	Optional	Should NCalc expression evaluation throw error on Overflow	true false	true
expectedType	String	Optional	If specified, asserts the expected output type of the macro result. The macro executes normally; if the actual type does not match, a macro error is generated. Requires 'storeAs', 'storeAsHidden', or 'storeFormattedValueAs' to be set for typed validation. Valid types include CLR names (e.g. Int32, Int64, Single, Double, Boolean, String, JArray, JObject) and C# keyword aliases (e.g. int, long, float, double, bool, string, uint, ulong, short, ushort, byte, sbyte, decimal, char, object). The special value 'Number' matches any numeric type.	N/A	N/A
expectedValue	String	Optional	If specified, asserts the expected output value of the macro result. The macro executes normally; if the actual value does not match, a macro error is generated. When 'storeAs' or 'storeAsHidden' is set, the stored variable value is compared. Otherwise, the document output text is compared.	N/A	N/A
hidden	Boolean	Optional	Whether to hide the macro output.	true false	false
if	String	Optional	The condition that must be true in order for the macro to be executed/evaluated. Must either evaluate to true or false, for example: "3+5=8" or "contains('abcd', 'z').	N/A	true
mode	MacroMode	Optional	The mode in which variables are stored. In the legacy mode (default for Schedules), the variable created is a string and formatted. In the normal mode (default for Report Studio), the output variable is stored as a strongly-typed theObject, e.g. an Int32 or a List etc., rather than a formatted string.	Legacy Normal	Legacy
obfuscation	ObfuscationType	Optional	Obfuscation type. Use obfuscation to write reports where sensitive data is hidden. When used, ReportMagic guarantees that the same input string will map to the same output string for the whole of the report (but the next time the report runs, it will most likely map to a different value). If you use obfuscation, the property in your macro will not show up and instead, you will see a fake item of the obfuscation type chosen.	None UkTown DeviceName Company IpAddress PrivateIpAddress	None
redact	Boolean	Optional	Whether substituted variables are hidden from macro results (and the word 'REDACTED' will appear in progress screens and elsewhere in the web UI).	true false	false
warning	String	Optional	If specified, adds a warning message for this macro. This is processed as an NCalc, and the warning message will ALWAYS be present and will be the value of the evaluated NCalc expression.	N/A	N/A

Colours (3)

Parameter	Type	Presence	Purpose	Options	Default
colorTableCell	Boolean	Optional	Whether to color table cells if thresholds are breached, rather than color the text.	true false	true
fontBackgroundColor	Color	Optional	The font background color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A
fontColor	Color	Optional	The font color to use.	A named color or an HTML-encoded color .Note that 'transparent' is a valid color that you can use in any macro parameter that expects a color.	N/A

Formatting (3)

Parameter	Type	Presence	Purpose	Options	Default
fontBold	Boolean	Optional	Change the font weight (true=strong, false=normal). If omitted, no change is made.	true false	N/A
fontSize	Double	Optional	Change the font size in points. If omitted, no change is made.	From 2 to 200	N/A
format	String	Optional	The formatting to use for numbers. You can also specify 'format=string' to force numbers to be treated as strings.	N/A	N/A

Output (7)

Parameter	Type	Presence	Purpose	Options	Default
failureText	String	Optional	The text to display should the macro fail to execute. Note that a poorly-specified macro (e.g. omitting mandatory parameters) will still result in an error message.	N/A	N/A
failureVariable	String	Optional	The name of a variable to create should the macro fail to execute. The variable will be a text variable, and will contain either the failure text (only if the failureText parameter is set), otherwise it will contain the exception / failure message.	N/A	N/A
outputListsAsJarray Normal mode	Boolean	Optional	Any macros that output lists can optionally (in Normal mode) output a jArray instead.	true false	true
storeAs	String	Optional	The variable to store the result as.	N/A	N/A
storeAsHidden	String	Optional	The variable to store the result as, while hiding the output. Equivalent to 'storeAs=ThisValue, hidden=true'.	N/A	N/A
storeAsVariableDelimiter	Char	Optional	The delimiter used by storeAs to split the input (Legacy mode only), when there are multiple stored variables. For example, in this macro, we indicate that the value to be stored should be split by the asterisk when being stored: [String:value=abcd, storeAs=var1;var2;var3;var4, storeAsVariableDelimiter=]	N/A	;
storeFormattedValueAs	String	Optional	The name of the STRING variable to store the result as and output (both will use the same format) into the report. Note that if you also use 'storeAsHidden' in the same macro, you should not expect the output to be hidden, as this parameter overrides that.	N/A	N/A

General (5)2 additional

Parameter	Type	Presence	Purpose	Options	Default
properties	List<String>	Mandatory	The property or properties to obtain, each separated by a semi-colon e.g. properties=id;propertyA;propertyB.	All AllAsJObject AllAsJson CreatorId DeletedAt Id IsArchived LastModified Name permissions TotalCount WorkspaceId	N/A
workspaceId	Int64	Conditional	This can be set in 1) the macro or 2) in a macro default (by an Admin) or 3) in the Toggl Connection's Configuration section (by an Admin), in that order of precedence.	N/A	0
clientStatus	ClientStatus	Optional	The Client status.	Both Active Archived	Both
connectionName	String	Optional	The name of the Toggl Connection.	N/A	N/A
nameContains	String	Optional	Include Clients where the name contains this value, or don't set this parameter to ignore the filter.	N/A	N/A

Additional (2)

Parameter	Type	Presence	Purpose	Options	Default
comment	String	Optional	Add a comment to make your document template more readable. The comment is discarded in the output document.	N/A	N/A
singleValueList Normal mode	Boolean	Optional	In Normal Mode and for macros that output JArrays only, whether to convert a JArray of single-property jObjects into a flat JArray of values.	true false	false

Deprecated (2)

Parameter	Type	Preferred Parameter	Purpose	Options	Default
property	List<String>	properties	The property or properties to obtain, each separated by a semi-colon e.g. properties=id;propertyA;propertyB.	All AllAsJObject AllAsJson CreatorId DeletedAt Id IsArchived LastModified Name permissions TotalCount WorkspaceId	N/A
id	Int64	workspaceId	This can be set in 1) the macro or 2) in a macro default (by an Admin) or 3) in the Toggl Connection's Configuration section (by an Admin), in that order of precedence.	N/A	0

Examples (2)

Example 1

This example obtains all the Toggl Client IDs and stores them as a JObject in a variable called ClientIds:

[Toggl.WorkspaceList: properties=Id;Name;Created, storeAs=MyWorkspaces][Json.List: jArray=`{MyWorkspaces}`, jsonPath="$.[0].Id", storeAs=FirstWorkspace][Toggl.ClientList: workspaceId={FirstWorkspace}, properties=Id, storeAs=ClientIdObjects]

Example 2Normal mode

This example obtains several properties and stores them as a JArray called ClientIdObjects. It then uses the [Json.Item:] macro to obtain the 'Id' property of the first item only (as indicated by jsonPath=`$[0].Id`):

[Toggl.WorkspaceList: properties=Id;Name;Created, storeAs=MyWorkspaces][Json.List: jArray=`{MyWorkspaces}`, jsonPath="$.[0].Id", storeAs=FirstWorkspace][Toggl.ClientList: workspaceId={FirstWorkspace}, properties=Id;Name;IsArchived, mode=Normal, =>PropertyObjects][Json.Item:value={=PropertyObjects}, jsonPath=`$[0].Id`, storeAs=FirstClientId]

Compatibility

Usage

Updates

Examples (2)

Example 1

Example 2Normal mode

Search

Reconnection

Reconnection

Reconnection