Versions Compared

Old Version 7

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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:


  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday

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 - CCcomments - CC

Description

User-defined; description for the calendar.

N

Anchor
excludeRelated - CCexcludeRelated - 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 - CCexportReleaseLevel - CCn/a

Universal Controller release that the record was exported from.

read onlyN
Anchor
exportTable - CCexportTable - CCn/aRecord table information.read onlyN
Anchor
firstDayOfWeek - CCfirstDayOfWeek - CC

First Day Of Week

Day that is considered the start of the week.

N

Anchor
name - CCname - CC

Name

Name used within the Controller to identify this calendar.

Maximum 40 alphanumerics.

Y

Anchor
opswiseGroups - CCopswiseGroups - CC

Member of Business Services

Panel
Panel

N

Anchor
retainSysIds - CCretainSysIds - CC

n/a

Note
titleNote

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
  • If businessDays is blank or is not specified in the Request, businessDays defaults to Monday,Tuesday,Wednesday,Thursday,Friday. To disable this behavior, set useDefaultIfBlank to false. That is, to set businessDays to blank when a calendar contains "Business Day" Custom Day(s), specify: <businessDays useDefaultIfBlank="false"></businessDays>.
  • If businessDays is blank and the useDefaultIfBlank attribute is not included in the Request (<businessDays />), businessDaysdefaults to Monday,Tuesday,Wednesday,Thursday,Friday.
  • If businessDays is not blank, useDefaultIfBlank is ignored.
  • If useDefaultIfBlank is set to true (<businessDays useDefaultIfBlank="true"></businessDays>), businessDaysdefaults to Monday,Tuesday,Wednesday,Thursday,Friday.
  • If useDefaultIfBlank is set to false (<businessDays useDefaultIfBlank="false"></businessDays>), business days are not set.

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:

  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday

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
<opswiseGroups>
	<opswiseGroup>test</opswiseGroup>
</opswiseGroups>


 
JSON


Panel
"opswiseGroups": [
"test"
]



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.



  • If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.


  • If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.



Note
titleNote

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

    <secondQuarterStart><firstQuarterStart>
        <day>14<<day>15</day>
        <month>Apr<<month>01</month>
    </secondQuarterStart>
firstQuarterStart>

 JSON

    "secondQuarterStartfirstQuarterStart": {
        "day": "1415",
        "month": "AprJan"
    }

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.

thirdQuarterStartsecondQuarterStart

3rd 2nd Quarter Start

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

    <thirdQuarterStart><secondQuarterStart>
        <day>16<<day>14</day>
        <month>Jul<<month>Apr</month>
    </thirdQuarterStart>secondQuarterStart>

 JSON

   "thirdQuarterStartsecondQuarterStart": {
        "day": "1614",
        "month": "JulApr"
    }

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.

fourthQuarterStartthirdQuarterStart

4th 3rd Quarter Start

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

    <fourthQuarterStart><thirdQuarterStart>
        <day>13<<day>16</day>
        <month>10<<month>Jul</month>
    </fourthQuarterStart>thirdQuarterStart>

 JSON

    "fourthQuarterStartthirdQuarterStart": {
        "day": "1316",
        "month": "OctJul"
    }

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.

...

namesysIdN

Property

UI Field Name

Description

Specifications

Required

Anchor
name - CCDname - CCD

Name

Name used within the Controller to identify this Custom Day.

Maximum 40 alphanumerics.

Y

Anchor
sysId - CCDsysId - CCD

n/a

sysId of the Calendar-to-Custom Day relationship.

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

Valid values:

Default is None (0).

adjustmentAmountadjustmentType

Property

UI Field Name

Description

Specifications

RequiredMutually Exclusive With

Anchor
adjustment name - LCDCCDadjustment
name - LCDCCD
adjustmentname

Adjustment

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

N

Anchor
adjustmentAmount - LCDadjustmentAmount - 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 - LCDadjustmentType - LCD

Adjustment Type

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

Valid values:

Default is Day (1

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:

  • As String = None, As Value = 0
  • As String = Less, As Value = 1
  • As String = Plus, As Value = 2

Default is None (0).

N


Anchor

category

adjustmentAmount - LCD

category

adjustmentAmount - LCD

category

Valid values:

Default is Day (1)

adjustmentAmount

Category

Category of this Local Custom Day.

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

comments

adjustmentType - LCD

comments

adjustmentType - LCD

commentsDescription of this Local Custom Day

adjustmentType

Description

Adjustment Type

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

Valid values:

  • As String = Day, As Value = 1
  • As String = Business Day, As Value = 2

Default is Day (1).

N


Anchor

ctype

category - LCD

ctype

category - LCD

ctype

category

Type

Category

Type

Category of this Local Custom Day.

Valid values:

  • As String = Day, As Value = 1
  • As String = Business Day, As Value = 2
  • As String = Holiday, As Value = 3
  • As String = Period, As Value = 4

Default is

Single Date

Day (

0

1).

N


Anchor

date

comments - LCD

date

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:

  • As String = Single Date, As Value = 0
  • As String = Relative Repeating Date, As Value = 1
  • As String = Absolute Repeating Date, As Value = 2
  • As String = List of Dates, As Value = 3

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
<dateList>
        <date>2017-12-13</date>
        <date>2017-12-14</date>
</dateList>


 
JSON


Panel
"dateList": [
        "2017-12-13",
        "2017-12-14"
    ],


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:

Default is Mon (2).

  • As String = Sun, As Value = 1
  • As String = Mon, As Value = 2
  • As String = Tue, As Value = 3
  • As String = Wed, As Value = 4
  • As String = Thu, As Value = 5
  • As String = Fri, As Value = 6
  • As String = Sat, As Value = 7

Default is Mon (2).

Y
(if ctype
is Relative Repeating Date)


Anchor
month - LCD
month - LCD
month

Month

Month of the year.

Valid values:

Default is Jan (0).

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

Anchorname - LCDname - LCDname

Name

Name of this Local Custom Day.

Y

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

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

 
JSON

Panel

2); Rules for when the holiday will be observed.
 
XML


Panel
<observedRules> 
      <observedRule>            
            <actualDayOfWeek>Sat</actualDayOfWeek>           
            <observedDayOfWeek>Fri</observedDayOfWeek> 
      </observedRule> 
      <observedRule>                    
            <actualDayOfWeek>Sun</actualDayOfWeek>               
            <observedDayOfWeek>Mon</observedDayOfWeek> 
      </observedRule> 
</observedRules>


 
JSON


Panel
"observedRules" : [ { 
      "actualDayOfWeek" : "Sat", 
      "observedDayOfWeek" : "Fri" 
    }, { 
      "actualDayOfWeek" : "Sun", 
      "observedDayOfWeek" : "Mon" 
    } ]


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:

  • As String = 1st, As Value = 1
  • As String = 2nd, As Value = 2
  • As String = 3rd, As Value = 3
  • As String = 4th, As Value = 4
  • As String = Last, As Value = 5
  • As String = Every, As Value = 6

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.)


Anchor
Delete a Calendar
Delete a Calendar
Delete a Calendar

...