Planning Application Functions
| Function | Description |
|---|---|
| dbo25.get_json_array_values | This function returns a table of array values from the JSON string. |
| dbo25.get_json_object_values | This function returns a table of name-value pairs from the JSON string. |
| dbo25.get_quarter_members | This function returns a table of quarter members for the specified year. |
| dbo25.get_standard_members | This function returns a table of standard members to initialize the application. |
| dbo25.get_translated_string | This function returns a company-related translated string. |
| dbo25.get_year_members | This function returns a table of time members for the specified year. |
dbo25.get_json_array_values
This function returns a table of array values from the JSON string.
| Parameter | DataType | Comment |
|---|---|---|
| @c | nvarchar(max) | JSON array |
| Column | DataType | Comment |
|---|---|---|
| id | int | Value index |
| value | nvarchar(max) | Value |
You may use this function to parse the @json_columns and @json_values parameters of stored procedures.
The SaveToDB add-in passes table headers and row values into these parameters in the JSON format.
You may use the native JSON functions of SQL Server instead.
dbo25.get_json_object_values
This function returns a table of name-value pairs from the JSON string.
| Parameter | DataType | Comment |
|---|---|---|
| @c | nvarchar(max) | JSON object |
| Column | DataType | Comment |
|---|---|---|
| name | nvarchar(100) | Property name |
| value | nvarchar(max) | Property value |
You may use the native JSON functions of SQL Server instead.
dbo25.get_quarter_members
This function returns a table of quarter members for the specified year.
| Parameter | DataType | Comment |
|---|---|---|
| @year | int | Year |
| Column | DataType | Comment |
|---|---|---|
| code | nvarchar(50) | dbo25.members.code |
| name | nvarchar(400) | dbo25.members.name |
| dimension_id | tinyint | dbo25.members.dimension_id |
| sort_order | int | dbo25.members.sort_order |
| calc_type_id | tinyint | dbo25.members.calc_type_id |
| row_color | tinyint | dbo25.members.row_color |
| previous_period | nvarchar(50) | dbo25.members.previous_period_id |
| same_period | nvarchar(50) | dbo25.members.same_period_id |
| parent1 | nvarchar(50) | dbo25.parents.parent_id |
| parent2 | nvarchar(50) | dbo25.parents.parent_id |
| parent3 | nvarchar(50) | dbo25.parents.parent_id |
The function is used in the xls25.xl_actions_add_quarters procedure.
dbo25.get_standard_members
This function returns a table of standard members to initialize the application.
| Column | DataType | Comment |
|---|---|---|
| code | nvarchar(50) | dbo25.members.code |
| name | nvarchar(400) | dbo25.members.name |
| dimension_id | tinyint | dbo25.members.dimension_id |
| sort_order | int | dbo25.members.sort_order |
| calc_type_id | tinyint | dbo25.members.calc_type_id |
| row_color | tinyint | dbo25.members.row_color |
| previous_period | nvarchar(50) | dbo25.members.previous_period_id |
| same_period | nvarchar(50) | dbo25.members.same_period_id |
| parent1 | nvarchar(50) | dbo25.parents.parent_id |
| factor1 | float | dbo25.parents.factor |
The function is used in the dbo25.xl_actions_create_standard_members procedure.
dbo25.get_translated_string
This function returns a company-related translated string.
| Parameter | DataType | Comment |
|---|---|---|
| Result | nvarchar(128) | xls.translations.TRANSLATED_NAME |
| @string | nvarchar(128) | xls.translations.COLUMN_NAME |
| @data_language | varchar(10) | xls.translations.LANGUAGE_NAME |
Underlying table: dbo25.translations
dbo25.get_year_members
This function returns a table of time members for the specified year.
| Parameter | DataType | Comment |
|---|---|---|
| @year | int | Year |
| Column | DataType | Comment |
|---|---|---|
| code | nvarchar(50) | dbo25.members.code |
| name | nvarchar(400) | dbo25.members.name |
| dimension_id | tinyint | dbo25.members.dimension_id |
| sort_order | int | dbo25.members.sort_order |
| calc_type_id | tinyint | dbo25.members.calc_type_id |
| row_color | tinyint | dbo25.members.row_color |
| previous_period | nvarchar(50) | dbo25.members.previous_period_id |
| same_period | nvarchar(50) | dbo25.members.same_period_id |
| parent1 | nvarchar(50) | dbo25.parents.parent_id |
| parent2 | nvarchar(50) | dbo25.parents.parent_id |
| parent3 | nvarchar(50) | dbo25.parents.parent_id |
The function is used in the xls25.xl_actions_add_year and xls25.xl_actions_delete_year procedures.