diff --git a/docs/csv_tpdestinationrates.rst b/docs/csv_tpdestinationrates.rst index 7b5be1287..32f73165a 100644 --- a/docs/csv_tpdestinationrates.rst +++ b/docs/csv_tpdestinationrates.rst @@ -1,7 +1,7 @@ DestinationRates.csv ++++++++++++++++++++ -Bind destination group from Destinations.csv_ with rates defined in Rates.csv_ files. +Attach rates to destinations. CSV fields as tabular representation: @@ -13,47 +13,20 @@ CSV fields as tabular representation: | DR_RETAIL_OFFPEAK | GERMANY | LANDLINE_OFFPEAK | +--------------------+------------------+---------------------+ +**Fields** + Index 0 - *Tag* - Free-text field used to reference the entry from other files. + Free-text field used to reference the entry from other files. -Index 1 - *Years* - Years this timing is valid on. +Index 1 - *DestinationsTag* + References profile in Destinations.csv_. - Possibile values: - * Semicolon (;) separated list of years as descriptive filter. - * "\*any" metatag used as match-any filter. - -Index 2 - *Months* - Months this timing is valid on. - - Possibile values: - * Semicolon (;) separated list of months as descriptive filter. - * "\*any" metatag used as match-any filter. - -Index 3 - *MonthDays* - Days of a month this timing is valid on. - - Possibile values: - * Semicolon (;) separated list of month days as descriptive filter. - * "\*any" metatag used as match-any filter. - -Index 4 - *WeekDays* - Days of a week this timing is valid on. Week days represented as integers where 1=Monday and 7=Sunday - - Possibile values: - * Semicolon (;) separated list of week days as descriptive filter. - * "\*any" metatag used as match-any filter. - -Index 5 - *Time* - The start time for this time period. - - Possibile values: - * String representation of time (hh:mm:ss). - * "\*asap" metatag used to represent time converted at runtime. +Index 2 - *RatesTag* + References profile defined in Rates.csv_. -.. _Destinations.csv: csv_tpdestinations -.. _Rates.csv: csv_tprates +.. _Destinations.csv: csv_tpdestinations.html +.. _Rates.csv: csv_tprates.html diff --git a/docs/csv_tpdestratetimings.rst b/docs/csv_tpdestratetimings.rst new file mode 100644 index 000000000..44113bcea --- /dev/null +++ b/docs/csv_tpdestratetimings.rst @@ -0,0 +1,35 @@ +DestinationRateTimings.csv +++++++++++++++++++++++++++ + +Enable DestinationRates at specific times. + +CSV fields examples as tabular representations: + ++-----------------+----------------------+-----------+--------+ +| Tag | DestinationRatesTag | TimingTag | Weight | ++=================+======================+===========+========+ +| RETAIL1 | DR_RETAIL_PEAK | PEAK | 10 | ++-----------------+----------------------+-----------+--------+ +| RETAIL1 | DR_FREESWITCH_USERS | ALWAYS | 10 | ++-----------------+----------------------+-----------+--------+ + + +**Fields** + +Index 0 - *Tag* + Free-text field used to reference the entry from other files. + +Index 1 - *DestinationRatesTag* + References profile in DestinationRates.csv_. + +Index 2 - *TimingTag* + References profile defined in Timings.csv_. + +Index 3 - *Weight* + Solves possible conflicts between different DestinationRateTimings profiles matching on same interval. + Higher *Weight* has higher priority. + + +.. _DestinationRates.csv: csv_tpdestinationrates.html +.. _Timings.csv: csv_tptimings.html + diff --git a/docs/csv_tpratingprofiles.rst b/docs/csv_tpratingprofiles.rst new file mode 100644 index 000000000..b4b8a5a67 --- /dev/null +++ b/docs/csv_tpratingprofiles.rst @@ -0,0 +1,39 @@ +RatingProfiles.csv +++++++++++++++++++ + +Main definitions file for the Rating subsystem. + ++------------------+------+-----------+---------+-----------------------+----------------------------+----------------------+ +| Tenant | TOR | Direction | Subject | ActivationTime | DestinationRateTimingTag | RatesFallbackSubject | ++==================+======+===========+=========+=======================+============================+======================+ +| cgrates.org | call | \*out | \*any | 2012-01-01T00:00:00Z | RETAIL1 | | ++------------------+------+-----------+---------+-----------------------+----------------------------+----------------------+ + +**Fields** + +Index 0 - *Tenant* + Free-text field used to identify the tenant the entries are valid for. +Index 1 - *TOR* + Free-text field used to identify the type of record the entries are valid for. +Index 2 - *Direction* + *Metatag* identifying the traffic direction the entries are valid for. Outbound direction is the only one supported for now. +Index 3 - *Subject* + Rating subject definition. + + Possible values: + * Free-text rating subject (flexible defition for example out of concatenating various cdr fields) + * "\*any" metatag matching any rating subject in the eventuality of no explicit subject string matching. +Index 4 - *ActivationTime* + Time this rating profile gets active at. + + Possible values: + * RFC3339 time as string + * Unix timestamp + * String starting with "+" to represent duration dynamically calculated at runtime (eg: +1h to specify ActivationTime one hour after runtime). + * "\*monthly" metatag for ActivationTime dynamically calculated one month after runtime. +Index 4 - *DestinationRateTimingTag* + References profile in DestinationRateTimings.csv_. +Index 5 - *RatesFallbackSubject* + Name of the fallback subject to be considered if existing subject has no destination matching the one searched. *Tenant*, *TOR*, *Direction*, *Subject* are kept when matching the fallback profile. + +.. _DestinationRateTimings.csv: csv_tpdestinationrates.html diff --git a/docs/tariffplans.rst b/docs/tariffplans.rst index dc18b2d5d..2bda27797 100644 --- a/docs/tariffplans.rst +++ b/docs/tariffplans.rst @@ -16,8 +16,8 @@ Each individual CSV file can have any number of rows starting with comment chara Depending on CGRateS subsystem, following files are required: -RatingProfiles -~~~~~~~~~~~~~~ +Rating +~~~~~~ .. toctree:: :maxdepth: 2 @@ -49,8 +49,8 @@ RatingProfiles csv_tpratingprofiles -Accounts -~~~~~~~~ +Accounting +~~~~~~~~~~ .. toctree:: :maxdepth: 2