Page Comparison

...

commentsexcludeRelatedexportReleaseLevelexportTablefirstDayOfWeek

Valid values:

nameopswiseGroups

List of Business Services:

XML

JSON

retainSysIds

Specification for whether or not the Create a Calendar web service will persist the sysId property.

Property

UI Field Name

Description

Specifications

Required

Anchor

	businessDays - CC
	businessDays - CC

businessDays

Business Days

Comma-separated list of days.

Valid values:

Html bobswift
<ul> <li> Sunday <li> Monday <li> Tuesday <li> Wednesday <li> Thursday <li> Friday <li> Saturday </ul>

Optional: useDefaultIfBlank attribute. Boolean; Valid values: true/false.

The Read a Calendar web service will return useDefaultIfBlank only if businessDays is empty; useDefaultIfBlank will be set to false.

N

Anchor

comments - CC

Description

User-defined; description for the calendar.

N

Anchor

excludeRelated - CC

n/a

Specification for whether or not to exclude related records (Custom Days, Local Custom Days) from an update, even if they are provided in the request.

Valid values: true/false (default is false).

N

Anchor

exportReleaseLevel - CC

n/a

Universal Controller release that the record was exported from.

read only

N

Anchor

exportTable - CC exportTable - CC n/a Record table information. read only N

Anchor

firstDayOfWeek - CC

First Day Of Week

Day that is considered the start of the week.

N

Anchor

name - CC

Name

Name used within the Controller to identify this calendar.

Maximum 40 alphanumerics.

Y

Anchor

opswiseGroups - CC

Member of Business Services

Panel

N

Anchor

retainSysIds - CC

n/a

Note

title	Note

In XML web services, retainSysIds is specified as an attribute in the <calendar> element.

Valid values: true/false (default is true).

N

AnchorsysId - CCsysId - CCsysId

n/a

System ID field in the database for this Calendar record.

Persisted only if retainSysIds is set to true.

N

firstQuarterStart

1st Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.

XML

    <firstQuarterStart>
        <day>15</day>
        <month>01</month>
    </firstQuarterStart>

JSON

    "firstQuarterStart": {
        "day": "15",
        "month": "Jan"
    }

Valid values:

month:
- integer value between 1-12
- string value 3 letter month
  - Jan
  - Feb
  - Mar
  - Apr
  - May
  - Jun
  - Jul
  - Aug
  - Sep
  - Oct
  - Nov
  - Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

secondQuarterStart

2nd Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.

XML

    <secondQuarterStart>
        <day>14</day>
        <month>Apr</month>
    </secondQuarterStart>

JSON

   "secondQuarterStart": {
        "day": "14",
        "month": "Apr"
    }

Valid values:

month:
- integer value between 1-12
- string value 3 letter month
  - Jan
  - Feb
  - Mar
  - Apr
  - May
  - Jun
  - Jul
  - Aug
  - Sep
  - Oct
  - Nov
  - Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

thirdQuarterStart

3rd Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.

XML

    <thirdQuarterStart>
        <day>16</day>
        <month>Jul</month>
    </thirdQuarterStart>

JSON

   "thirdQuarterStart": {
        "day": "16",
        "month": "Jul"
    }

Valid values:

month:
- integer value between 1-12
- string value 3 letter month
  - Jan
  - Feb
  - Mar
  - Apr
  - May
  - Jun
  - Jul
  - Aug
  - Sep
  - Oct
  - Nov
  - Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

fourthQuarterStart

4th

Html bobswift

