A JSON file which defines a customized structure of reports to be generated can be configured as follows:
Example:
{
"aps": {
"type": "aps_resource_type"
},
"name": {
"en_US": "Simple",
"de_DE": "Simple DE"
},
"dataSet": {
"aps": {
"id": "Data_Set_ID"
}
}
"columns" : [
{
"name": "RESELLER_ACCOUNT_ID",
"alias": "RID"
},
{
"name": "RESELLER_ACCOUNT_ATTRIBUTES",
"alias": "RATTR"
},
{
"name": "RESELLER_ORDER_ATTRIBUTES",
"alias": "ROATTR"
},
{
"name": "MISSED",
"alias": "NOATTR"
},
{
"name": "CUSTOMER_ACCOUNT_ID",
"alias": "CID"
},
{
"name": "CUSTOMER_ACCOUNT_ATTRIBUTES",
"alias": "CATTR"
},
{
"name": "CUSTOMER_ORDER_ATTRIBUTES",
"alias": "COATTR"
}
],
"resellerAccountAttributes":[
{
"name": "AA1",
"alias": "RAA1"
},
{
...
}
],
"resellerOrderAttributes":[
{
"name": "OA2",
"alias": "ROA2"
},
{
...
}
],
"customerAccountAttributes":[
{
"name": "AA3",
"alias": "CAA3"
},
{
...
}
] "customerOrderAttributes":[
{
"name": "OA4",
"alias": "COA4"
},
{
...
Objects of the JSON file are explained below.
APS type
"type": "aps_resource_type": is a type which defines the variation of a simplified view:
http://www.odin.com/rde/report-customization/2.0: is a type used to enable a simplified view in UX1 for all resellershttp://www.odin.com/rde/reseller-report-customization/1.0: is a type used to enable a simplified view in UX1 for a specific reseller (available from version 1.4-135)
Name
"name": is a name of the report view, for example, Simple, Simplified and so on. It can be defined differently for each locale used. The EN language name is mandatory.
Column set
"columns": [...] specifies the list of columns to be shown, their order, and their names.
"name": "RESELLER_ACCOUNT_ID" is a name of the column in the database from where the value is taken.
"alias": "RID" is a customized name of the column. The "alias" value can have only Latin characters (upper- and lowercase), numbers, and underscores.
Attribute
Any items in this section must be also defined in the column set section.
In some columns, data is represented as a JSON array. Attributes from such arrays can be mapped onto custom fields in a report so that only a specific attribute is displayed in the customized column.
You can apply such customization to the following columns:
- CUSTOMER_ACCOUNT_ATTRIBUTES
- CUSTOMER_ORDER_ATTRIBUTES
- RESELLER_ACCOUNT_ATTRIBUTES
- RESELLER_ORDER_ATTRIBUTES
- END_CUSTOMER_ACCOUNT_ATTRIBUTES
- END_CUSTOMER_ORDER_ATTRIBUTES
- SUBSCRIPTION_ATTRIBUTES (available from version 1.3-128)
"resellerAccountAttributes":[ ... ]: in this section, custom columns to be mapped onto attributes from the "RESELLER_ACCOUNT_ATTRIBUTES" column are defined. Each column corresponds to the specified attribute:
Note: The section name must be a column name written in lowerCamelCase, with no underscores. For example, custom fields for the END_CUSTOMER_ORDER_ATTRIBUTES column must be defined within the endCustomerOrderAttributes section.
"name": "AccountAttribute1"is the name of the attribute whose value will be extracted from the JSON and displayed in a custom column."alias": "RAA1"is the name of the custom column to store the value in. The "alias" value can only contain Latin characters (upper- and lowercase), numbers, and underscores.
Note:
- If a custom field is mapped onto an attribute in a column, the rest of the attributes for which there are no custom fields defined will not be included in the report.
- If there is no such attribute or column as defined in JSON, then a report will be generated but the corresponding fields will be empty.
Additional data set
By default, this structure is applied to the “Provisioned orders” default data set. Provide an ID of an additional data set if any are enabled, as follows:
"dataSet": {
"aps": {
"id": "Data_Set_ID"
}
}