Documentation Index

Fetch the complete documentation index at: https://docs.lobstersoftware.com/llms.txt

Use this file to discover all available pages before exploring further.

un/suspend profile()

Prev Next

This function suspends a Profile or lifts an existing suspension. It returns true on success.

NOTE:  Suspended profiles are listed in Control Center under Exceptions.

Return value

Value

Meaning

true

Action completed successfully.

false

Action failed. Parameter b is true, so no error is raised in the calling profile.

Parameters

Parameter

Required

Default

Description

a

Yes

–

Name or ID of the profile to be suspended or unsuspended.

b

No

false

When true, errors are ignored. The calling profile remains error-free. The function returns false in this case. Example: the profile specified in a was not found.

c

No

false

When true, the profile is suspended. When false, an existing suspension is lifted.

d

No

–

Start date (type: Date) of the scheduled suspension. The suspension starts at 00:00 on the specified date. Only takes effect when c = true.

e

No

–

End date (type: Date) of the scheduled suspension. The suspension ends at 00:00 on the specified date. Only takes effect when c = true.

Notes

  • Only profiles on the same Client can be handled.

  • A profile can suspend itself.

  • When a running profile is suspended, the system sets the status immediately. The current profile run still completes normally.

  • When d and e are set and c = true, the profile appears in Control Center under Exceptions as Already scheduled for suspension.

  • Parameters d and e correspond to the time frame of manual timed suspension. See Profile suspensions.

  • Scheduled suspension via parameters d and e is available from version 25.0.7.

IMPORTANT:

Known limitation: Parameters d and e currently support dates only, not timestamps. The suspension runs from 00:00 on the start date to 00:00 on the end date. Shorter time windows (for example, 30 minutes or 2 hours) are not possible.

Related articles