<ul>
<li> If <code>businessDays</code> is blank or is not specified in the Request, <code>businessDays</code> defaults to Monday,Tuesday,Wednesday,Thursday,Friday. To disable this behavior, set <b>useDefaultIfBlank</b> to false. That is, to set <code>businessDays</code> to blank when a calendar contains "Business Day" Custom Day(s), specify: <code>&lt;businessDays useDefaultIfBlank="false"&gt;&lt;/businessDays&gt;</code>. 
<li> If <code>businessDays</code> is blank and the <b>useDefaultIfBlank</b> attribute is not included in the Request (<code>&lt;businessDays /&gt;</code>), <code>businessDays</code> defaults to Monday,Tuesday,Wednesday,Thursday,Friday.
<li> If <code>businessDays</code> is not blank, <b>useDefaultIfBlank</b> is ignored.
<li> If <b>useDefaultIfBlank</b> is set to true (<code>&lt;businessDays useDefaultIfBlank="true"&gt;&lt;/businessDays&gt;</code>), <code>businessDays</code> defaults to Monday,Tuesday,Wednesday,Thursday,Friday.
<li> If <b>useDefaultIfBlank</b> is set to false (<code>&lt;businessDays useDefaultIfBlank="false"&gt;&lt;/businessDays&gt;</code>), business days are not set.
</ul>

The Read a Calendar web service will return useDefaultIfBlank only if businessDays is empty; useDefaultIfBlank will be set to false.

N

Anchor

	comments - CC
	comments - CC

comments

Description

User-defined; description for the calendar.

N

Anchor

	excludeRelated - CC
	excludeRelated - CC

excludeRelated

n/a

Specification for whether or not to exclude related records (Custom Days, Local Custom Days) from an update, even if they are provided in the request.

Valid values: true/false (default is false).

N

Anchor

	exportReleaseLevel - CC
	exportReleaseLevel - CC

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor

	exportTable - CC
	exportTable - CC

exportTable

n/aRecord table information.read onlyN

Anchor

	firstDayOfWeek - CC
	firstDayOfWeek - CC

firstDayOfWeek

First Day Of Week

Day that is considered the start of the week.

Valid values:

Html bobswift
<ul> <li> Sunday <li> Monday <li> Tuesday <li> Wednesday <li> Thursday <li> Friday <li> Saturday </ul>

N

Anchor

	name - CC
	name - CC

name

Name

Name used within the Controller to identify this calendar.

Maximum 40 alphanumerics.

Y

Anchor

	opswiseGroups - CC
	opswiseGroups - CC

opswiseGroups

Member of Business Services

List of Business Services:

XML

Panel

Html bobswift
<pre> <opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups> </pre>

JSON

Panel

Html bobswift
<pre> "opswiseGroups": [ "test" ] </pre>

N

Anchor

	retainSysIds - CC
	retainSysIds - CC

retainSysIds

n/a

Specification for whether or not the Create a Calendar web service will persist the sysId property.

Html bobswift

<ul>
<li> If <b>retainSysIds</b>="true" and <code>sysId</code> is included in the request/response, <code>sysId</code> will be persisted to the database.
<li> If <b>retainSysIds</b>="false" and  <code>sysId</code> is included in the request/response, <code>sysId</code> will be ignored; it will be autogenerated by the Controller. 
</ul>

Note

title	Note

In XML web services, retainSysIds is specified as an attribute in the <calendar> element.

Valid values: true/false (default is true).

N

Anchor

	sysId - CC
	sysId - CC

sysId

n/a

System ID field in the database for this Calendar record.

Persisted only if retainSysIds is set to true.

N

firstQuarterStart

1st Quarter Start

To specify the start of the 1st Quarter, a day and month must be specified as shown below.

XML

    <fourthQuarterStart><firstQuarterStart>
        <day>13<<day>15</day>
        <month>10<<month>01</month>
    </fourthQuarterStart>firstQuarterStart>

JSON

    "fourthQuarterStartfirstQuarterStart": {
        "day": "1315",
        "month": "OctJan"
    }

Valid values:

month:
- integer value between 1-12
- string value 3 letter month
  - Jan
  - Feb
  - Mar
  - Apr
  - May
  - Jun
  - Jul
  - Aug
  - Sep
  - Oct
  - Nov
  - Dec
The day must also be valid for the given month. For example, Feb 30 is not allowed.

If any other Quarter is specified then this property is also required.

...

Property

...

UI Field Name

...

Description

...

Specifications

...

Required

...

Name

...

Name used within the Controller to identify this Custom Day.

...

