Skip to main content

Module reference - Blackout for BHOM

 

Parameter

Description

Default/typical value

BlackoutConvertionSlotsMap

Contains the association between the “object” blackout fields (Object Class, Object, Parameter) and the name of those fields in Helix.

Expressed as a JSON string, for example :

{'ObjectClass':'instancename','Object':'location','Parameter':'modelname'}

i Use single-quotes to delimit the slotnames and values in the JSON string.

 

CalendarModuleName

Name of the Helix Calendar module to use

HelixCalendar

ConfirmDestroy

Option to confirm or not blackout removal

1 : Ask for reason on blackout delete

0 : No question while deleting period

CommentaireDefault

Default comment

No comment

CommentMinSize

Comment min size

5: At least 5 characters need in order to have a valid comment

DefaultDuration

Default duration for date based creation blackouts (seconds)

600

InfraType

Name of the BHOM infrastructure to address. The name should correspond to a valid section in the Global configuration

HELIX