View source for DES/Current/Designer/BusinessHrs

{{Article
|Standalone=No
|DisplayName=Business Hours Block
|TocName=Business Hours Block
|Context=Use the Business Hours block to inform customers that your business is closed.
|ComingSoon=No
|Platform=GenesysEngage-cloud
|Role=Administrator
|Application=Designer
|Section={{Section
|alignment=Vertical
|structuredtext=You can use the '''Business Hours''' block in the '''Initialize''', '''Self Service''', or '''Assisted Service''' phase to inform customers that your business is closed. You can also choose to end the interaction at this point.

{{NoteFormat|The hours that you define in the '''Business Hours''' block are based on the application's time zone setting. To set the application time zone, select the '''Initialize''' phase and open the '''System Variables''' tab. Click the drop-down menu in the '''Timezone''' row and select a value. You can override the default time zone setting by selecting a variable in the '''Set Timezone''' section of the '''Business Hours''' tab.|2}}
|Status=No
}}{{Section
|sectionHeading=Business Hours tab
|anchor=BusinessHourstab
|alignment=Vertical
|structuredtext=To set your business hours, select each '''Day''' you are open and specify the '''Start Time''' and '''End Time''' for each day. 

====Open All Day====
Select if your business is open for that entire day. 

====No End Time====
Select if there is no set end time for the given day (this option only appears if the business is not closed for that day and the '''Open All Day''' option is not enabled).

====Terminate the call if it is outside Business Hours====
Select to end calls that come in outside of business hours.

====Use Business Hours defined in Business Controls====
If you prefer to use a specific shared business hours resource that you've defined on the {{Link-SomewhereInThisManual|topic=BusinessObjectsBar|anchor=top|display text=Business Controls}} page, enable this option and select it from the list of defined business hours resources. 

Alternatively, you can specify a variable to be used dynamically while the application runs. Select '''Variable?''' to specify a user-defined variable that holds the name of a Business Hours resource. If this resource will be read from a data table, you must also select '''From Data Table?''' to indicate that the variable holds the result of a data table lookup. Otherwise, the result will not be evaluated correctly.

{{NoteFormat|
* If the Business Hours are being determined dynamically at runtime, you can't mix user-defined variables (for example, <tt>varDepartmentName + “_PrimaryHours"</tt>) with variables retrieved from data table lookups. Make sure you check the appropriate box to indicate the type of variable being used. 
* No matter which method you use, the name stored in the variable must match one of the Business Hour objects you created on the {{Link-SomewhereInThisManual|topic=BusinessObjectsBar|anchor=top|display text=Business Controls}} page.}}

====Timezone Override====
Select a variable that will override the time zone setting for the application.

=====Example 1=====
[[File:des_bh_business_hours.PNG]]

=====Example 2=====
[[file:des_businesshours_bushours_1b.png]]
|Status=No
}}{{Section
|sectionHeading=Closed Messages tab
|anchor=ClosedMessagestab
|alignment=Vertical
|structuredtext=In the '''Closed Messages''' tab, you can select the messages to play or send to customers when your business is closed. If your application is a Default application type, you can specify the prompts to play for voice or chat customers. For Digital application types, you can select an acknowledgement message from the {{Link-SomewhereInThisVersion|manual=Designer|topic=DigitalResourcesBar|display text=Digital Resources Collection}} that will be emailed to customers. 

{{NoteFormat|See the {{Link-SomewhereInThisManual|topic=PlayMessage|anchor=top|display text=Play Message block page}} for information on how to use prompts.|2}}

[[File:des_businesshours_closed.png]]
|Status=No
}}{{Section
|sectionHeading=Results tab
|anchor=Resultstab
|alignment=Vertical
|structuredtext=You can assign a variable to the '''Set the result of Block operation status in this variable''' property to store the result of the block operation check. If specified, the variable is assigned the Boolean value of '''true''' or '''false''', to indicate if the block operation completed without errors.

You can assign a variable to the '''Store the result of Business hours check in this variable''' property if you need to use the result of the check later in application. If specified, the variable is assigned the Boolean value of '''true''' or '''false'''.

You can assign a variable to the '''Store the number of minutes before the business is opened''' to track how long until the business is open, if it is currently closed. If the business is open, this variable is set to 0. The maximum value returned is the number of minutes until the end of week (Sunday to Saturday). (This feature is supported only for Business Hours defined in Business Controls.)

You can assign a variable to the '''Store the number of minutes before the business is closed''' to track how long until the business is closed, if it is currently open. If the business is closed, this variable is set to 0. (This feature is supported only for Business Hours defined in Business Controls.)

You can assign a variable to the '''Store the business hours schedule in this variable''' property if you need to read the business hours schedule later in the application. If specified, the variable is assigned a JSON object. The JSON object structure is:

<source lang="text">
{
    "days": [
        {"name": "Sunday","closed": true,"range": [{"starttime": "","endtime": ""}]},
        {"name": "Monday","closed": false,"range": [{"starttime": "1000","endtime": "1800"}]},
        {"name": "Tuesday","closed": false,"range": [{"starttime": "1000","endtime": "1800"}]},
        {"name": "Wednesday","closed": false,"range": [{"starttime": "1000","endtime": "1800"}]},
        {"name": "Thursday","closed": false,"range": [{"starttime": "1000","endtime": "1800"}]},
        {"name": "Friday","closed": false,"range": [{"starttime": "1000","endtime": "1800"}]},
        {"name": "Saturday","closed": false,"range": [{"starttime": "1100","endtime": "1700"}]}
    ]
}
</source>

This JSON object can be used in expressions for the '''Assign Variables''' block and prompt values for the '''Play Message''' block.
|Status=No
}}{{Section
|sectionHeading=Using Business Hour Values in Prompts
|anchor=UsingBusinessHourValuesinPrompts
|alignment=Vertical
|structuredtext=You can also use the '''Business Hours''' block to announce business hours in prompts. For example, you could use an {{Link-SomewhereInThisVersion|manual=Designer|topic=AssignVar|display text=Assign Variables}} block to assign the following variables:

[[File:des_bh_assign_variables.PNG]]

Then, set up the prompt to announce the '''End Time''' value for Wednesday:

*In the {{Link-SomewhereInThisVersion|manual=Designer|topic=PlayMessage|display text=Play Message}} block, click '''Add Prompt'''.
*Choose '''TTS''' as the '''Type'''.
*Enable the '''Var?''' checkbox, and select '''var_endtime''' as the '''Value'''.

[[File:des_bh_prompt_variables.PNG]]

{{NoteFormat|The <tt>days[n]</tt> range is from from <tt>0</tt> to <tt>6</tt>, with <tt>0</tt> representing Sunday and <tt>6</tt> representing Saturday.}}
|Status=No
}}{{Section
|sectionHeading=Scenarios
|anchor=Scenarios
|alignment=Vertical
|structuredtext=If you want to:

===Specify that the business is closed after 4 PM on Thursdays===

*Set the '''End Time''' value on Thursday to 4:00 PM

===Play a message if a customer calls after business hours, and then end the call===

*On the '''Business Hours''' tab, enable the '''Terminate the call if it is outside Business Hours''' checkbox.
*On the '''Closed Messages''' tab, create a prompt.

===Specify business hours for a different timezone than the one the application is running in===

*In the '''Intialize''' phase, assign a value to the '''timezone''' variable (remember that string values must be surrounded by single quotes — for example, 'UTC').
*On the '''Business Hours''' tab, select the '''timezone''' variable from the '''Set Timezone''' section.

===Specify business hours where the '''Start Time''' is later than the '''End Time'''=== 
If you try to specify these types of business hours in the usual way, Designer displays an error ("Start time should be earlier than end time"). We'll use a business that is open from 6:00 PM to 9:00 AM as an example of how you can set this up.

*Create two sets of business hours. For the first set of business hours (primary), set the '''Start Time''' as 6:00 PM for the days you are open (e.g. Monday to Friday). For each open day, select the '''No End Time''' check box, as we've done here for our primary business hours called JC_BH_1:

[[File:des_business_hours_ex01.png]]

*For the secondary set, specify 12:00 AM as the '''Start Time''' and 9:00 AM as the '''End Time''' for Tuesday through Saturday, as we've done here for our secondary set of business hours called JC_BH_2:

[[File:des_business_hours_ex02.png]]

*Set up your application to first check the primary set of business hours. If the business is closed, have it then check the secondary set. If both sets of business hours are closed, the business is considered to be closed. Otherwise, the business is considered to be open between the desired hours of 6:00 PM to 9:00 AM.
|Status=No
}}
}}