Maximum 40 alphanumerics.

...

Y

...

n/a

...

sysId of the Calendar-to-Custom Day relationship.

...

N

...

adjustment

Valid values:

Default is None (0).

adjustmentAmountadjustmentType

Valid values:

Default is Day (1).

category

Valid values:

Default is Day (1).

commentsctype

Valid values:

Default is Single Date (0).

datedateList

XML

JSON

daydayofweek

Valid values:

Default is Mon (2).

month

Valid values:

Default is Jan (0).

nameobservedRules

If category is Holiday (3) and ctype is Relative Repeating Date (1) or Absolute Repeating Date (2); Rules for when the holiday will be observed.

XML

JSON

relfreqValid values:

Property	UI Field Name	Description	Specifications	Required	Mutually Exclusive With
Anchor
adjustment - LCD	adjustment - LCD	Adjustment	If `ctype` is Relative Repeating Date (1); Adjustment for the repeating date.	N
Anchor
adjustmentAmount - LCD	adjustmentAmount - LCD	Adjustment Amount	If `adjustment` is Less (1) or Plus (2); Amount (number of days) of the adjustment to be made.	Default is 1.	N
Anchor
adjustmentType - LCD	adjustmentType - LCD	Adjustment Type	If `adjustment` is Less (1) or Plus (2); Type of day on which to make the adjustment.	N
Anchor
category - LCD	category - LCD	Category	Category of this Local Custom Day.	N
Anchor
comments - LCD	comments - LCD	Description	Description of this Local Custom Day.	N
Anchor
ctype - LCD	ctype - LCD	Type	Type of this Local Custom Day.	N
Anchor
date - LCD	date - LCD	Date	Specific date for this Local Custom Day	Format: yyyy-mm-dd.	Y (if `ctype` = Single Date. )	`datelist`
Anchor
dateList - LCD	dateList - LCD	Dates	Multiple specific dates for this Local Custom Day.
Panel
Panel
Y (if `ctype` is List of Dates.)	`date`
Anchor
day - LCD	day - LCD	Day	Day of the month.	Integer; Valid values: 1-31.	Y (if `ctype` is Absolute Repeating Date)
Anchor
dayofweek - LCD	dayofweek - LCD	Day Of Week	Day of the week.	Y (if `ctype` is Relative Repeating Date)
Anchor
month - LCD	month - LCD	Month	Month of the year.	Y (if `ctype` is Relative Repeating Date or Absolute Repeating Date)
Anchor
name - LCD	name - LCD	Name	Name of this Local Custom Day.	Y
Anchor
observedRules - LCD	observedRules - LCD	Observed Rules
Panel
Panel
Valid day of week values: Sun, Mon, Tue, Wed, Thu, Fri, Sat	N
Anchor
relfreq - LCD	relfreq - LCD	When	Occurrence of this day in the month.	secondQuarterStart	2nd Quarter Start	To specify the start of the 1st Quarter, a day and month must be specified as shown below. XML `<secondQuarterStart> <day>14</day> <month>Apr</month> </secondQuarterStart>` JSON `"secondQuarterStart": { "day": "14", "month": "Apr" }`	Valid values: month: integer value between 1-12 string value 3 letter month Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec The day must also be valid for the given month. For example, Feb 30 is not allowed.	If any other Quarter is specified then this property is also required.
thirdQuarterStart	3rd Quarter Start	To specify the start of the 1st Quarter, a day and month must be specified as shown below. XML `<thirdQuarterStart> <day>16</day> <month>Jul</month> </thirdQuarterStart>` JSON `"thirdQuarterStart": { "day": "16", "month": "Jul" }`	Valid values: month: integer value between 1-12 string value 3 letter month Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec The day must also be valid for the given month. For example, Feb 30 is not allowed.	If any other Quarter is specified then this property is also required.
fourthQuarterStart	4th Quarter Start	To specify the start of the 1st Quarter, a day and month must be specified as shown below. XML `<fourthQuarterStart> <day>13</day> <month>10</month> </fourthQuarterStart>` JSON `"fourthQuarterStart": { "day": "13", "month": "Oct" }`	Valid values: month: integer value between 1-12 string value 3 letter month Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec The day must also be valid for the given month. For example, Feb 30 is not allowed.	If any other Quarter is specified then this property is also required.

