Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Macro name changed from html to html-bobswift during server to cloud migration processing.

...

categoryctypedatedateList

Multiple specific dates for this Custom Day.
 
XML

 
JSON

daydayofweek

Valid values:

Default is Mon (2).

exportReleaseLevelexportTableholidaymonth

Valid values:

Default is Jan (0).

namenthAmountnthType

Valid values:

Default is Day (1).

observedRules

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

periodrelfreq

Valid values:

Default is 1st (1).

retainSysIds

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
adjustment - CCD
adjustment - CCD
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 - CCD
adjustmentAmount - CCD
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 - CCD
adjustmentType - CCD
adjustmentType

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

N

Anchor
category - CCD


category - CCD

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
</ul>


Default is Day (1).

N


Anchor
comments category - CCDcomments
category - CCD
commentscategory

DescriptionCategory

Description Category of this Local Custom Day.

N

Anchor
ctype - CCDctype - CCD

Type

Type of this Custom Day.

Valid values:

Default is Single Date (0).

N

Anchor
date - CCDdate - CCD

Date

Specific date for this Custom Day

Format: yyyy-mm-dd.

Y
(if ctype =
Single Date. )

datelist

Anchor
dateList - CCDdateList - CCD

Dates

Panel
Panel

Y
(if ctype
is List of Dates.)

date

Anchor
day - CCDday - CCD

Day

Day of the month.

Integer; Valid values: 1-31.

Y
(if ctype
is Absolute Repeating Date)

Anchor
dayofweek - CCDdayofweek - CCD

Day Of Week

Day of the week.

Y
(if ctype
is Relative Repeating Date)
 
N
(if relfreq
is Nth)

Anchor
exportReleaseLevel - CCDexportReleaseLevel - CCDn/a

Universal Controller release that the record was exported from.

read onlyN
Anchor
exportTable - CCDexportTable - CCDn/aRecord table information.read onlyN
Anchor
holiday - CCDholiday - CCD

(none)

Deprecated.   Indication of whether or not this Custom Day is a holiday.

Boolean; Valid values: true/false; Default is false.

N

Anchor
month - CCDmonth - CCD

Month

Month of the year.

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

Anchor
name - CCDname - CCD

Name

Name of this Custom Day.

Y

Anchor
nthAmount - CCDnthAmount - CCD

Nth Amount

If relfreq is Nth; Value of N.

Y

Anchor
nthType - CCDnthType - CCD

Nth Type

If relfreq is Nth; Type of Nth day.

N

Anchor
observedRules - CCDobservedRules - CCD

Observed Rules

Panel


Panel

Valid day of week values:

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

N

Anchor
period - CCDperiod - CCD

(none)

Deprecated.   Indication of whether or not this Custom Day defines a custom period of days.

Boolean; Valid values: true/false; Default is false.

N

Anchor
relfreq - CCDrelfreq - CCD

When

Occurrence of this day in the month.

Y
(if ctype
is Relative Repeating Date)

Anchor
retainSysIds - CCDretainSysIds - CCD

n/a

Specification for whether or not the Create a Custom Day web service will persist the sysId property.
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 - CCD
comments - CCD
comments

Description

Description of this Custom Day.


N


Anchor
ctype - CCD
ctype - CCD
ctype

Type

Type of this 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 - CCD
date - CCD
date

Date

Specific date for this Custom Day

Format: yyyy-mm-dd.

Y
(if ctype =
Single Date. )

datelist

Anchor
dateList - CCD
dateList - CCD
dateList

Dates

Multiple specific dates for this Custom Day.
 
XML


Panel
Html bobswift
<pre>
&lt;dateList&gt;
        &lt;date&gt;2017-12-13&lt;/date&gt;
        &lt;date&gt;2017-12-14&lt;/date&gt;
&lt;/dateList&gt;
</pre>


 
JSON


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


Y
(if ctype
is List of Dates.)

date

Anchor
day - CCD
day - CCD
day

Day

Day of the month.

Integer; Valid values: 1-31.

Y
(if ctype
is Absolute Repeating Date)


Anchor
dayofweek - CCD
dayofweek - CCD
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)
 
N
(if relfreq
is Nth)


Anchor
exportReleaseLevel - CCD
exportReleaseLevel - CCD
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - CCD
exportTable - CCD
exportTable

n/aRecord table information.read onlyN

Anchor
holiday - CCD
holiday - CCD
holiday

(none)

Deprecated.   Indication of whether or not this Custom Day is a holiday.

Boolean; Valid values: true/false; Default is false.

N


Anchor
month - CCD
month - CCD
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 - CCD
name - CCD
name

Name

Name of this Custom Day.


Y


Anchor
nthAmount - CCD
nthAmount - CCD
nthAmount

Nth Amount

If relfreq is Nth; Value of N.


Y


Anchor
nthType - CCD
nthType - CCD
nthType

Nth Type

If relfreq is Nth; Type of Nth day.

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
observedRules - CCD
observedRules - CCD
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
period - CCD
period - CCD
period

(none)

Deprecated.   Indication of whether or not this Custom Day defines a custom period of days.

Boolean; Valid values: true/false; Default is false.

N


Anchor
relfreq - CCD
relfreq - CCD
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
<li> As String = Nth, As Value = 7
<li> As String = Last Day, As Value = 8
<li> As String = Last Business Day, As Value = 9
</ul>


Default is 1st (1).

Y
(if ctype
is Relative Repeating Date)


Anchor
retainSysIds - CCD
retainSysIds - CCD
retainSysIds

n/a

Specification for whether or not the Create a Custom Day 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
titleNote

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

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

N

Anchor
sysId - CCD
sysId - CCD
sysId

n/a

System ID in the database for this Custom Day.

Persisted only if retainSysIds is set to true.

Y
(if retainSysIds
is true.)


...