 |
Consumption Analytics Documentation |
|
Consumption Analytics Documentation |
This article specifies the format of a CSV file that is required to import rate plans with ccimport and written by ccexport. Each row represents one rate for a given service in a given effective date range of a given rate plan. Therefore, a service with tiered rates requires multiple rows, one for each tier.
The first line of the file is a header row that defines the format of the subsequent rows. The following table describes the valid field names for the header row, some of which also have short names that you can use instead. In the full field names, you can substitute dots (.) for underscores (_).
CSV rows beginning with a pound sign (#) are treated as comments and ignored by the importer.
| Field Name | Short Name | Description | Required |
|---|---|---|---|
|
|
| The rate plan that the rate belongs to. The default is | No |
|
|
| The description for the rate plan. If more than one row for a rate plan contains a value for this field, the last one is used. | No |
service_name |
| The service that the rate applies to. | No |
service_rate_desc | svc.rate.desc | The description of the service when charged under the rate plan. This text appears in place of the service name on standard reports when the Allow unique service descriptions for customers option is enabled in Administration > Configuration > General > System. When the option is disabled, this field is ignored by | No |
svc_rate_tag_name | rate.tag.name | A rate plan field passed as metadata to the HPE Consumption Analytics Portal database. | No |
svc_rate_tag_value | rate.tag.value | The value for a svc_rate_tag_name field. | No |
|
|
| The first date of the effective date range for the rate, in the format of | No |
end_date | end | The ending date for the effective date range of the rate plan, in the format yyyymmdd. | No |
|
| model | Type for | No |
|
|
| The precision for the rate in decimal places. The default is 4. | No |
min_commitment_value | min.value | The amount of a service customers are obligated to purchase regardless of their actual usage of that service | No |
min_commitment_interval | min.interval | Defines how often the min_commit_value obligation is applied (Daily, Hourly, or Monthly) | No |
|
|
| The minimum service quantity to charge, if | No |
|
|
| The name of the state that the rate applies to, if | Yes |
|
|
| The description of the state that the rate applies to, if | No |
|
|
| The name of the tier that the rate applies to, if rate_type is T or H | No |
|
|
| The lowest service quantity of the tier that the rate applies to, if | No |
|
|
| The account level at which service quantities are aggregated for tier calculation, if If more than one row for a service contains a value for this field, the last one is used. | No |
currency_code | currency | Three-letter currency code for the rate. For example, usd or yen. | No |
fixed_charge_amount | fixed | The fixed (one-time) rate for the service. If more than one row for a service contains a value for this field, the last one is used. | No |
rate | unit.price | The variable (per-unit) rate for the service or tier | No |
The following is a sample CSV file.
rate_plan_name,rate_plan_desc,service_name,service_rate_desc,effective_date,end_date,rate_type,rate_decimals,min_commitment_value,min_commitment_interval,state_name,state_desc,tier_name,tier_low_range,tier_target_account_field,fixed_charge_amount,rate Default,Default rate plan for all services,systemcenter.PerNICBytesSentPerSecond,,20000101,29991231,basic,4,,daily,,,,,,,0 Default,Default rate plan for all services,EU-EBS:SnapshotUsage,,20000101,29991231,passthrough,4,,daily,,,,,,, Default,Default rate plan for all services,systemcenter.PerNICBytesReceivedPerSecond,,20000101,29991231,basic,4,,daily,,,,,,,0 Default,Default rate plan for all services,EU-ElasticIP:IdleAddress,,20000101,29991231,passthrough,4,,daily,,,,,,, Default,Default rate plan for all services,sqlservers.DatabaseCount,,20000101,29991231,basic,4,,daily,,,,,,,0.75 Default,Default rate plan for all services,EUC1-CW:Requests,,20000101,29991231,passthrough,4,,daily,,,,,,, Default,Default rate plan for all services,LoadBalancerUsage,,20000101,29991231,passthrough,4,,daily,,,,,,, Default,Default rate plan for all services,mysqlservers.DatabaseCount,,20000101,29991231,basic,4,,daily,,,,,,,0.5 Default,Default rate plan for all services,OpenWorkflowDays,,20000101,29991231,passthrough,4,,daily,,,,,,,