Anchor
Create a Calendar Custom Day Properties
Create a Calendar Custom Day Properties
Create a Calendar: Custom Day Properties

Property

UI Field Name

Description

Specifications

Required

Anchor

	name - CCD
	name - CCD

name

Name

Name used within the Controller to identify this Custom Day.

Maximum 40 alphanumerics.

Y

Anchor

	sysId - CCD
	sysId - CCD

sysId

n/a

sysId of the Calendar-to-Custom Day relationship.

N

Anchor
Create a Calendar Local Custom Day Properties
Create a Calendar Local Custom Day Properties
Create a Calendar: Local Custom Day Properties

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor

	adjustment - LCD
	adjustment - LCD

adjustment

Adjustment

If ctype is Relative Repeating Date (1); Adjustment for the repeating date.

Valid values:

Html bobswift
<ul> <li> As String = None, As Value = 0 <li> As String = Less, As Value = 1 <li> As String = Plus, As Value = 2 </ul>

Default is None (0).

N

Anchor

	adjustmentAmount - LCD
	adjustmentAmount - LCD

adjustmentAmount

Adjustment Amount

If adjustment is Less (1) or Plus (2); Amount (number of days) of the adjustment to be made.

Default is 1.

N

Anchor

	adjustmentType - LCD
	adjustmentType - LCD

adjustmentType

Adjustment Type

If adjustment is Less (1) or Plus (2); Type of day on which to make the adjustment.

Valid values:

Html bobswift
<ul> <li> As String = Day, As Value = 1 <li> As String = Business Day, As Value = 2 </ul>

Default is Day (1).

N

Anchor

	category - LCD
	category - LCD

category

Category

Category of this Local Custom Day.

Valid values:

Html bobswift
<ul> <li> As String = Day, As Value = 1 <li> As String = Business Day, As Value = 2 <li> As String = Holiday, As Value = 3 <li> As String = Period, As Value = 4 </ul>

Default is Day (1).

N

Anchor

	comments - LCD
	comments - LCD

comments

Description

Description of this Local Custom Day.

N

Anchor

	ctype - LCD
	ctype - LCD

ctype

Type

Type of this Local Custom Day.

Valid values:

Html bobswift

<ul>
<li> As String = Single Date, As Value = 0
<li> As String = Relative Repeating Date, As Value = 1
<li> As String = Absolute Repeating Date, As Value = 2
<li> As String = List of Dates, As Value = 3
</ul>

Default is Single Date (0).

N

Anchor

	date - LCD
	date - LCD

date

Date

Specific date for this Local Custom Day

Format: yyyy-mm-dd.

Y
(if ctype =
Single Date. )

datelist

Anchor

	dateList - LCD
	dateList - LCD

dateList

Dates

Multiple specific dates for this Local Custom Day.

XML

Panel

Html bobswift
<pre> <dateList> <date>2017-12-13</date> <date>2017-12-14</date> </dateList> </pre>

JSON

Panel

Html bobswift
<pre> "dateList": [ "2017-12-13", "2017-12-14" ], </pre>

Y
(if ctype
is List of Dates.)

date

Anchor

	day - LCD
	day - LCD

day

Day

Day of the month.

Integer; Valid values: 1-31.

Y
(if ctype
is Absolute Repeating Date)

Anchor

	dayofweek - LCD
	dayofweek - LCD

dayofweek

Day Of Week

Day of the week.

Valid values:

Html bobswift

<ul>
<li> As String = Sun, As Value = 1
<li> As String = Mon, As Value = 2
<li> As String = Tue, As Value = 3
<li> As String = Wed, As Value = 4
<li> As String = Thu, As Value = 5
<li> As String = Fri, As Value = 6
<li> As String = Sat, As Value = 7
</ul>

