Skip to main content

Introduction

Last updated 6/06/2025

Options and server options enable you to add a key: value pair to add extra settings and configurations. A key: value pair consists of two linked data elements: a key (a unique identifier) and a value (the associated data). This structure enables efficient data storage and retrieval.

Five has custom key: value pairs that you can use for an instance, these will automatically be available when entered into the Options or Server Options fields. You can add your own key: value pairs, to retrieve the values you would use

five.getOption()
for the values stored in the Options field and
five.getOptionServer()
for values in the Server Options field.

Five's Options

Key: value pairs entered into the Options field can be retrieved from the frontend or the backend. The following internal options are available:

KeyValue
AUTO_SCREEN_LOCKContains the number of minutes till the screen is locked from inactivity
AUTO_LOGOFFContains the number of minutes till the user is automatically logged out of the system due to inactivity

Five's Server Options

Key: value pairs entered into the Server Options field can only be retrieved from the backend. The following are required internal server options when using phone authentication with OTP (One Time Password):

KeyValue
TWILIO_SIDContains your Account SID from Twilio
TWILIO_AUTHContains your Auth Token from Twilio
TWILIO_FROMContains your allocated phone number from Twilio
TWILIO_FORMATOptional: A sed expression to format the phone number when sending SMS messages using Twilio