Versions Compared

Key

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

...

  • The period Component query is only applicable for Date and DateTime fields.

  • The operators value type used in the period component query are as follows

    • equals

    • current

    • next

    • currentAndNext

    • during

  • The period units used in period component query are as follows

    • days: n

      • If conditions: { periodUnit: days, periodCount: 'n'}

        • It will return the records which are created between the current date to 'n' days

      • If conditions: { periodUnit: days, periodCount: 'n'}

      • It will return the records which are created from the 'n' days prior to the current date

    • weeks: n

      • If conditions: { createdOn: "weeks:n"}

        • It will return the records which are created between the current week to 'n' weeks

      • If conditions: { createdOn: "weeks:-n"}

        • It will return the records which are created from the 'n' weeks prior to the current week

    • months: n

      • If conditions: { createdOn: "weeks:n"}

        • It will return the records which are created between the current month to 'n' months

      • If conditions: { createdOn: "weeks:-n"}

        • It will return the records which are created from the 'n' months prior to the current month

    • calQuarters: n (calendar quarter)

      • If conditions: { createdOn: "calQuarters:n"}

        • It will return the records which are created between the current calendar quarter to 'n' calendar quarters

      • If conditions: { createdOn: "calQuarters:n"}

        • It will return the records which are created from the 'n' calendar quarter prior to the current calendar quarter till the current calendar quarter

    • fYQuarters: n (financial quatrer)

      • If conditions: { createdOn: "fYQuarters:n"}

        • It will return the records which are created between the current financial quarter to 'n' financial quarters

      • If conditions: { createdOn: "fYQuarters:n"}

        • It will return the records which are created from the 'n' financial quarter prior to the current financial quarter till the current financial quarter

    • calYears: n (current calendar year)

      • If conditions: { createdOn: "calYears:n"}

        • It will return the records which are created between the current calendar year to 'n' calendar years

      • If conditions: { createdOn: "calYears:n"}

        • It will return the records which are created from the 'n' calendar year prior to the current calendar year till the current calendar year

    • fYYears: n (current financial year)

      • If conditions: { createdOn: "fYYears:n"}

        • It will return the records which are created between the current financial year to 'n' financial years

      • If conditions: { createdOn: "fYYears:n"}

        • It will return the records which are created from the 'n' financial year prior to the current financial year till the current financial year

During Operator

  • During means some time between the beginning and the end of a period

  • The during operator of the period component query is applicable for the Date and DateTime fields

Relative Literals in period component query

  • Yesterday

    • If condition{ period: ”yesterday”}

      It will return the previous day's record

      custom

      • If we set the value type custom then we have to give the value

      • ex. {valueType: custom, value: “2023-06-24”}

    • relative

      • If we set the value type relative then it will take the value as the current date and time

  • The operators used in a period component query are as follows

    • equals

    • greaterThan

    • greaterThanEquals

    • lessThan

    • lessThanequals

    • current

    • next

    • currentAndNext

    • previous

    • currentAndPrevious

    • during

  • Fiscal Year and Fiscal Quarter

    • You can set the fiscal year on the instance using the field FYYearStartMonth

    • For example, you set FYYearStartMoth:

      • { label: “Mar”, value:3}

    • Then your year will start to March to Feb

  • The period units used in the period component query are as follows

    • milliseconds

    • seconds

    • minutes

    • hours

    • days: n

      • If conditions: { periodUnit: days, periodCount: 'n'}

        • It will return the records which are created between the current date to 'n' days

      • If conditions: { periodUnit: days, periodCount: 'n'}

      • It will return the records which are created from the 'n' days prior to the current date

    • weeks: n

      • If conditions: { createdOn: "weeks:n"}

        • It will return the records which are created between the current week to 'n' weeks

      • If conditions: { createdOn: "weeks:-n"}

        • It will return the records which are created from the 'n' weeks prior to the current week

    • months: n

      • If conditions: { createdOn: "weeks:n"}

        • It will return the records which are created between the current month to 'n' months

      • If conditions: { createdOn: "weeks:-n"}

        • It will return the records which are created from the 'n' months prior to the current month

    • calQuarters: n (calendar quarter)

      • If conditions: { createdOn: "calQuarters:n"}

        • It will return the records which are created between the current calendar quarter to 'n' calendar quarters

      • If conditions: { createdOn: "calQuarters:n"}

        • It will return the records which are created from the 'n' calendar quarter prior to the current calendar quarter till the current calendar quarter

    • fYQuarters: n (financial quatrer)

      • If conditions: { createdOn: "fYQuarters:n"}

        • It will return the records which are created between the current financial quarter to 'n' financial quarters

      • If conditions: { createdOn: "fYQuarters:n"}

        • It will return the records which are created from the 'n' financial quarter prior to the current financial quarter till the current financial quarter

    • calYears: n (current calendar year)

      • If conditions: { createdOn: "calYears:n"}

        • It will return the records which are created between the current calendar year to 'n' calendar years

      • If conditions: { createdOn: "calYears:n"}

        • It will return the records which are created from the 'n' calendar year prior to the current calendar year till the current calendar year

    • fYYears: n (current financial year)

      • If conditions: { createdOn: "fYYears:n"}

        • It will return the records which are created between the current financial year to 'n' financial years

      • If conditions: { createdOn: "fYYears:n"}

        • It will return the records which are created from the 'n' financial year prior to the current financial year till the current financial year

Equals

  • By using an equals operator we will fetch records of the provided value

  • valueType: custom

    • If conditions: {valueType: “custom”, periodUnit: days, periodCount: n}

      • It will return records of period count day date

  • If conditions: {valueType: “custom”, periodUnit: weeks, periodCount: n}

    • It will return records of period count week date

