Planning Application Functions

Planning Application Functions

FunctionDescription
dbo25.get_json_array_valuesThis function returns a table of array values from the JSON string.
dbo25.get_json_object_valuesThis function returns a table of name-value pairs from the JSON string.
dbo25.get_quarter_membersThis function returns a table of quarter members for the specified year.
dbo25.get_standard_membersThis function returns a table of standard members to initialize the application.
dbo25.get_translated_stringThis function returns a company-related translated string.
dbo25.get_year_membersThis 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.

ParameterDataTypeComment
@cnvarchar(max)JSON array
ColumnDataTypeComment
idintValue index
valuenvarchar(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.

ParameterDataTypeComment
@cnvarchar(max)JSON object
ColumnDataTypeComment
namenvarchar(100)Property name
valuenvarchar(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.

ParameterDataTypeComment
@yearintYear
ColumnDataTypeComment
codenvarchar(50)dbo25.members.code
namenvarchar(400)dbo25.members.name
dimension_idtinyintdbo25.members.dimension_id
sort_orderintdbo25.members.sort_order
calc_type_idtinyintdbo25.members.calc_type_id
row_colortinyintdbo25.members.row_color
previous_periodnvarchar(50)dbo25.members.previous_period_id
same_periodnvarchar(50)dbo25.members.same_period_id
parent1nvarchar(50)dbo25.parents.parent_id
parent2nvarchar(50)dbo25.parents.parent_id
parent3nvarchar(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.

ColumnDataTypeComment
codenvarchar(50)dbo25.members.code
namenvarchar(400)dbo25.members.name
dimension_idtinyintdbo25.members.dimension_id
sort_orderintdbo25.members.sort_order
calc_type_idtinyintdbo25.members.calc_type_id
row_colortinyintdbo25.members.row_color
previous_periodnvarchar(50)dbo25.members.previous_period_id
same_periodnvarchar(50)dbo25.members.same_period_id
parent1nvarchar(50)dbo25.parents.parent_id
factor1floatdbo25.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.

ParameterDataTypeComment
Resultnvarchar(128)xls.translations.TRANSLATED_NAME
@stringnvarchar(128)xls.translations.COLUMN_NAME
@data_languagechar(2)xls.translations.LANGUAGE_NAME

Underlying table: dbo25.translations

dbo25.get_year_members

This function returns a table of time members for the specified year.

ParameterDataTypeComment
@yearintYear
ColumnDataTypeComment
codenvarchar(50)dbo25.members.code
namenvarchar(400)dbo25.members.name
dimension_idtinyintdbo25.members.dimension_id
sort_orderintdbo25.members.sort_order
calc_type_idtinyintdbo25.members.calc_type_id
row_colortinyintdbo25.members.row_color
previous_periodnvarchar(50)dbo25.members.previous_period_id
same_periodnvarchar(50)dbo25.members.same_period_id
parent1nvarchar(50)dbo25.parents.parent_id
parent2nvarchar(50)dbo25.parents.parent_id
parent3nvarchar(50)dbo25.parents.parent_id

The function is used in the xls25.xl_actions_add_year and xls25.xl_actions_delete_year procedures.