Default is Mon (2).

Y
(if ctype
is Relative Repeating Date)

Anchor

	month - LCD
	month - LCD

month

Month

Month of the year.

Valid values:

Html bobswift

<ul>
<li> As String = Jan, As Value = 0
<li> As String = Feb, As Value = 1
<li> As String = Mar, As Value = 2
<li> As String = Apr, As Value = 3
<li> As String = May, As Value = 4
<li> As String = Jun, As Value = 5
<li> As String = Jul, As Value = 6
<li> As String = Aug, As Value = 7
<li> As String = Sep, As Value = 8
<li> As String = Oct, As Value = 9
<li> As String = Nov, As Value = 10
<li> As String = Dec, As Value = 11
<li> As String = ALL, As Value = 12
</ul>

Default is Jan (0).

Y
(if ctype is
Relative Repeating Date
or
Absolute Repeating Date)

Anchor

	name - LCD
	name - LCD

name

Name

Name of this Local Custom Day.

Y

Anchor

	observedRules - LCD
	observedRules - LCD

observedRules

Observed Rules

If category is Holiday (3) and ctype is Relative Repeating Date (1) or Absolute Repeating Date (2); Rules for when the holiday will be observed.

XML

Panel

Html bobswift

<pre>
&lt;observedRules&gt; 
      &lt;observedRule&gt;            
            &lt;actualDayOfWeek&gt;Sat&lt;/actualDayOfWeek&gt;           
            &lt;observedDayOfWeek&gt;Fri&lt;/observedDayOfWeek&gt; 
      &lt;/observedRule&gt; 
      &lt;observedRule&gt;                    
            &lt;actualDayOfWeek&gt;Sun&lt;/actualDayOfWeek&gt;               
            &lt;observedDayOfWeek&gt;Mon&lt;/observedDayOfWeek&gt; 
      &lt;/observedRule&gt; 
&lt;/observedRules&gt; 
</pre>

JSON

Panel

Html bobswift
<pre> "observedRules" : [ { "actualDayOfWeek" : "Sat", "observedDayOfWeek" : "Fri" }, { "actualDayOfWeek" : "Sun", "observedDayOfWeek" : "Mon" } ] </pre>

Valid day of week values:

Sun, Mon, Tue, Wed, Thu, Fri, Sat

N

Anchor

	relfreq - LCD
	relfreq - LCD

relfreq

When

Occurrence of this day in the month.

Valid values:

Html bobswift

<ul>
<li> As String = 1st, As Value = 1
<li> As String = 2nd, As Value = 2
<li> As String = 3rd, As Value = 3
<li> As String = 4th, As Value = 4
<li> As String = Last, As Value = 5
<li> As String = Every, As Value = 6
</ul>

Default is 1st (1).

Y
(if ctype
is Relative Repeating Date)

Anchor

	sysId - LCD
	sysId - LCD

sysId

n/a

System ID in the database for this Local Custom Day.

Persisted only if retainSysIds is set to true.

Y
(if retainSysIds
is true.)

...

Versions Compared

Old Version 11

New Version 12

Key

Anchor
Create a Calendar Custom Day Properties
Create a Calendar Custom Day Properties
Create a Calendar: Custom Day Properties

Anchor
Create a Calendar Local Custom Day Properties
Create a Calendar Local Custom Day Properties
Create a Calendar: Local Custom Day Properties

Page Comparison

Versions Compared

Old Version 11

New Version 12

Key

AnchorCreate a Calendar Custom Day PropertiesCreate a Calendar Custom Day PropertiesCreate a Calendar: Custom Day Properties

AnchorCreate a Calendar Local Custom Day PropertiesCreate a Calendar Local Custom Day PropertiesCreate a Calendar: Local Custom Day Properties

Anchor
Create a Calendar Custom Day Properties
Create a Calendar Custom Day Properties
Create a Calendar: Custom Day Properties

Anchor
Create a Calendar Local Custom Day Properties
Create a Calendar Local Custom Day Properties
Create a Calendar: Local Custom Day Properties