During Operator

  • During means some time between the beginning and the end of a period

  • The during operator of the period component query is applicable for the Date and DateTime fields

Relative Literals in period component query

  • Yesterday

    • If condition{ period: ”yesterday”}

      • It will return the previous day's record from the current day

    • If condition{ period: ”tomorrow”}

      • It will return the next day's record from the current day

    • If condition{ period: ”today”}

      • It will return the current day record

    • If condition{ period: ”next7Days”}

      • It will return the next 7 day's records from the current day

    • If condition{ period: ”next30Days”}

      • It will return the next 30 day's records from the current day

    • If condition{ period: ”next60Days”}

      • It will return the next 60 day's records from the current day

    • If condition{ period: ”next90Days”}

      • It will return the next 90 day's records from the current day

    • If condition{ period: ”next180Days”}

      • It will return the next 180 day's records from the current day

    • If condition{ period: ”previous7Days”}

      • It will return the previous 7 day's records from the current day

    • If condition{ period: ”previous30Days”}

      • It will return the previous 30 day's records from the current day

    • If condition{ period: ”tomorrow””previous60Days”}

      • It will return the next previous 60 day's record records from the current day

    • If condition{ period: ”today””previous90Days”}

      • It will return will return the previous 90 day's records from the current day record

    • If condition{ period: ”next7Days””previous180Days”}

      • It will return the next 7 previous 180 day's records from the current day

    • If condition{period: ”next30Days”“currentWeek”}

      • It will return the next 30 day's records from the current daycurrent week records

    • If condition {period: ”next60Days”“nextWeek”}

      • It will return the next 60 day's week records from the current dayweek

    • If condition {period: ”next90Days”“previousWeek}

      • It will return the next 90 day's previous week records from the current dayweek

    • If condition {period: ”next180Days”“currentAndNextWeek”}

      • It will return the next 180 day's records from week and the current dayweek records

    • If condition {period: ”previous7Days”“currentAndPreviousWeek}

      • It will return the previous 7 day's records from the current dayweek and the current week's’s records

    • If condition{period: “currentMonth”}

      • It will return the current month records

    • If condition {period: ”previous30Days”“nextMonth”}

      • It will return the previous 30 day's next month records from the current daymonth

    • If condition {period: ”previous60Days”“previousMonth}

      • It will return the previous 60 day's month records from the current daymonth

    • If condition {period: ”previous90Days”“currentAndNextMonth”}

      • It will return the previous 90 day's records from next month and the current daymonth records

    • If condition {period: ”previous180Days”“currentAndPreviousMonth}

      • It will return the previous 180 day's records from month and the current daymonth records

    • If condition{period: “currentWeek”“currentCalendarQuarter”}

      • It will return the current week calendar quarter records

    • If condition {period: “nextWeek”“nextCalendarQuarter”}

      • It will return the next week calendar quarter records from the current weekcalendar quarter

    • If condition {period: “previousWeek“previousCalendarQuarter}

      • It will return the previous week calendar quarter records from the current weekcalendar quarter

    • If condition {period: “currentAndNextWeek”“currentAndNextCalendarQuarter”}

      • It will return the next week calendar quarter and the current week calendar quarter records

    • If condition {period: “currentAndPreviousWeek“currentAndPreviousCalendarQuarter}

      • It will return the previous week calendar quarter and the current week's’s calendar quarter records

    • If condition{period: “currentMonth”“currentCalendarYear”}

      • It will return the current month calendar year records

    • If condition {period: “nextMonth”“nextCalendarYear”}

      • It will return the next month calendar year records from the current month calendar year

    • If condition {period: “previousMonth“previousCalendarYear}

      • It will return the previous month calendar year records from the current month calendar year

    • If condition {period: “currentAndNextMonth”“currentAndNextCalendarYear”}

      • It will return the next month calendar year and the current month calendar year records

    • If condition {period: “currentAndPreviousMonth“currentAndPreviousCalendarYear}

      • It will return the previous month calendar year and the current month calendar year records

    • If condition{period: “currentCalendarQuarter”“currentFiscalQuarter”}

      • It will return the current calendar fiscal quarter records

    • If condition {period: “nextCalendarQuarter”“nextFiscalQuarter”}

      • It will return the next calendar fiscal quarter records from the current calendar fiscal quarter

    • If condition {period: “previousCalendarQuarter“previousFiscalQuarter}

      • It will return the previous calendar fiscal quarter records from the current calendar fiscal quarter

    • If condition {period: “currentAndNextCalendarQuarter”“currentAndNextFiscalQuarter”}

      • It will return the next calendar fiscal quarter and the current calendar fiscal quarter records

    • If condition {period: “currentAndPreviousCalendarQuarter“currentAndPreviousFiscalQuarter”}

      • It will return the previous calendar fiscal quarter and the current calendar fiscal quarter records

    • If condition{period: “currentCalendarYear”“currentFiscalYear”}

      • It will return the current calendar fiscal year records

    • If condition {period: “nextCalendarYear”“nextFiscalYear”}

      • It will return the next calendar fiscal year records from the current calendar fiscal year

    • If condition {period: “previousCalendarYear“previousFiscalYear”}

      • It will return the previous calendar fiscal year records from the current calendar fiscal year

    • If condition {period: “currentAndNextCalendarYear”“currentAndNextFiscalYear”}

      • It will return the next calendar fiscal year and the current calendar fiscal year records

    • If condition {period: “currentAndPreviousCalendarYear“currentAndPreviousFiscalYear”}

      • It will return the previous calendar fiscal year and the current calendar fiscal year records

Period Custom During Operator

  • If the period is custom then you can set the range flow

    • rangeFlow: