 |
Consumption Analytics Documentation |
|
Consumption Analytics Documentation |
This article specifies the format of a CSV file that is required to import services and rates with ccimport and written by ccexport. For more information about this task, see Importing services and rates together.
Each row in the file represents a measure in a service and a rate for that service in an effective date range of a rate plan. It contains attributes of the measure, of the service, and of the rate. This means that multiple rows are required to define a service made up of more than one measure or a rate with tiers. When an input file contains more than one row for a given service and those rows have different values for a service-level attribute, the result of the import is the value in the last of those rows.
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 | Attribute of | Description | Required |
|---|---|---|---|---|
service_name | service | Service | Name of the service to import or update | Yes |
| service_desc | desc | Service | Description of the service | No |
measurement_type | (none) | Measure | How | No |
group_name | group | Service | Group of which the service is a member | No |
active_flag | active | Service | Whether the service is active. Valid values: 1/true or 0/false. The default is true. | No |
proration_type | proration | Service | How to prorate an allocated serviceValid values: Default value: | No |
charge_interval | interval | Service | Valid values: Default value: | No |
unit_decimals | unit_dec | Service | Unit decimal positions | No |
unit_desc | unit | Service | Unit description | Yes |
tag_name | tag.name | Service | Name of the tag | No |
tag_value | tag.value | Service | Value for the named tag | No |
schema_name | schema | Measure | Schema name | No |
measure_name | measure | Measure | Measure name | No |
measure_quantity_operator | quantity_operator | Measure | Operator specifying exact quantity value or range of values. Valid values:
| No |
measure_quantity | quantity | Measure | Quantity of the measure in the service or lower bound quantity if specifying a range | No |
measure_quantity_high | quantity_high | Measure | Upper bound of the measure quantity in the service | No |
conversion_operator | operator | Measure | Unit conversion operator. Valid values: Default value: | No |
conversion_operand | operand | Measure | Unit conversion factor or divisor | No |
dimension_filter_type | filter_type | Service | Name of a dimension to use as a service filter | No |
dimension_filter_value | filter_value | Service | Value of the named dimension to use as a service filter | No |
|
|
| Rate | Rate plan name. If not specified, use the "Default" rate plan. | Yes |
|
|
| Rate | Rate plan description | No |
service_rate_desc | svc.rate.desc | Rate | 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 | Rate | A rate plan field passed as metadata to the HPE Consumption Analytics Portal database. | No |
svc_rate_tag_value | rate.tag.value | Rate | The value for a svc_rate_tag_name field. | No |
|
|
| Rate | The beginning date of the effective date range to create or update in the rate plan, in the format of | No |
end_date | end | Rate | The ending date for the effective date range of the rate plan, in the format yyyymmdd. | No |
|
| model | Rate | Valid values: Default value: | No |
|
|
| Rate | The decimal precision of the rate | No |
min_commitment_value | min.value | Rate | The amount of a service customers are obligated to purchase regardless of their actual usage of that service | No |
min_commitment_interval | min.interval | Rate | Defines how often the min_commit_value obligation is applied (Daily, Hourly, or Monthly) | No |
|
|
| Rate | Minimum units to charge, if this is Basic price model | No |
|
|
| Rate | State name when the rate type is State | Yes |
|
|
| Rate | State description when the rate type is State | No |
|
|
| Rate | Tier name when the rate type is Sticky Tiers or Final Tier | No |
|
|
| Rate | Lowest value in a tier when the rate type is Sticky Tiers or Final Tier. | No |
|
|
| Rate | The level of your account structure at which usage is aggregated for tiers when the rate type is Sticky Tiers or Final Tier | No |
fixed_charge_amount | fixed | Rate | One-time, or fixed, rate | No |
rate | unit.price | Rate | Per-unit, or variable, rate | No |
The following is a sample CSV file. Quotes are required only for fields that contain a comma in their value.
service_name,service_desc,measurement_type,group_name,active_flag,proration_type,charge_interval,unit_decimals,unit_desc,tag_name,tag_value,schema_name,measure_name,measure_quantity_operator,measure_quantity,measure_quantity_high,conversion_operator,conversion_operand,dimension_filter_type,dimension_filter_value,rate_plan_name,rate_plan_desc,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 A1 VM (Non-Windows) - US West,Compute,allocated,APC,1,full,daily,4,Compute Hours,,,APC,ResourceQtyConsumed,*,1,,none,,ComputedServiceName,A1 VM (Non-Windows) - US West,Default,Default rate plan for all services,,20000101,29991231,basic,4,,daily,,,,,,4,4 A1 VM (Non-Windows) - US West,Compute,allocated,APC,1,full,daily,4,Compute Hours,,,APC,ResourceQtyConsumed,*,1,,none,,ComputedServiceName,A1 VM (Non-Windows) - US West,Cost,Cost plan for all services,,20000101,29991231,passthrough,4,,daily,,,,,,, A1 VM (Non-Windows) - US West,Compute,allocated,APC,1,full,daily,4,Compute Hours,,,APC,ResourceQtyConsumed,*,1,,none,,ComputedServiceName,A1 VM (Non-Windows) - US West,NewRatePlan,,,20000101,29991231,basic,4,,daily,,,,,,100,2 BASIC.A1 VM (Non-Windows) - US West,Compute,allocated,APC,1,full,daily,4,Compute Hours,,,APC,ResourceQtyConsumed,*,1,,none,,ComputedServiceName,BASIC.A1 VM (Non-Windows) - US West,Default,Default rate plan for all services,,20000101,29991231,basic,4,,daily,,,,,,1,1 BASIC.A1 VM (Non-Windows) - US West,Compute,allocated,APC,1,full,daily,4,Compute Hours,,,APC,ResourceQtyConsumed,*,1,,none,,ComputedServiceName,BASIC.A1 VM (Non-Windows) - US West,Cost,Cost plan for all services,,20000101,29991231,passthrough,4,,daily,,,,,,, BASIC.A1 VM (Non-Windows) - US West,Compute,allocated,APC,1,full,daily,4,Compute Hours,,,APC,ResourceQtyConsumed,*,1,,none,,ComputedServiceName,BASIC.A1 VM (Non-Windows) - US West,NewRatePlan,,,20000101,29991231,basic,4,,daily,,,,,,100,2 BASIC.A1 VM (Non-Windows) - US West,Compute,allocated,APC,1,full,daily,4,Compute Hours,,,APC,ResourceQtyConsumed,*,1,,none,,ComputedServiceName,BASIC.A1 VM (Non-Windows) - US West,RatePlan-jrl,Copy of the Default rate plan,,20000101,29991231,basic,4,,daily,,,,,,1,1 EU-EBS:SnapshotUsage,$0.095 per GB-Month of snapshot data stored - EU (Ireland),allocated,AWS,1,full,monthly,4,units,,,AWS,UsageQuantity,*,1,,none,,ComputedServiceName,EU-EBS:SnapshotUsage,Cost,Cost plan for all services,,20000101,29991231,passthrough,4,,daily,,,,,,, EU-ElasticIP:IdleAddress,$0.005 per Elastic IP address not attached to a running instance per hour (prorated),allocated,AWS,1,full,monthly,4,units,,,AWS,UsageQuantity,*,1,,none,,ComputedServiceName,EU-ElasticIP:IdleAddress,Default,Default rate plan for all services,,20000101,29991231,passthrough,4,,daily,,,,,,, EU-ElasticIP:IdleAddress,$0.005 per Elastic IP address not attached to a running instance per hour (prorated),allocated,AWS,1,full,monthly,4,units,,,AWS,UsageQuantity,*,1,,none,,ComputedServiceName,EU-ElasticIP:IdleAddress,Cost,Cost plan for all services,,20000101,29991231,passthrough,4,,daily,,,,,,, EUC1-CW:Requests,"$0.01 per 1,000 requests",allocated,AWS,1,full,monthly,4,units,,,AWS,UsageQuantity,*,1,,none,,ComputedServiceName,EUC1-CW:Requests,Default,Default rate plan for all services,,20000101,29991231,passthrough,4,,daily,,,,,,, AWS-Support-Business,Adjustment for previously charged amount,allocated,AWS,1,full,monthly,4,Dollars,,,AWS,UsageQuantity,*,1,,none,,ComputedServiceName,AWS-Support-Business,Default,Default rate plan for all services,,20000101,29991231,passthrough,4,,daily,,,,,,, AWS-Support-Business,Adjustment for previously charged amount,allocated,AWS,1,full,monthly,4,Dollars,,,AWS,UsageQuantity,*,1,,none,,ComputedServiceName,AWS-Support-Business,Cost,Cost plan for all services,,20000101,29991231,passthrough,4,,daily,,,,,,, DeliveryAttempts-SMTP,"First 1,000 Amazon SNS Email/Email-JSON Notifications per month are free",allocated,AWS,1,full,monthly,4,units,,,AWS,UsageQuantity,*,1,,none,,ComputedServiceName,DeliveryAttempts-SMTP,Default,Default rate plan for all services,,20000101,29991231,passthrough,4,,daily,,,,,,, DeliveryAttempts-SMTP,"First 1,000 Amazon SNS Email/Email-JSON Notifications per month are free",allocated,AWS,1,full,monthly,4,units,,,AWS,UsageQuantity,*,1,,none,,ComputedServiceName,DeliveryAttempts-SMTP,Cost,Cost plan for all services,,20000101,29991231,passthrough,4,,daily,,,,,,,