Schema for Common Reporting Types Resource

The schema for the Common Reporting Types resource includes the following elements:

Click this link to view the XSD file.

ScheduleDetailType

Name

Type

Description

FireTime

FireTime

Represents the time when the report schedule needs to be triggered.

Recurrence

Recurrence

Represents the the frequency at which the report schedule needs to be triggered. The valid values are DAILY, WEEKLY, MONTHLY and YEARLY.

Range

Range

Represents the date range for the report schedule.

FireTime

Name

Type

Description

Hour

HoursInADayType

The hour at which the schedule needs to be triggered.

Minute

MinutesInAHourType

The minute at which the schedule needs to be triggered.

Recurrence

Name

Type

Description

DayOfMonth

xs:int

The day in a month when the report needs to be triggered. Value of 1 means first day of the month. Applicable only to Monthly and Yearly schedules.

DayOfWeek

xs:int

The day in a week when the report needs to triggered. This value is applicable if the report has a weekly schedule. Value of 1 means Sunday.

RepeatInterval

xs:int

Repeats the “DAILY” schedule at the specified interval. For example, if you specify 4, the report schedule will be triggered every 4th day. Applicable only to the Daily schedule.

Month

xs:int

The month in which the report schedule needs to be triggered. If you specify 1, the report schedule will be triggered on the first month of your quarter, half year or year. Applicable to Monthly, Quarterly, Half Yearly and Yearly schedules.

type

xs:string

Indicates the frequency at which the report needs to generated. The valid values are DAILY, MONTHLY, WEEKLY, QUARTERLY, HALFYEARLY, YEARLY, and CUSTOM.

Range

Name

Type

Description

StartDate

xs:long

Time in milliseconds (from January 1, 1970 GMT 00:00) representing the schedule start date.

EndDate

xs:long

Time in milliseconds (from January 1, 1970 GMT 00:00) representing the schedule end date. If EndDate is not specified, the report schedule is triggered based on the Count parameter given below.

Count

xs:int

Number of times that the report schedule needs to be triggered. If you specify -1, the report schedule will be triggered infinitely.

You need to specify either EndDate or Count.

ScheduleStatusType

Name

Type

Description

TaskId

xs:string

ID of the task.

LastRunTime

xs:string

Time when the report schedule was last run. This field will be empty for a new schedule.

NextRunTime

xs:string

Time when the report schedule will be run next. This field will be empty if the schedule has expired.

TaskStartTime

xs:string

Time from when the schedule is effective.

TaskEndTime

xs:string

Time till when the schedule is effective.

LastRunStatus

xs:string

Status of the previous run of the report schedule. Valid value is NEW, ERROR, RESCHEDULED, or SUCCESS.

NEW indicates a newly created schedule that has not been run before.

ERROR indicates that the previous run of the report schedule resulted in an error.

RESCHEDULED indicates that report was rescheduled.

SUCCESS indicates that the previous run of the report schedule was successful.

Errors

Errors

Provides details of any error while processing the request.

Errors

Name

Type

Description

Error

ErrorType

Represents the error encountered while processing the request.

ReportPeriodType

Name

Type

Description

Daily

Daily

Indicates that a report is generated daily. The report schedule is triggered for the previous day’s resource utilization or reservation.

Weekly

Weekly

Lets you select a seven-day reporting period as well as the day on which the report schedule needs to be triggered.

Monthly

Monthly

Helps you specify the reporting period as one month.

Quarterly

This option lets you specify a date of the first month of a quarter on which the report for the previous quarter has to be generated. The quarters defined are January–March, April–June, July–September, and October–December. For example, if the date is set to 5, then the report for the period April through June is generated on the 5th of July and the report for the period July through September will be generated on 5th of October.

HalfYearly

 

This is similar to the Quarterly option. In this case, the report is generated for a six-month duration. The report for the duration January to June is generated on the set date in July. The report for the duration July to December is generated on the set date in January.

Yearly

Yearly

This option is similar to the Monthly option. You can select the month and day starting from which the billing has to be done.

Custom

Custom

You can set a custom report period by specifying the start date of the report period as the number of days prior to the report generation day and the duration for which the entities have to be billed. You must also specify how often the report has to be generated. This value is set as number of days. For example, suppose you want to schedule a bi-weekly report. Set the start date for billing as 14 days prior to the report generation day, duration as 14 days, and the report scheduling policy as 14 days.

Daily

Name

Type

Description

DaysBefore

DaysInTenYearType

Number of days the server needs to go back and compute the report start date. Value of 1 means that the server needs to go back 1 day before the triggering time.

Weekly

Name

Type

Description

StartDayOfWeek

DaysInWeekType

Day of the week from which the report period needs to start. Value of 1 indicates Sunday.

The reporting period is always the week that occurred before the reporting day. For example, if the reporting period is set to Sunday–Saturday and the report generation day as Thursday, the report is generated every Thursday for the period Sunday through Saturday of the earlier week.

Monthly

Name

Type

Description

StartDayOfMonth

DaysInMonthType

Day of the month from which the monthly report period needs to start.

For example, suppose you want to generate a report on the 5th of each month for the period from the 2nd of the previous month through the 1st of the current month. In this case, you can specify the start day of the month as 2 and the report generation day as 5.

Yearly

Name

Type

Description

StartDayOfMonth

DaysInMonthType

Day of the month from which the report period needs to start.

For example, suppose you want to generate a yearly report for the earlier year on the second Sunday of January. In this case, you can specify the billing day as 1, the month as January, and the report generation day as the second Sunday of January, which is the scheduling policy.

Month

MonthsInYearType

Month of the year from the report period needs to start.

Custom

Name

Type

Description

StartTimeInMillis

DateInMilliSecsType

Start time of the report period (from 12:00 AM) in milliseconds. The valid value should be between 0 and 86340000.

EndTimeInMillis

DateInMilliSecsType

End time of the report period ( from 12:00 AM) in milliseconds. The valid value should be between 0 and 86340000.

DaysBefore

DaysInTenYearType

Number of days the server needs to go back from the firing day and compute the report start date.

NumOfDays

DaysInTenYearType

Number of days from the start date.

ReportHierarchyType

Name

Type

Description

Hierarchy

Hierarchy

Represents the hierarchy included in the report.

Hierarchy

Name

Type

Description

Name

NameType

Name of the hierarchy for which the report is generated.

Description

DescriptionType

Description of the hierarchy for which the report is generated.

Entities

Entities

Represents the entities included in the report.

id

xs:int

ID of the hierarchy included in the report.

Entities

Name

Type

Description

Name

NameType

Name of the entity included in the report.

Description

DescriptionType

Description of the entity included in the report.

CostModel

CostModelType

Represents the cost model included in the report.

id

xs:int

ID of the entity.

costModelID

xs:int

ID of the cost model effective on the entity.

EmailType

Name

Type

Description

Subject

xs:string

Subject of the email. The subject must have 1 to 512 characters.

Message

xs:string

Message of the email. The message must have 1 to 512 characters.

ToAddresses

EmailIdType

Represents the recipients of the email.

ReplyTo

EmailIdType

Represents the sender of the email.

CcAddresses

EmailIdType

Represents the recipients copied in the email.