Skip to content

Commit 2365578

Browse files
author
Muhammad Waqar
committed
Adding documentation for holiday feature of auto attendants in Preview form.
1 parent 27ed069 commit 2365578

8 files changed

+570
-83
lines changed

‎skype/skype-ps/skype/Export-CsOrganizationalAutoAttendantHolidays.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
---
2+
external help file: Export-CsOrganizationalAutoAttendantHolidays.xml
3+
applicable: Skype for Business Online
4+
title: Export-CsOrganizationalAutoAttendantHolidays
5+
schema: 2.0.0
6+
---
7+
8+
# Export-CsOrganizationalAutoAttendantHolidays
9+
10+
## SYNOPSIS
11+
Use Export-CsOrganizationalAutoAttendantHolidays cmdlet to export holiday schedules of an existing organizational auto attendant (OAA). The data is exported as a byte array from the cmdlet, which can be dumped to disk as a CSV file and can later be imported using the Import-CsOrganizationalAutoAttendantHolidays cmdlet.
12+
13+
## SYNTAX
14+
15+
```
16+
Export-CsOrganizationalAutoAttendantHolidays [-PrimaryUri] <Uri> [-Tenant <Guid>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
The Export-CsOrganizationalAutoAttendantHolidays cmdlet and the Import-CsOrganizationalAutoAttendantHolidays cmdlet enable you to export holiday schedules in your organizational auto attendant and then later import that information. This can be extremely useful in a situation where you need to configure same holiday sets in multiple organizational auto attendants.
21+
22+
The Export-CsOrganizationalAutoAttendantHolidays cmdlet returns the holiday schedule information in serialized form (as a byte array). The caller can then write the bytes to the disk to obtain a CSV file. Similarly, the Import-CsOrganizationalAutoAttendantHolidays cmdlet accepts the holiday schedule information as a byte array, which can be read from the aforementioned CSV file. The first line of the CSV file is considered a header record and is always ignored.
23+
24+
**NOTE**
25+
- **The Holiday feature of auto attendants is currently available to PREVIEW customers only.**
26+
- Each line in the CSV file used by Export-CsOrganizationalAutoAttendantHolidays and Import-CsOrganizationalAutoAttendantHolidays cmdlet should be of the following format:
27+
28+
`HolidayName,StartDateTime1,EndDateTime1,StartDateTime2,EndDateTime2,…,StartDateTime10,EndDateTime10`
29+
30+
where
31+
- HolidayName is the name of the holiday to be imported.
32+
- StartDateTimeX and EndDateTimeX specify a date/time range for the holiday and are optional. If no date-time ranges are defined, then the holiday is imported without any date/time ranges. They follow the same format as New-CsOnlineDateTimeRange cmdlet.
33+
- EndDateTimeX is optional. If it is not specified, the end bound of the date time range is set to 00:00 of the day after the start date.
34+
- The first line of the CSV file is considered a header record and is always ignored by Import-CsOrganizationalAutoAttendantHolidays cmdlet.
35+
- If the destination organizational auto attendant for the import already contains a call flow or schedule by the same name as one of the holidays being imported, the corresponding CSV record is skipped.
36+
- For holidays that are successfully imported, a default call flow is created which is configured without any greeting and simply disconnects the call on being executed.
37+
38+
## EXAMPLES
39+
40+
### -------------------------- Example 1 --------------------------
41+
```
42+
$bytes = Export-CsOrganizationalAutoAttendantHolidays -PrimaryUri sip:mainoaa@contoso.com
43+
[System.IO.File]::WriteAllBytes("C:\Exports\Holidays.csv", $bytes)
44+
```
45+
46+
In this example, the Export-CsOrganizationalAutoAttendantHolidays cmdlet is used to export holiday schedules of an organizational auto attendant with Primary URI of sip:mainoaa@contoso.com. The exported bytes are then written to a file with the path "C:\Exports\Holidays.csv".
47+
48+
## PARAMETERS
49+
50+
### -PrimaryUri
51+
The Primary URI represents the SIP address of the organizational auto attendant whose holiday schedules are to be exported.
52+
53+
```yaml
54+
Type: System.Uri
55+
Parameter Sets: (All)
56+
Aliases:
57+
Applicable: Skype for Business Online
58+
59+
Required: True
60+
Position: 1
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -Tenant
67+
68+
```yaml
69+
Type: System.Guid
70+
Parameter Sets: (All)
71+
Aliases:
72+
Applicable: Skype for Business Online
73+
74+
Required: False
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### CommonParameters
82+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
83+
84+
85+
## INPUTS
86+
87+
### String
88+
The String is used as the PrimaryUri input.
89+
90+
91+
## OUTPUTS
92+
93+
### System.Byte[]
94+
95+
96+
## NOTES
97+
98+
99+
## RELATED LINKS
100+
101+
[Import-CsOrganizationalAutoAttendantHolidays](Import-CsOrganizationalAutoAttendantHolidays.md)
102+
103+
[Get-CsOrganizationalAutoAttendantHolidays](Get-CsOrganizationalAutoAttendantHolidays.md)

‎skype/skype-ps/skype/Get-CsOrganizationalAutoAttendantHolidays.md

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
---
2+
external help file: Get-CsOrganizationalAutoAttendantHolidays.xml
3+
applicable: Skype for Business Online
4+
title: Get-CsOrganizationalAutoAttendantHolidays
5+
schema: 2.0.0
6+
---
7+
8+
# Get-CsOrganizationalAutoAttendantHolidays
9+
10+
## SYNOPSIS
11+
Use Get-CsOrganizationalAutoAttendantHolidays cmdlet to get the holiday information for an existing Organizational Auto Attendant (OAA).
12+
13+
## SYNTAX
14+
15+
```
16+
Get-CsOrganizationalAutoAttendantHolidays [-PrimaryUri] <Uri> [-Years <List>] [-Names <List>] [-Tenant <Guid>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
The Get-CsOrganizationalAutoAttendantHolidays provides a convenient way to visualize the information of all the holidays contained within an organizational auto attendant.
21+
22+
**NOTE**
23+
- **The Holiday feature of auto attendants is currently available to PREVIEW customers only.**
24+
25+
## EXAMPLES
26+
27+
### -------------------------- Example 1 --------------------------
28+
```
29+
Get-CsOrganizationalAutoAttendantHolidays -PrimaryUri "sip:mainoaa@contoso.com"
30+
```
31+
32+
In this example, the Get-CsOrganizationalAutoAttendantHolidays cmdlet is used to get all holidays in an organizational auto attendant with Primary URI of sip:mainoaa@contoso.com.
33+
34+
### -------------------------- Example 2 --------------------------
35+
```
36+
Get-CsOrganizationalAutoAttendantHolidays -PrimaryUri "sip:mainoaa@contoso.com" -Years @(2017)
37+
```
38+
39+
In this example, the Get-CsOrganizationalAutoAttendantHolidays cmdlet is used to get all holidays in year 2017 in an organizational auto attendant with Primary URI of sip:mainoaa@contoso.com.
40+
41+
### -------------------------- Example 3 --------------------------
42+
```
43+
Get-CsOrganizationalAutoAttendantHolidays -PrimaryUri "sip:mainoaa@contoso.com" –Years @(2017) -Name @("Christmas")
44+
```
45+
46+
In this example, the Get-CsOrganizationalAutoAttendantHolidays cmdlet is used to get holiday named Christmas in the year 2017 in an organizational auto attendant with Primary URI of sip:mainoaa@contoso.com.
47+
48+
### -------------------------- Example 4 --------------------------
49+
```
50+
Get-CsOrganizationalAutoAttendantHolidays -PrimaryUri "sip:mainoaa@contoso.com" | Format-Table -Wrap -AutoSize
51+
```
52+
53+
In this example, the Get-CsOrganizationalAutoAttendantHolidays cmdlet is used to retrieve all holidays in an organizational auto attendant with Primary URI of sip:mainoaa@contoso.com and the result is formatted as a table.
54+
55+
56+
## PARAMETERS
57+
58+
### -PrimaryUri
59+
The PrimaryUri parameter represents the SIP address of the organizational auto attendant whose holidays are to be retrieved.
60+
61+
```yaml
62+
Type: System.Uri
63+
Parameter Sets: (All)
64+
Aliases:
65+
Applicable: Skype for Business Online
66+
67+
Required: True
68+
Position: 1
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### -Years
75+
The Years parameter represents the years for the holidays to be retrieved. If this parameter is not specified, then holidays for all years in the OAA are returned.
76+
77+
```yaml
78+
Type: System.Collections.Generic.List
79+
Parameter Sets: (All)
80+
Aliases:
81+
Applicable: Skype for Business Online
82+
83+
Required: False
84+
Position: Named
85+
Default value: None
86+
Accept pipeline input: False
87+
Accept wildcard characters: False
88+
```
89+
90+
### -Names
91+
The Names parameter represents the names for the holidays to be retrieved. If this parameter is not specified, then all holidays in the OAA are returned.
92+
93+
```yaml
94+
Type: System.Collections.Generic.List
95+
Parameter Sets: (All)
96+
Aliases:
97+
Applicable: Skype for Business Online
98+
99+
Required: False
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
106+
### -Tenant
107+
108+
```yaml
109+
Type: System.Guid
110+
Parameter Sets: (All)
111+
Aliases:
112+
Applicable: Skype for Business Online
113+
114+
Required: False
115+
Position: Named
116+
Default value: None
117+
Accept pipeline input: False
118+
Accept wildcard characters: False
119+
```
120+
121+
### CommonParameters
122+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
123+
124+
125+
## INPUTS
126+
127+
### String
128+
The String is used as the PrimaryUri input.
129+
130+
131+
## OUTPUTS
132+
133+
### Microsoft.Rtc.Management.OAA.Models.HolidayVisRecord
134+
135+
136+
## NOTES
137+
138+
139+
## RELATED LINKS
140+
141+
[Import-CsOrganizationalAutoAttendantHolidays](Import-CsOrganizationalAutoAttendantHolidays.md)
142+
143+
[Export-CsOrganizationalAutoAttendantHolidays](Export-CsOrganizationalAutoAttendantHolidays.md)

‎skype/skype-ps/skype/Import-CsOrganizationalAutoAttendantHolidays.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
---
2+
external help file: Import-CsOrganizationalAutoAttendantHolidays.xml
3+
applicable: Skype for Business Online
4+
title: Import-CsOrganizationalAutoAttendantHolidays
5+
schema: 2.0.0
6+
---
7+
8+
# Import-CsOrganizationalAutoAttendantHolidays
9+
10+
## SYNOPSIS
11+
Use Import-CsOrganizationalAutoAttendantHolidays cmdlet to import holiday schedules of an existing organizational auto attendant (OAA) that were previously exported using the Export-CsOrganizationalAutoAttendantHolidays cmdlet.
12+
13+
## SYNTAX
14+
15+
```
16+
Import-CsOrganizationalAutoAttendantHolidays [-PrimaryUri] <Uri> -Input <byte[]> [-Tenant <Guid>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
The Export-CsOrganizationalAutoAttendantHolidays cmdlet and the Import-CsOrganizationalAutoAttendantHolidays cmdlet enable you to export holiday schedules in your organizational auto attendant and then later import that information. This can be extremely useful in a situation where you need to configure same holiday sets in multiple organizational auto attendants.
21+
22+
The Export-CsOrganizationalAutoAttendantHolidays cmdlet returns the holiday schedule information in serialized form (as a byte array). The caller can then write the bytes to the disk to obtain a CSV file. Similarly, the Import-CsOrganizationalAutoAttendantHolidays cmdlet accepts the holiday schedule information as a byte array, which can be read from the aforementioned CSV file. The first line of the CSV file is considered a header record and is always ignored.
23+
24+
**NOTE**
25+
- **The Holiday feature of auto attendants is currently available to PREVIEW customers only.**
26+
- Each line in the CSV file used by Export-CsOrganizationalAutoAttendantHolidays and Import-CsOrganizationalAutoAttendantHolidays cmdlet should be of the following format:
27+
28+
`HolidayName,StartDateTime1,EndDateTime1,StartDateTime2,EndDateTime2,…,StartDateTime10,EndDateTime10`
29+
30+
where
31+
- HolidayName is the name of the holiday to be imported.
32+
- StartDateTimeX and EndDateTimeX specify a date/time range for the holiday and are optional. If no date-time ranges are defined, then the holiday is imported without any date/time ranges. They follow the same format as New-CsOnlineDateTimeRange cmdlet.
33+
- EndDateTimeX is optional. If it is not specified, the end bound of the date time range is set to 00:00 of the day after the start date.
34+
- The first line of the CSV file is considered a header record and is always ignored by Import-CsOrganizationalAutoAttendantHolidays cmdlet.
35+
- If the destination organizational auto attendant for the import already contains a call flow or schedule by the same name as one of the holidays being imported, the corresponding CSV record is skipped.
36+
- For holidays that are successfully imported, a default call flow is created which is configured without any greeting and simply disconnects the call on being executed.
37+
38+
## EXAMPLES
39+
40+
### -------------------------- Example 1 --------------------------
41+
```
42+
$bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv")
43+
Import-CsOrganizationalAutoAttendantHolidays -PrimaryUri sip:mainoaa@contoso.com -Input $bytes
44+
```
45+
46+
In this example, the Import-CsOrganizationalAutoAttendantHolidays cmdlet is used to import holiday schedule information from a file at path “C:\Imports\Holidays.csv” to an organizational auto attendant with Primary URI of sip:mainoaa@contoso.com.
47+
48+
### -------------------------- Example 2 --------------------------
49+
```
50+
$bytes = [System.IO.File]::ReadAllBytes("C:\Imports\Holidays.csv")
51+
Import-CsOrganizationalAutoAttendantHolidays -PrimaryUri sip:mainoaa@contoso.com -Input $bytes | Format-Table -Wrap -AutoSize
52+
```
53+
54+
In this example, the Import-CsOrganizationalAutoAttendantHolidays cmdlet is used to import holiday schedule information from a file at path “C:\Imports\Holidays.csv” to an organizational auto attendant with Primary URI of sip:mainoaa@contoso.com. The result of the import process is formatted as a table.
55+
56+
## PARAMETERS
57+
58+
### -PrimaryUri
59+
The Primary URI represents the SIP address of the organizational auto attendant in where the holiday schedule information is to be imported.
60+
61+
```yaml
62+
Type: System.Uri
63+
Parameter Sets: (All)
64+
Aliases:
65+
Applicable: Skype for Business Online
66+
67+
Required: True
68+
Position: 1
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### -Input
75+
The Input parameter specifies the holiday schedule information that is to be imported.
76+
77+
```yaml
78+
Type: System.Byte[]
79+
Parameter Sets: (All)
80+
Aliases:
81+
Applicable: Skype for Business Online
82+
83+
Required: True
84+
Position: Named
85+
Default value: None
86+
Accept pipeline input: False
87+
Accept wildcard characters: False
88+
```
89+
90+
### -Tenant
91+
92+
```yaml
93+
Type: System.Guid
94+
Parameter Sets: (All)
95+
Aliases:
96+
Applicable: Skype for Business Online
97+
98+
Required: False
99+
Position: Named
100+
Default value: None
101+
Accept pipeline input: False
102+
Accept wildcard characters: False
103+
```
104+
105+
### CommonParameters
106+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
107+
108+
109+
## INPUTS
110+
111+
### String
112+
The String is used as the PrimaryUri input.
113+
114+
115+
## OUTPUTS
116+
117+
### Microsoft.Rtc.Management.Hosted.OAA.Models.HolidayImportResult
118+
119+
120+
## NOTES
121+
122+
123+
## RELATED LINKS
124+
125+
[Export-CsOrganizationalAutoAttendantHolidays](Export-CsOrganizationalAutoAttendantHolidays.md)
126+
127+
[Get-CsOrganizationalAutoAttendantHolidays](Get-CsOrganizationalAutoAttendantHolidays.md)

0 commit comments

Comments
 (0)