Planning Application Procedures
| Procedure | Description |
|---|---|
| dbo25.xl_actions_create_standard_forms | This procedure creates a set of standard forms. |
| dbo25.xl_actions_create_standard_members | This procedure creates standard dimension members. |
| dbo25.xl_actions_create_standard_tax_rates | This procedure creates a set of standard tax rates. |
| dbo25.xl_actions_create_standard_units | This procedure creates a set of standard units. |
| dbo25.xl_actions_set_doc_role_permissions | This procedure sets the permissions of user roles for the Database Help Framework. |
| dbo25.xl_actions_set_log_role_permissions | This procedure sets the permissions of user roles for the Change Tracking Framework. |
| dbo25.xl_actions_set_role_permissions | This procedure grants permissions to the planning application roles. |
| xls25.usp_axis_types | This procedure selects form axis types. |
| xls25.usp_calc_types | This procedure is an Excel form for editing calculation types. |
| xls25.usp_closed_periods | This procedure is an Excel form for editing closed periods. |
| xls25.usp_closed_periods_change | This procedure updates a database on cell changes of xls25.usp_closed_periods. |
| xls25.usp_companies | This procedure is a form of editing companies. |
| xls25.usp_companies_delete | This procedure deletes rows of xls25.usp_companies. |
| xls25.usp_companies_insert | This procedure inserts rows of xls25.usp_companies. |
| xls25.usp_companies_update | This procedure updates rows of xls25.usp_companies. |
| xls25.usp_currency_rates | This procedure is an Excel form for editing currency rates. |
| xls25.usp_currency_rates_change | This procedure updates a database on cell changes of xls25.usp_rates. |
| xls25.usp_data_management | This procedure is an Excel form for data management. |
| xls25.usp_dimensions | This procedure is an Excel form for editing dimensions. |
| xls25.usp_dimensions_change | This procedure checks user input on cell changes of xls25.usp_dimensions. |
| xls25.usp_dimensions_delete | This procedure deletes rows of xls25.usp_dimensions. |
| xls25.usp_dimensions_insert | This procedure inserts rows of xls25.usp_dimensions. |
| xls25.usp_dimensions_update | This procedure updates rows of xls25.usp_dimensions. |
| xls25.usp_facts | This procedure selects the calculated facts. |
| xls25.usp_facts_data | This procedure selects source cube data. |
| xls25.usp_facts_strings | This procedure selects source cube strings. |
| xls25.usp_form_dimensions | This procedure is an Excel form for editing form dimension properties. |
| xls25.usp_form_dimensions_delete | This procedure deletes rows of xls25.usp_form_dimensions. |
| xls25.usp_form_dimensions_insert | This procedure inserts rows of xls25.usp_form_dimensions. |
| xls25.usp_form_dimensions_update | This procedure updates rows of xls25.usp_form_dimensions. |
| xls25.usp_form_permissions | This procedure is an Excel form for editing form permissions. |
| xls25.usp_form_permissions_change | This procedure updates a database on cell changes of xls25.usp_form_permissions. |
| xls25.usp_form_rows | This procedure is an Excel form for editing form rowsets. |
| xls25.usp_form_rows_delete | This procedure deletes rows of xls25.usp_form_rows. |
| xls25.usp_form_rows_insert | This procedure inserts rows of xls25.usp_form_rows. |
| xls25.usp_form_rows_update | This procedure updates rows of xls25.usp_form_rows. |
| xls25.usp_forms | This procedure is an Excel form for editing a list of forms. |
| xls25.usp_forms_delete | This procedure deletes rows of xls25.usp_forms. |
| xls25.usp_forms_insert | This procedure inserts rows of xls25.usp_forms. |
| xls25.usp_forms_update | This procedure updates rows of xls25.usp_forms. |
| xls25.usp_member_permissions | This procedure is an Excel form for editing member permissions. |
| xls25.usp_member_permissions_change | This procedure updates a database on cell changes of xls25.usp_member_permissions. |
| xls25.usp_member_relations | This procedure is an Excel form for editing member relations. |
| xls25.usp_member_relations_change | This procedure updates a database on cell changes of xls25.usp_member_relations. |
| xls25.usp_members | This procedure is an Excel form for editing dimension members. |
| xls25.usp_members_delete | This procedure deletes rows of xls25.usp_members. |
| xls25.usp_members_insert | This procedure inserts rows of xls25.usp_members. |
| xls25.usp_members_update | This procedure updates rows of xls25.usp_members. |
| xls25.usp_name_formats | This procedure selects name formats. |
| xls25.usp_role_members | This procedure is a form for managing user roles. |
| xls25.usp_role_members_change | This procedure updates a role membership on cell changes of xls25.usp_role_members. |
| xls25.usp_rowsets | This procedure is an Excel form for editing rowset members. |
| xls25.usp_rowsets_delete | This procedure deletes rows of xls25.usp_rowsets. |
| xls25.usp_rowsets_insert | This procedure inserts rows of xls25.usp_rowsets. |
| xls25.usp_rowsets_update | This procedure updates rows of xls25.usp_rowsets. |
| xls25.usp_run_form | This procedure executes forms configured using dbo25.forms and dbo25.form_dimensions. |
| xls25.usp_run_form_change | This procedure updates a database on cell changes of xls25.usp_run_form. |
| xls25.usp_run_json_form | This procedure returns calculated cube data requested with JSON parameters. |
| xls25.usp_run_offline_form | This procedure executes forms configured using dbo25.forms and dbo25.form_dimensions. |
| xls25.usp_run_offline_form_delete | This procedure deletes rows of xls25.usp_run_offline_form. |
| xls25.usp_run_offline_form_insert | This procedure inserts rows of xls25.usp_run_offline_form. |
| xls25.usp_run_offline_form_update | This procedure updates rows of xls25.usp_run_offline_form. |
| xls25.usp_tax_rates | This procedure is an Excel form for editing tax rates. |
| xls25.usp_tax_rates_delete | This procedure deletes rows of xls25.usp_tax_rates. |
| xls25.usp_tax_rates_insert | This procedure inserts rows of xls25.usp_tax_rates. |
| xls25.usp_tax_rates_update | This procedure updates rows of xls25.usp_tax_rates. |
| xls25.usp_translations | This procedure is a form of editing company-related translations. |
| xls25.usp_translations_change | This procedure updates an element translation on cell changes of xls25.usp_translations. |
| xls25.usp_translations_common | This procedure is a form of editing application-level element translations. |
| xls25.usp_translations_xls | This procedure is a form of editing actual application-level element translations. |
| xls25.usp_translations_xls_change | This procedure updates an application element translation on cell changes of xls25.usp_translations_xls. |
| xls25.usp_units | This procedure is an Excel form for editing units. |
| xls25.usp_units_delete | This procedure deletes rows of xls25.usp_units. |
| xls25.usp_units_insert | This procedure inserts rows of xls25.usp_units. |
| xls25.usp_units_update | This procedure updates rows of xls25.usp_units. |
| xls25.usp_users | This procedure is a form of editing users. |
| xls25.usp_users_delete | This procedure deletes rows of xls25.usp_users. |
| xls25.usp_users_insert | This procedure inserts rows of xls25.usp_users. |
| xls25.usp_users_update | This procedure updates rows of xls25.usp_users. |
| xls25.xl_actions_add_language | This procedure adds a new language for company-related elements. |
| xls25.xl_actions_add_quarters | This procedure adds quarter members. |
| xls25.xl_actions_add_year | This procedure adds year members. |
| xls25.xl_actions_copy_data | This procedure copies data from a category to category. |
| xls25.xl_actions_delete_data | This procedure deletes source cube data from a category. |
| xls25.xl_actions_delete_year | This procedure deletes year members. |
| xls25.xl_actions_run_form_cell_data | This procedure selects underlying cube data for a reporting cell. |
| xls25.xl_actions_set_functional_currency | This procedure changes the system currency of the application. |
| xls25.xl_actions_update_facts | This procedure updates cube values after the currency rate changes. |
| xls25.xl_actions_update_hierarchies | This procedure updates the required tables after member changes. |
| xls25.xl_actions_update_member_permissions | This procedure updates member permissions after member changes. |
| xls25.xl_aliases_members | This procedure configures column sets of xls25.usp_members procedure. |
| xls25.xl_parameter_values_0_or_1 | This procedure selects 0 or 1 for Excel ribbon parameters. |
| xls25.xl_parameter_values_calc_type_id | This procedure selects calculation types for Excel ribbon parameters. |
| xls25.xl_parameter_values_calc_type_id_or_null | This procedure selects calculation types for Excel ribbon parameters. |
| xls25.xl_parameter_values_company_id | This procedure selects companies for Excel ribbon parameters. |
| xls25.xl_parameter_values_currency_id | This procedure selects currencies for Excel ribbon parameters. |
| xls25.xl_parameter_values_dimension_id | This procedure selects dimensions for Excel ribbon parameters. |
| xls25.xl_parameter_values_dimension_id_or_null | This procedure selects dimensions for Excel ribbon parameters. |
| xls25.xl_parameter_values_form_id | This procedure selects forms for Excel ribbon parameters. |
| xls25.xl_parameter_values_form_id_or_null | This procedure selects forms for Excel ribbon parameters. |
| xls25.xl_parameter_values_member_id_by_dimension_id | This procedure selects members for Excel ribbon parameters. |
| xls25.xl_parameter_values_member_id_dim1 | This procedure selects 1st dimension members for Excel ribbon parameters. |
| xls25.xl_parameter_values_member_id_dim2 | This procedure selects 2nd dimension members for Excel ribbon parameters. |
| xls25.xl_parameter_values_member_id_dim3 | This procedure selects 3rd dimension members for Excel ribbon parameters. |
| xls25.xl_parameter_values_member_id_dim4 | This procedure selects 4th dimension members for Excel ribbon parameters. |
| xls25.xl_parameter_values_member_id_dim5 | This procedure selects 5th dimension members for Excel ribbon parameters. |
| xls25.xl_parameter_values_member_id_dim6 | This procedure selects 6th dimension members for Excel ribbon parameters. |
| xls25.xl_parameter_values_member_id_dim7 | This procedure selects 7th dimension members for Excel ribbon parameters. |
| xls25.xl_parameter_values_relation_dimension_id | This procedure selects dimensions for Excel ribbon parameters. |
| xls25.xl_parameter_values_relation_partner_id | This procedure selects members for Excel ribbon parameters. |
| xls25.xl_parameter_values_root_member_id_code | This procedure selects possible root members for Excel ribbon parameters. |
| xls25.xl_parameter_values_rowset_id | This procedure selects rowsets for Excel ribbon parameters. |
| xls25.xl_parameter_values_rowset_id_or_null | This procedure selects rowsets for Excel ribbon parameters. |
| xls25.xl_parameter_values_run_form_p | This procedure selects values for the ribbon parameters of the configured forms. |
| xls25.xl_parameter_values_run_form_p1 | This procedure selects values for the 1st ribbon parameter of the configured forms. |
| xls25.xl_parameter_values_run_form_p2 | This procedure selects values for the 2nd ribbon parameter of the configured forms. |
| xls25.xl_parameter_values_run_form_p3 | This procedure selects values for the 3rd ribbon parameter of the configured forms. |
| xls25.xl_parameter_values_run_form_p4 | This procedure selects values for the 4th ribbon parameter of the configured forms. |
| xls25.xl_parameter_values_run_form_p5 | This procedure selects values for the 5th ribbon parameter of the configured forms. |
| xls25.xl_parameter_values_run_form_p6 | This procedure selects values for the 6th ribbon parameter of the configured forms. |
| xls25.xl_parameter_values_run_form_p7 | This procedure selects values for the 7th ribbon parameter of the configured forms. |
| xls25.xl_parameter_values_unit_id | This procedure selects units for Excel ribbon parameters. |
| xls25.xl_parameter_values_username | This procedure selects usernames for Excel ribbon parameters. |
| xls25.xl_validation_list_axis_type_id | This procedure selects axis types to use as an Excel validation list source. |
| xls25.xl_validation_list_calc_type_id | This procedure selects calculation types to use as an Excel validation list source. |
| xls25.xl_validation_list_calc_type_id_by_dimension_id | This procedure selects calculation types to use as an Excel validation list source. |
| xls25.xl_validation_list_default_member_id_code | This procedure selects possible default members to use as an Excel validation list source. |
| xls25.xl_validation_list_dimension_id | This procedure selects dimensions to use as an Excel validation list source. |
| xls25.xl_validation_list_member_id | This procedure selects members to use as an Excel validation list source. |
| xls25.xl_validation_list_member_id_code_by_dimension_id | This procedure selects members to use as an Excel validation list source. |
| xls25.xl_validation_list_member_id_code_by_rowset_id | This procedure selects members to use as an Excel validation list source. |
| xls25.xl_validation_list_name_format_id | This procedure selects name formats to use as an Excel validation list source. |
| xls25.xl_validation_list_previous_period_id_by_dimension_id | This procedure selects previous period members to use as an Excel validation list source. |
| xls25.xl_validation_list_root_member_id_code | This procedure selects possible root members to use as an Excel validation list source. |
| xls25.xl_validation_list_root_member_or_rowset_id_code | This procedure selects possible root members to use as an Excel validation list source. |
| xls25.xl_validation_list_rowset_id | This procedure selects rowsets to use as an Excel validation list source. |
| xls25.xl_validation_list_same_period_id_by_dimension_id | This procedure selects the same period members to use as an Excel validation list source. |
| xls25.xl_validation_list_tax_rate_id_by_dimension_id | This procedure selects tax rates to use as an Excel validation list source. |
| xls25.xl_validation_list_unit_id_by_dimension_id | This procedure selects units to use as an Excel validation list source. |
| xls25a.usp_update_table_format | This procedure updates Excel table formats of online dynamic forms. |
| xls25b.usp_update_table_format | This procedure updates Excel table formats of offline dynamic forms. |
dbo25.xl_actions_create_standard_forms
This procedure creates a set of standard forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @data_language | varchar(10) | IN | Context data language |
Use it to initialize settings for a new company.
dbo25.xl_actions_create_standard_members
This procedure creates standard dimension members.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @data_language | varchar(10) | IN | Context data language |
Use it to initialize the empty cube.
The procedure uses the dbo25.get_standard_members function to select standard members.
dbo25.xl_actions_create_standard_tax_rates
This procedure creates a set of standard tax rates.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @data_language | varchar(10) | IN | Context data language |
Use it to initialize settings for a new company.
dbo25.xl_actions_create_standard_units
This procedure creates a set of standard units.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @data_language | varchar(10) | IN | Context data language |
Use it to initialize settings for a new company.
dbo25.xl_actions_set_doc_role_permissions
This procedure sets the permissions of user roles for the Database Help Framework.
Execute this procedure after installation of the Database Help Framework.
dbo25.xl_actions_set_log_role_permissions
This procedure sets the permissions of user roles for the Change Tracking Framework.
Execute this procedure after installation of the Change Tracking Framework.
dbo25.xl_actions_set_role_permissions
This procedure grants permissions to the planning application roles.
Execute this procedure if you recreated any table of the dbo25 schema.
xls25.usp_axis_types
This procedure selects form axis types.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.axis_types
xls25.usp_calc_types
This procedure is an Excel form for editing calculation types.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.calc_types
xls25.usp_closed_periods
This procedure is an Excel form for editing closed periods.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.member_relations
Editing data requires the SaveToDB Enterprise edition.
Example:
xls25.usp_closed_periods_change
This procedure updates a database on cell changes of xls25.usp_closed_periods.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @column_name | nvarchar(128) | IN | dbo25.member_relations.category_id |
| @cell_number_value | int | IN | dbo25.member_relations.update_permission |
| @id | int | IN | dbo25.member_relations.member_id |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_companies
This procedure is a form of editing companies.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @data_language | varchar(10) | IN | Context data language |
Source table: dbo25.companies
xls25.usp_companies_delete
This procedure deletes rows of xls25.usp_companies.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.companies.id |
xls25.usp_companies_insert
This procedure inserts rows of xls25.usp_companies.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @code | nvarchar(50) | IN | dbo25.companies.code |
| @name | nvarchar(100) | IN | dbo25.companies.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @default_language | varchar(10) | IN | dbo25.companies.default_language |
| @sort_order | int | IN | dbo25.companies.sort_order |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_companies_update
This procedure updates rows of xls25.usp_companies.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.companies.id |
| @code | nvarchar(50) | IN | dbo25.companies.code |
| @name | nvarchar(100) | IN | dbo25.companies.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @default_language | varchar(10) | IN | dbo25.companies.default_language |
| @sort_order | int | IN | dbo25.companies.sort_order |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_currency_rates
This procedure is an Excel form for editing currency rates.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @base_currency_id | tinyint | IN | dbo25.units.id |
| @quote_currency_id | tinyint | IN | dbo25.units.id |
| @data_language | varchar(10) | IN | Context data language |
Use the xls25.xl_actions_update_facts procedure to recalculate facts after currency rate changes.
Underlying table: dbo25.rates
Editing data requires the SaveToDB Enterprise edition.
xls25.usp_currency_rates_change
This procedure updates a database on cell changes of xls25.usp_rates.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @column_name | nvarchar(128) | IN | dbo25.rates.category_id |
| @cell_number_value | float | IN | dbo25.rates.rate |
| @id | int | IN | dbo25.rates.time_id |
| @base_currency_id | tinyint | IN | dbo25.rates.base_currency_id |
| @quote_currency_id | tinyint | IN | dbo25.rates.quote_currency_id |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_data_management
This procedure is an Excel form for data management.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @data_language | varchar(10) | IN | Context data language |
Use the Excel context menu to delete and copy data.
Underlying table: dbo25.facts
Actions: xls25.xl_actions_copy_data, xls25.xl_actions_delete_data
Example:
xls25.usp_dimensions
This procedure is an Excel form for editing dimensions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.dimension_properties.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.dimensions
Example:
xls25.usp_dimensions_change
This procedure checks user input on cell changes of xls25.usp_dimensions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @column_name | nvarchar(255) | IN | Excel cell column name |
| @cell_value | nvarchar(255) | IN | Excel cell object value |
| @cell_number_value | float | IN | Excel cell number value |
| @cell_address | nvarchar(255) | IN | Excel cell address |
| @company_id | int | IN | dbo25.dimension_properties.company_id |
| @id | int | IN | dbo25.dimension_properties.id |
| @root_member_id | int | IN | dbo25.dimension_properties.root_member_id |
| @default_member_id | int | IN | dbo25.dimension_properties.default_member_id |
| @data_language | varchar(10) | IN | Context data language |
The procedure just checks the changes. It does not save any data.
xls25.usp_dimensions_delete
This procedure deletes rows of xls25.usp_dimensions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | tinyint | IN | dbo25.dimension_properties.id |
| @data_language | varchar(10) | IN | Context data language |
The procedure blocks deleting dimensions and raises an exception.
Use an SQL command to delete a dimension.
xls25.usp_dimensions_insert
This procedure inserts rows of xls25.usp_dimensions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.dimension_properties.company_id |
| @id | tinyint | IN | dbo25.dimension_properties.id |
| @code | nvarchar(50) | IN | dbo25.dimension_properties.code |
| @name | nvarchar(100) | IN | dbo25.dimension_properties.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @parameter_name | nvarchar(50) | IN | dbo25.dimension_properties.parameter_name |
| @translated_parameter_name | nvarchar(50) | IN | dbo25.translations.name |
| @sort_order | tinyint | IN | dbo25.dimension_properties.sort_order |
| @name_format_id | tinyint | IN | dbo25.dimension_properties.name_format_id |
| @root_member_id | int | IN | dbo25.dimension_properties.root_member_id |
| @default_member_id | int | IN | dbo25.dimension_properties.default_member_id |
| @is_protected | tinyint | IN | dbo25.dimension_properties.is_protected |
| @default_select_permission | tinyint | IN | dbo25.dimension_properties.default_select_permission |
| @default_update_permission | tinyint | IN | dbo25.dimension_properties.default_update_permission |
| @is_active | tinyint | IN | dbo25.dimension_properties.is_active |
| @data_language | varchar(10) | IN | Context data language |
The procedure blocks inserting dimensions and raises an exception.
Use an SQL command to insert a dimension.
However, note that you have to modify the application code also.
xls25.usp_dimensions_update
This procedure updates rows of xls25.usp_dimensions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.dimension_properties.company_id |
| @id | tinyint | IN | dbo25.dimension_properties.id |
| @code | nvarchar(50) | IN | dbo25.dimension_properties.code |
| @name | nvarchar(100) | IN | dbo25.dimension_properties.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @parameter_name | nvarchar(50) | IN | dbo25.dimension_properties.parameter_name |
| @translated_parameter_name | nvarchar(50) | IN | dbo25.translations.name |
| @sort_order | tinyint | IN | dbo25.dimension_properties.sort_order |
| @name_format_id | tinyint | IN | dbo25.dimension_properties.name_format_id |
| @root_member_id | int | IN | dbo25.dimension_properties.root_member_id |
| @default_member_id | int | IN | dbo25.dimension_properties.default_member_id |
| @is_protected | tinyint | IN | dbo25.dimension_properties.is_protected |
| @default_select_permission | tinyint | IN | dbo25.dimension_properties.default_select_permission |
| @default_update_permission | tinyint | IN | dbo25.dimension_properties.default_update_permission |
| @is_active | tinyint | IN | dbo25.dimension_properties.is_active |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_facts
This procedure selects the calculated facts.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @id1 | int | IN | dbo25.members.id |
| @id2 | int | IN | dbo25.members.id |
| @id3 | int | IN | dbo25.members.id |
| @id4 | int | IN | dbo25.members.id |
| @id5 | int | IN | dbo25.members.id |
| @id6 | int | IN | dbo25.members.id |
| @id7 | int | IN | dbo25.members.id |
| @unit_id | int | IN | dbo25.members.unit_id |
| @calc_type_id | int | IN | dbo25.members.calc_type_id |
| @data_language | varchar(10) | IN | Context data language |
This procedure selects the calculated cube values.
You may load the data into your BI tool, for example, PowerPivot.
xls25.usp_facts_data
This procedure selects source cube data.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @id1 | int | IN | dbo25.members.id |
| @id2 | int | IN | dbo25.members.id |
| @id3 | int | IN | dbo25.members.id |
| @id4 | int | IN | dbo25.members.id |
| @id5 | int | IN | dbo25.members.id |
| @id6 | int | IN | dbo25.members.id |
| @id7 | int | IN | dbo25.members.id |
| @unit_id | int | IN | dbo25.members.unit_id |
| @calc_type_id | int | IN | dbo25.members.calc_type_id |
| @data_language | varchar(10) | IN | Context data language |
Use this procedure to check and edit source cube values directly.
xls25.usp_facts_strings
This procedure selects source cube strings.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @id1 | int | IN | dbo25.members.id |
| @id2 | int | IN | dbo25.members.id |
| @id3 | int | IN | dbo25.members.id |
| @id4 | int | IN | dbo25.members.id |
| @id5 | int | IN | dbo25.members.id |
| @id6 | int | IN | dbo25.members.id |
| @id7 | int | IN | dbo25.members.id |
| @data_language | varchar(10) | IN | Context data language |
Use this procedure to check and edit source cube string values directly.
xls25.usp_form_dimensions
This procedure is an Excel form for editing form dimension properties.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.forms.company_id |
| @data_language | varchar(10) | IN | Context data language |
The form selects dbo25.forms cross dbo25.dimensions.
Underlying tables: dbo25.forms, dbo25.dimensions, dbo25.form_dimensions
Example:
xls25.usp_form_dimensions_delete
This procedure deletes rows of xls25.usp_form_dimensions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @dimension_id | tinyint | IN | dbo25.form_dimensions.dimension_id |
xls25.usp_form_dimensions_insert
This procedure inserts rows of xls25.usp_form_dimensions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @dimension_id | tinyint | IN | dbo25.form_dimensions.dimension_id |
| @axis_type_id | tinyint | IN | dbo25.form_dimensions.axis_type_id |
| @parameter_index | tinyint | IN | dbo25.form_dimensions.parameter_index |
| @header_order | tinyint | IN | dbo25.form_dimensions.header_order |
| @root_member_id | int | IN | dbo25.form_dimensions.root_member_id |
| @parameter_start_level | tinyint | IN | dbo25.form_dimensions.parameter_start_level |
| @parameter_end_level | tinyint | IN | dbo25.form_dimensions.parameter_end_level |
| @form_start_level | tinyint | IN | dbo25.form_dimensions.form_start_level |
| @form_end_level | tinyint | IN | dbo25.form_dimensions.form_end_level |
xls25.usp_form_dimensions_update
This procedure updates rows of xls25.usp_form_dimensions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @dimension_id | tinyint | IN | dbo25.form_dimensions.dimension_id |
| @axis_type_id | tinyint | IN | dbo25.form_dimensions.axis_type_id |
| @parameter_index | tinyint | IN | dbo25.form_dimensions.parameter_index |
| @header_order | tinyint | IN | dbo25.form_dimensions.header_order |
| @root_member_id | int | IN | dbo25.form_dimensions.root_member_id |
| @parameter_start_level | tinyint | IN | dbo25.form_dimensions.parameter_start_level |
| @parameter_end_level | tinyint | IN | dbo25.form_dimensions.parameter_end_level |
| @form_start_level | tinyint | IN | dbo25.form_dimensions.form_start_level |
| @form_end_level | tinyint | IN | dbo25.form_dimensions.form_end_level |
xls25.usp_form_permissions
This procedure is an Excel form for editing form permissions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.forms.company_id |
Underlying table: dbo25.form_permisssions
Editing data requires the SaveToDB Enterprise edition.
Example:
xls25.usp_form_permissions_change
This procedure updates a database on cell changes of xls25.usp_form_permissions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @column_name | nvarchar(128) | IN | dbo25.member_permissions.username |
| @cell_number_value | int | IN | 1 - select_permission = 1
0 - select_permission = 0 |
| @id | int | IN | dbo25.member_permissions.member_id |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_form_rows
This procedure is an Excel form for editing form rowsets.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.forms.company_id |
| @rowset_id | int | IN | dbo25.form_rows.rowset_id |
| @data_language | varchar(10) | IN | Context data language |
Note that you may create rowsets to use in rows and columns.
Underlying table: dbo25.form_rows
The following example shows configuring columns to compare budget vs. actuals:
xls25.usp_form_rows_delete
This procedure deletes rows of xls25.usp_form_rows.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.form_rows.id |
xls25.usp_form_rows_insert
This procedure inserts rows of xls25.usp_form_rows.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @rowset_id | int | IN | dbo25.form_rows.rowset_id |
| @rownum | int | IN | dbo25.form_rows.sort_order
@rownum is a predefined SaveToDB add-in parameter |
| @member_id | int | IN | dbo25.form_rows.member_id |
| @code | nvarchar(50) | IN | dbo25.form_rows.code |
| @name | nvarchar(400) | IN | dbo25.form_rows.name |
| @translated_name | nvarchar(400) | IN | dbo25.translations.name |
| @decimal_places | tinyint | IN | dbo25.form_rows.decimal_places |
| @is_percent | tinyint | IN | dbo25.form_rows.is_percent |
| @row_color | tinyint | IN | dbo25.form_rows.row_color |
| @row_bold | tinyint | IN | dbo25.form_rows.row_bold |
| @row_indent | tinyint | IN | dbo25.form_rows.row_indent |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_form_rows_update
This procedure updates rows of xls25.usp_form_rows.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.form_rows.id |
| @rowset_id | int | IN | dbo25.form_rows.rowset_id |
| @rownum | int | IN | dbo25.form_rows.sort_order
@rownum is a predefined SaveToDB add-in parameter |
| @member_id | int | IN | dbo25.form_rows.member_id |
| @code | nvarchar(50) | IN | dbo25.form_rows.code |
| @name | nvarchar(400) | IN | dbo25.form_rows.name |
| @translated_name | nvarchar(400) | IN | dbo25.translations.name |
| @decimal_places | tinyint | IN | dbo25.form_rows.decimal_places |
| @is_percent | tinyint | IN | dbo25.form_rows.is_percent |
| @row_color | tinyint | IN | dbo25.form_rows.row_color |
| @row_bold | tinyint | IN | dbo25.form_rows.row_bold |
| @row_indent | tinyint | IN | dbo25.form_rows.row_indent |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_forms
This procedure is an Excel form for editing a list of forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.forms.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.forms
Example:
xls25.usp_forms_delete
This procedure deletes rows of xls25.usp_forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.forms.id |
xls25.usp_forms_insert
This procedure inserts rows of xls25.usp_forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.forms.company_id |
| @code | nvarchar(50) | IN | dbo25.forms.code |
| @name | nvarchar(100) | IN | dbo25.forms.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @sort_order | int | IN | dbo25.forms.sort_order |
| @is_active | tinyint | IN | dbo25.forms.is_active |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_forms_update
This procedure updates rows of xls25.usp_forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.forms.id |
| @code | nvarchar(50) | IN | dbo25.forms.code |
| @name | nvarchar(100) | IN | dbo25.forms.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @sort_order | int | IN | dbo25.forms.sort_order |
| @is_active | tinyint | IN | dbo25.forms.is_active |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_member_permissions
This procedure is an Excel form for editing member permissions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | tinyint | IN | Dimension filter |
| @root_id | int | IN | Root member filter |
| @username | nvarchar(128) | IN | Username filter |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.member_permissions
Editing data requires the SaveToDB Enterprise edition.
Example:
Type "r", "w", or "d" to change permissions.
The application applies new permissions immediately after changes.
xls25.usp_member_permissions_change
This procedure updates a database on cell changes of xls25.usp_member_permissions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @column_name | nvarchar(128) | IN | dbo25.member_permissions.username |
| @cell_value | nvarchar(255) | IN | D - deny (select_permission = 0, update_permission = 0)
R - read (select_permission = 1, update_permission = 0) W - write (select_permission = 1, update_permission = 1) |
| @id | int | IN | dbo25.member_permissions.member_id |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_member_relations
This procedure is an Excel form for editing member relations.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | int | IN | Dimension filter |
| @root_id | int | IN | Root member filter |
| @partner_id | int | IN | Partner dimension filter |
| @field | nvarchar(50) | IN | update_permission, fixed value |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.member_relations
Editing data requires the SaveToDB Enterprise edition.
The example below shows the relations between accounts and regions:
xls25.usp_member_relations_change
This procedure updates a database on cell changes of xls25.usp_member_relations.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @column_name | nvarchar(128) | IN | dbo25.member_relations.partner_id |
| @cell_number_value | int | IN | dbo25.member_relations.update_permission
1 - update_permission = 1 0 - update_permission = 0 |
| @id | int | IN | dbo25.member_relations.member_id |
| @field | nvarchar(50) | IN | update_permission, fixed value |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_members
This procedure is an Excel form for editing dimension members.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | tinyint | IN | Dimension filter |
| @root_id | int | IN | Root member filter |
| @data_language | varchar(10) | IN | Context data language |
Use the Actions menu to add typical members.
After saving data click Actions, Update Hierarchies, then Reload, Reload Data and Configuration.
These actions update member hierarchies and reload new members into Microsoft Excel.
Underlying tables: dbo25.members, dbo25.parents
Actions: xls25.xl_actions_update_hierarchies
Example:
xls25.usp_members_delete
This procedure deletes rows of xls25.usp_members.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.members.id |
xls25.usp_members_insert
This procedure inserts rows of xls25.usp_members.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | tinyint | IN | dbo25.members.dimension_id |
| @code | nvarchar(50) | IN | dbo25.members.code |
| @name | nvarchar(400) | IN | dbo25.members.name |
| @translated_name | nvarchar(400) | IN | dbo25.translations.name |
| @comment | nvarchar(1000) | IN | dbo25.members.comment |
| @sort_order | int | IN | dbo25.members.sort_order |
| @tax_rate_id | tinyint | IN | dbo25.members.tax_rate_id |
| @unit_id | tinyint | IN | dbo25.members.unit_id |
| @calc_type_id | tinyint | IN | dbo25.members.calc_type_id |
| @previous_period_id | int | IN | dbo25.members.previous_period_id |
| @same_period_id | int | IN | dbo25.members.same_period_id |
| @decimal_places | tinyint | IN | dbo25.members.decimal_places |
| @is_percent | tinyint | IN | dbo25.members.is_percent |
| @row_color | tinyint | IN | dbo25.members.row_color |
| @row_bold | tinyint | IN | dbo25.members.row_bold |
| @row_indent | tinyint | IN | dbo25.members.row_indent |
| @show_line | tinyint | IN | dbo25.members.show_line |
| @show_line_before | tinyint | IN | dbo25.members.show_line_before |
| @show_line_after | tinyint | IN | dbo25.members.show_line_after |
| @is_active | tinyint | IN | dbo25.members.is_active |
| @excel_formula | nvarchar(400) | IN | dbo25.members.excel_formula |
| @parent1 | int | IN | dbo25.parents.parent_id |
| @parent2 | int | IN | dbo25.parents.parent_id |
| @parent3 | int | IN | dbo25.parents.parent_id |
| @parent4 | int | IN | dbo25.parents.parent_id |
| @parent5 | int | IN | dbo25.parents.parent_id |
| @parent6 | int | IN | dbo25.parents.parent_id |
| @parent7 | int | IN | dbo25.parents.parent_id |
| @factor1 | float | IN | dbo25.parents.factor |
| @factor2 | float | IN | dbo25.parents.factor |
| @factor3 | float | IN | dbo25.parents.factor |
| @factor4 | float | IN | dbo25.parents.factor |
| @factor5 | float | IN | dbo25.parents.factor |
| @factor6 | float | IN | dbo25.parents.factor |
| @factor7 | float | IN | dbo25.parents.factor |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_members_update
This procedure updates rows of xls25.usp_members.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.members.id, dbo25.parents.member_id |
| @code | nvarchar(50) | IN | dbo25.members.code |
| @name | nvarchar(400) | IN | dbo25.members.name |
| @translated_name | nvarchar(400) | IN | dbo25.translations.name |
| @comment | nvarchar(1000) | IN | dbo25.members.comment |
| @sort_order | int | IN | dbo25.members.sort_order |
| @tax_rate_id | tinyint | IN | dbo25.members.tax_rate_id |
| @unit_id | tinyint | IN | dbo25.members.unit_id |
| @calc_type_id | tinyint | IN | dbo25.members.calc_type_id |
| @previous_period_id | int | IN | dbo25.members.previous_period_id |
| @same_period_id | int | IN | dbo25.members.same_period_id |
| @decimal_places | tinyint | IN | dbo25.members.decimal_places |
| @is_percent | tinyint | IN | dbo25.members.is_percent |
| @row_color | tinyint | IN | dbo25.members.row_color |
| @row_bold | tinyint | IN | dbo25.members.row_bold |
| @row_indent | tinyint | IN | dbo25.members.row_indent |
| @show_line | tinyint | IN | dbo25.members.show_line |
| @show_line_before | tinyint | IN | dbo25.members.show_line_before |
| @show_line_after | tinyint | IN | dbo25.members.show_line_after |
| @is_active | tinyint | IN | dbo25.members.is_active |
| @excel_formula | nvarchar(400) | IN | dbo25.members.excel_formula |
| @parent1 | int | IN | dbo25.parents.parent_id |
| @parent2 | int | IN | dbo25.parents.parent_id |
| @parent3 | int | IN | dbo25.parents.parent_id |
| @parent4 | int | IN | dbo25.parents.parent_id |
| @parent5 | int | IN | dbo25.parents.parent_id |
| @parent6 | int | IN | dbo25.parents.parent_id |
| @parent7 | int | IN | dbo25.parents.parent_id |
| @factor1 | float | IN | dbo25.parents.factor |
| @factor2 | float | IN | dbo25.parents.factor |
| @factor3 | float | IN | dbo25.parents.factor |
| @factor4 | float | IN | dbo25.parents.factor |
| @factor5 | float | IN | dbo25.parents.factor |
| @factor6 | float | IN | dbo25.parents.factor |
| @factor7 | float | IN | dbo25.parents.factor |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_name_formats
This procedure selects name formats.
Underlying table: dbo25.name_formats
xls25.usp_role_members
This procedure is a form for managing user roles.
A user must have VIEW DEFINITION permissions to see users.
xls25.usp_role_members_change
This procedure updates a role membership on cell changes of xls25.usp_role_members.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @column_name | nvarchar(128) | IN | username |
| @cell_number_value | int | IN | 1 - include the user into a role
0 - exclude the user from the role |
| @name | nvarchar(128) | IN | role |
| @data_language | varchar(10) | IN | Context data language |
A user must have ALTER USER and ALTER ROLE permissions to change permissions.
xls25.usp_rowsets
This procedure is an Excel form for editing rowset members.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | tinyint | IN | Dimension filter |
| @data_language | varchar(10) | IN | Context data language |
The form shows members of the dbo25.members table with calc_type_id = 9 (rowset).
You may add new rowsets here.
Use the xls25.usp_form_rows procedure to edit rowset rows.
Underlying table: dbo25.members
The example below shows the rowsets of the time dimension that contains years only and quarters only:
We recommend adding the asterisk at the end of codes and names to distinguish rowsets from regular hierarchy members.
xls25.usp_rowsets_delete
This procedure deletes rows of xls25.usp_rowsets.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.members.id |
xls25.usp_rowsets_insert
This procedure inserts rows of xls25.usp_rowsets.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | tinyint | IN | dbo25.members.dimension_id |
| @code | nvarchar(50) | IN | dbo25.members.code |
| @name | nvarchar(100) | IN | dbo25.members.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @sort_order | int | IN | dbo25.members.sort_order |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_rowsets_update
This procedure updates rows of xls25.usp_rowsets.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.members.id |
| @code | nvarchar(50) | IN | dbo25.members.code |
| @name | nvarchar(100) | IN | dbo25.members.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @sort_order | int | IN | dbo25.members.sort_order |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_run_form
This procedure executes forms configured using dbo25.forms and dbo25.form_dimensions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.forms.company_id |
| @form_id | int | IN | dbo25.forms.id |
| @form_p1 | int | IN | dbo25.members.id of the 1st ribbon parameter |
| @form_p2 | int | IN | dbo25.members.id of the 2nd ribbon parameter |
| @form_p3 | int | IN | dbo25.members.id of the 3rd ribbon parameter |
| @form_p4 | int | IN | dbo25.members.id of the 4th ribbon parameter |
| @form_p5 | int | IN | dbo25.members.id of the 5th ribbon parameter |
| @form_p6 | int | IN | dbo25.members.id of the 6th ribbon parameter |
| @form_p7 | int | IN | dbo25.members.id of the 7th ribbon parameter |
| @data_language | varchar(10) | IN | Context data language |
This procedure is a form engine.
It returns the form layout configured using the dbo25.forms, dbo25.form_dimenstions, dbo25.form_rows, and dbo25.form_subtotals tables.
The form may have up to three dimensions in rows and up to three in columns.
Other dimensions must have member id values at the ribbon.
Ribbon parameters are dynamic and configured using dbo25.form_dimensions.
The Excel form has the cell change handler, xls25.usp_run_form_change, that updates underlying data.
This form requires the SaveToDB Enterprise edition.
You may use the offline form, xls25.usp_run_offline_form, with the SaveToDB Standard edition.
This is the most complicated procedure. If you need new features, you may contact us.
Example:
xls25.usp_run_form_change
This procedure updates a database on cell changes of xls25.usp_run_form.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @column_name | nvarchar(255) | IN | Excel cell column name.
Data column names contain dimension member codes separated by spaces. |
| @table_name | nvarchar(255) | IN | Active form database object name |
| @cell_value | nvarchar(255) | IN | Excel cell object value |
| @cell_number_value | float | IN | Excel cell number value |
| @cell_address | nvarchar(255) | IN | Excel cell address |
| @changed_cell_count | int | IN | Total number of changed cells |
| @changed_cell_index | int | IN | Cell index in the changed cells, starting 1.
The last cell has the index equal to @changed_cell_count. |
| @id | int | IN | dbo25.form_rows.id |
| @member_id | int | IN | dbo25.members.id of the 1st row dimension |
| @member_id2 | int | IN | dbo25.members.id of the 2nd row dimension |
| @member_id3 | int | IN | dbo25.members.id of the 3rd row dimension |
| @form_id | int | IN | dbo25.forms.id |
| @form_p1 | int | IN | dbo25.members.id of the 1st ribbon parameter |
| @form_p2 | int | IN | dbo25.members.id of the 2nd ribbon parameter |
| @form_p3 | int | IN | dbo25.members.id of the 3rd ribbon parameter |
| @form_p4 | int | IN | dbo25.members.id of the 4th ribbon parameter |
| @form_p5 | int | IN | dbo25.members.id of the 5th ribbon parameter |
| @form_p6 | int | IN | dbo25.members.id of the 6th ribbon parameter |
| @form_p7 | int | IN | dbo25.members.id of the 7th ribbon parameter |
| @quiet_mode | tinyint | IN | 0 - raise exceptions on errors
1 - return on errors without exceptions |
| @data_language | varchar(10) | IN | Context data language |
Note that this feature is available in the SaveToDB Enterprise edition only.
xls25.usp_run_json_form
This procedure returns calculated cube data requested with JSON parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.forms.company_id |
| @request | nvarchar(max) | IN | Form parameters in the JSON format. |
You may use this procedure to create web forms.
See usage examples in the procedure code.
xls25.usp_run_offline_form
This procedure executes forms configured using dbo25.forms and dbo25.form_dimensions.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.forms.company_id |
| @form_id | int | IN | dbo25.forms.id |
| @form_p1 | int | IN | dbo25.members.id of the 1st ribbon parameter |
| @form_p2 | int | IN | dbo25.members.id of the 2nd ribbon parameter |
| @form_p3 | int | IN | dbo25.members.id of the 3rd ribbon parameter |
| @form_p4 | int | IN | dbo25.members.id of the 4th ribbon parameter |
| @form_p5 | int | IN | dbo25.members.id of the 5th ribbon parameter |
| @form_p6 | int | IN | dbo25.members.id of the 6th ribbon parameter |
| @form_p7 | int | IN | dbo25.members.id of the 7th ribbon parameter |
| @data_language | varchar(10) | IN | Context data language |
This procedure is an offline form engine.
It calls xls25.usp_run_form internally and has the same output features.
However, it has a different saving configuration.
A user must click the Save button to save changes.
So, the user may edit data offline and save the changes when required.
Example:
xls25.usp_run_offline_form_delete
This procedure deletes rows of xls25.usp_run_offline_form.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.form_rows.id |
The procedure does nothing as users cannot delete the form rows.
xls25.usp_run_offline_form_insert
This procedure inserts rows of xls25.usp_run_offline_form.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.form_rows.id |
The procedure does nothing as users cannot add form rows.
xls25.usp_run_offline_form_update
This procedure updates rows of xls25.usp_run_offline_form.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @table_name | nvarchar(255) | IN | Active form database object name |
| @form_id | int | IN | dbo25.forms.id |
| @form_p1 | int | IN | dbo25.members.id of the 1st ribbon parameter |
| @form_p2 | int | IN | dbo25.members.id of the 2nd ribbon parameter |
| @form_p3 | int | IN | dbo25.members.id of the 3rd ribbon parameter |
| @form_p4 | int | IN | dbo25.members.id of the 4th ribbon parameter |
| @form_p5 | int | IN | dbo25.members.id of the 5th ribbon parameter |
| @form_p6 | int | IN | dbo25.members.id of the 6th ribbon parameter |
| @form_p7 | int | IN | dbo25.members.id of the 7th ribbon parameter |
| @member_id | int | IN | dbo25.members.id of the 1st row dimension |
| @member_id2 | int | IN | dbo25.members.id of the 2nd row dimension |
| @member_id3 | int | IN | dbo25.members.id of the 3rd row dimension |
| @json_columns | nvarchar(max) | IN | An array of column names in the JSON format |
| @json_values | nvarchar(max) | IN | An array of row values in the JSON format |
xls25.usp_tax_rates
This procedure is an Excel form for editing tax rates.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.tax_rates.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.tax_rates
xls25.usp_tax_rates_delete
This procedure deletes rows of xls25.usp_tax_rates.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.tax_rates.id |
xls25.usp_tax_rates_insert
This procedure inserts rows of xls25.usp_tax_rates.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @code | nvarchar(50) | IN | dbo25.tax_rates.code |
| @name | nvarchar(100) | IN | dbo25.tax_rates.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @sort_order | int | IN | dbo25.tax_rates.sort_order |
| @factor | float | IN | dbo25.tax_rates.factor |
| @is_active | bit | IN | dbo25.tax_rates.is_active |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_tax_rates_update
This procedure updates rows of xls25.usp_tax_rates.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.tax_rates.id |
| @code | nvarchar(50) | IN | dbo25.tax_rates.code |
| @name | nvarchar(100) | IN | dbo25.tax_rates.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @sort_order | int | IN | dbo25.tax_rates.sort_order |
| @factor | float | IN | dbo25.tax_rates.factor |
| @is_active | bit | IN | dbo25.tax_rates.is_active |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_translations
This procedure is a form of editing company-related translations.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.translations.company_id |
| @is_translatable | bit | IN | 1 - select translatable elements only
0 - select non-translatable elements |
| @is_complete | bit | IN | 1 - show values with complete translations
0 - show values with incomplete translations |
Source table: dbo25.translations
xls25.usp_translations_change
This procedure updates an element translation on cell changes of xls25.usp_translations.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.translations.company_id |
| @table_id | int | IN | dbo25.translations.table_id |
| @member_id | int | IN | dbo25.translations.member_id |
| @column_name | nvarchar(128) | IN | dbo25.translations.language |
| @cell_value | nvarchar(400) | IN | dbo25.translations.name |
| @cell_number_value | int | IN | The value for the is_translatable column in supported tables |
xls25.usp_translations_common
This procedure is a form of editing application-level element translations.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @is_complete | bit | IN | 1 - show values with complete translations
0 - show values with incomplete translations |
Source table: xls.translations
This procedure selects all elements available for translations.
xls25.usp_translations_xls
This procedure is a form of editing actual application-level element translations.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @field | nvarchar(128) | IN | TRANSLATED_NAME, TRANSLATED_DESC, or TRANSLATED_COMMENT |
| @schema | nvarchar(128) | IN | xls.translations.TABLE_SCHEMA |
| @is_complete | bit | IN | 1 - show values with complete translations
0 - show values with incomplete translations |
Source table: xls.translations
This procedure selects existing elements.
xls25.usp_translations_xls_change
This procedure updates an application element translation on cell changes of xls25.usp_translations_xls.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @column_name | nvarchar(128) | IN | xls.translations.LANGUAGE_NAME |
| @cell_value | nvarchar(max) | IN | A value for the specified field |
| @TABLE_SCHEMA | nvarchar(128) | IN | xls.translations.TABLE_SCHEMA |
| @TABLE_NAME | nvarchar(128) | IN | xls.translations.TABLE_NAME |
| @COLUMN | nvarchar(128) | IN | xls.translations.COLUMN_NAME |
| @field | nvarchar(128) | IN | TRANSLATED_NAME, TRANSLATED_DESC, or TRANSLATED_COMMENT |
| @data_language | varchar(10) | IN | xls.translations.LANGUAGE_NAME |
xls25.usp_units
This procedure is an Excel form for editing units.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.units.company_id |
| @data_language | varchar(10) | IN | Context data language |
Use the Excel context menu to change the system currency (the unit with id 0).
Underlying table: dbo25.units
Example:
xls25.usp_units_delete
This procedure deletes rows of xls25.usp_units.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.units.id |
xls25.usp_units_insert
This procedure inserts rows of xls25.usp_units.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @code | nvarchar(50) | IN | dbo25.units.code |
| @name | nvarchar(100) | IN | dbo25.units.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @sort_order | int | IN | dbo25.units.sort_order |
| @factor | float | IN | dbo25.units.factor |
| @is_currency | bit | IN | dbo25.units.is_currency |
| @is_functional_currency | bit | IN | dbo25.units.is_functional_currency |
| @is_active | bit | IN | dbo25.units.is_active |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_units_update
This procedure updates rows of xls25.usp_units.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.units.id |
| @code | nvarchar(50) | IN | dbo25.units.code |
| @name | nvarchar(100) | IN | dbo25.units.name |
| @translated_name | nvarchar(100) | IN | dbo25.translations.name |
| @sort_order | int | IN | dbo25.units.sort_order |
| @factor | float | IN | dbo25.units.factor |
| @is_currency | bit | IN | dbo25.units.is_currency |
| @is_functional_currency | bit | IN | dbo25.units.is_functional_currency |
| @is_active | bit | IN | dbo25.units.is_active |
| @data_language | varchar(10) | IN | Context data language |
xls25.usp_users
This procedure is a form of editing users.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.users.company_id |
Source table: dbo25.users
xls25.usp_users_delete
This procedure deletes rows of xls25.usp_users.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.users.company_id |
| @username | nvarchar(128) | IN | dbo25.users.username |
xls25.usp_users_insert
This procedure inserts rows of xls25.usp_users.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.users.company_id |
| @username | nvarchar(128) | IN | dbo25.users.username |
| @name | nvarchar(100) | IN | dbo25.users.name |
| @is_admin | bit | IN | dbo25.users.is_admin |
| @is_active | bit | IN | dbo25.users.is_active |
| @is_default | bit | IN | dbo25.users.is_default |
xls25.usp_users_update
This procedure updates rows of xls25.usp_users.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.users.company_id |
| @username | nvarchar(128) | IN | dbo25.users.username |
| @name | nvarchar(100) | IN | dbo25.users.name |
| @is_admin | bit | IN | dbo25.users.is_admin |
| @is_active | bit | IN | dbo25.users.is_active |
| @is_default | bit | IN | dbo25.users.is_default |
xls25.xl_actions_add_language
This procedure adds a new language for company-related elements.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @language | varchar(10) | IN | dbo25.translations.language |
Users may run this procedure from the Actions menu.
xls25.xl_actions_add_quarters
This procedure adds quarter members.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @year | int | IN | Year |
| @data_language | varchar(10) | IN | Context data language |
Use this procedure if you need only years and quarters but not months.
Target tables: dbo25.members, dbo25.parents
xls25.xl_actions_add_year
This procedure adds year members.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @year | int | IN | Year |
| @data_language | varchar(10) | IN | Context data language |
Use this procedure if you need years, quarters, and months.
Target tables: dbo25.members, dbo25.parents
xls25.xl_actions_copy_data
This procedure copies data from a category to category.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @code | nvarchar(50) | IN | Time dbo25.members.id |
| @source_category_code | nvarchar(50) | IN | Source category dbo25.members.id |
| @target_category_code | nvarchar(50) | IN | Target category dbo25.members.id |
| @set_1_to_copy | tinyint | IN | 1 - to confirm copying data |
| @data_language | varchar(10) | IN | Context data language |
For example, you may use this procedure to copy BUDGET data to FORECAST, or just create a copy of the budget data.
The procedure does not copy string data.
Target table: dbo25.facts
xls25.xl_actions_delete_data
This procedure deletes source cube data from a category.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @code | nvarchar(50) | IN | Time dbo25.members.id |
| @category_code | nvarchar(50) | IN | Category dbo25.members.id |
| @set_1_to_delete | tinyint | IN | 1 - to confirm deleting data |
| @data_language | varchar(10) | IN | Context data language |
Target tables: dbo25.facts, dbo25.strings
xls25.xl_actions_delete_year
This procedure deletes year members.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.companies.id |
| @year | int | IN | Year |
| @set_1_to_delete | tinyint | IN | 1 - to confirm deleting data |
| @data_language | varchar(10) | IN | Context data language |
Delete the cube data of the required year before deleting the members.
Target tables: dbo25.members, dbo25.parents
xls25.xl_actions_run_form_cell_data
This procedure selects underlying cube data for a reporting cell.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @column_name | nvarchar(255) | IN | Excel cell column name.
Data column names contain dimension member codes separated by spaces. |
| @table_name | nvarchar(255) | IN | Active form database object name |
| @member_id | int | IN | dbo25.members.id of the 1st row dimension |
| @member_id2 | int | IN | dbo25.members.id of the 2nd row dimension |
| @member_id3 | int | IN | dbo25.members.id of the 3rd row dimension |
| @form_id | int | IN | dbo25.forms.id |
| @form_p1 | int | IN | dbo25.members.id of the 1st ribbon parameter |
| @form_p2 | int | IN | dbo25.members.id of the 2nd ribbon parameter |
| @form_p3 | int | IN | dbo25.members.id of the 3rd ribbon parameter |
| @form_p4 | int | IN | dbo25.members.id of the 4th ribbon parameter |
| @form_p5 | int | IN | dbo25.members.id of the 5th ribbon parameter |
| @form_p6 | int | IN | dbo25.members.id of the 6th ribbon parameter |
| @form_p7 | int | IN | dbo25.members.id of the 7th ribbon parameter |
| @data_language | varchar(10) | IN | Context data language |
This procedure is used in the Excel context menu to drill-down cell values.
Underlying table: dbo25.facts
Output example:
xls25.xl_actions_set_functional_currency
This procedure changes the system currency of the application.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @id | int | IN | dbo25.units.id |
| @data_language | varchar(10) | IN | Context data language |
Target table: dbo25.units
xls25.xl_actions_update_facts
This procedure updates cube values after the currency rate changes.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
Target table: dbo25.facts
xls25.xl_actions_update_hierarchies
This procedure updates the required tables after member changes.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
Target tables: dbo25.hierarchies, dbo25.factors
xls25.xl_actions_update_member_permissions
This procedure updates member permissions after member changes.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
Target table: dbo25.member_permissions
xls25.xl_aliases_members
This procedure configures column sets of xls25.usp_members procedure.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @dimension_id | tinyint | IN | dbo25.members.dimension_id |
| @data_language | varchar(10) | IN | Context data language |
The SaveToDB add-in allows showing and hiding columns on ribbon parameter value changes.
This procedure selects column sets depending on dimension_id.
xls25.xl_parameter_values_0_or_1
This procedure selects 0 or 1 for Excel ribbon parameters.
Use this procedure in the xls.handlers table for parameters that accept 0 or 1 only.
You do not need to use for parameters with the bit datatype.
The SaveToDB add-in suggests 1 (yes) and 0 (no) values by default.
xls25.xl_parameter_values_calc_type_id
This procedure selects calculation types for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.calc_types
xls25.xl_parameter_values_calc_type_id_or_null
This procedure selects calculation types for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.calc_types
xls25.xl_parameter_values_company_id
This procedure selects companies for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.companies
xls25.xl_parameter_values_currency_id
This procedure selects currencies for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.units.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.units
xls25.xl_parameter_values_dimension_id
This procedure selects dimensions for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.dimension_properties.company_id |
Underlying table: dbo25.dimensions
xls25.xl_parameter_values_dimension_id_or_null
This procedure selects dimensions for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.dimension_properties.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.dimensions
xls25.xl_parameter_values_form_id
This procedure selects forms for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.forms.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.forms
xls25.xl_parameter_values_form_id_or_null
This procedure selects forms for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.forms.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.forms
xls25.xl_parameter_values_member_id_by_dimension_id
This procedure selects members for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | tinyint | IN | dbo25.members.dimension_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_member_id_dim1
This procedure selects 1st dimension members for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_member_id_dim2
This procedure selects 2nd dimension members for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_member_id_dim3
This procedure selects 3rd dimension members for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_member_id_dim4
This procedure selects 4th dimension members for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_member_id_dim5
This procedure selects 5th dimension members for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_member_id_dim6
This procedure selects 6th dimension members for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_member_id_dim7
This procedure selects 7th dimension members for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_relation_dimension_id
This procedure selects dimensions for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.dimension_properties.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.dimensions
xls25.xl_parameter_values_relation_partner_id
This procedure selects members for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.dimension_properties.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.dimensions
xls25.xl_parameter_values_root_member_id_code
This procedure selects possible root members for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | tinyint | IN | dbo25.members.dimension_id |
Underlying table: dbo25.members
xls25.xl_parameter_values_rowset_id
This procedure selects rowsets for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_rowset_id_or_null
This procedure selects rowsets for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_run_form_p
This procedure selects values for the ribbon parameters of the configured forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @parameter_index | int | IN | dbo25.form_dimensions.parameter_index |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_run_form_p1
This procedure selects values for the 1st ribbon parameter of the configured forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_run_form_p2
This procedure selects values for the 2nd ribbon parameter of the configured forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_run_form_p3
This procedure selects values for the 3rd ribbon parameter of the configured forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_run_form_p4
This procedure selects values for the 4th ribbon parameter of the configured forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_run_form_p5
This procedure selects values for the 5th ribbon parameter of the configured forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_run_form_p6
This procedure selects values for the 6th ribbon parameter of the configured forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_run_form_p7
This procedure selects values for the 7th ribbon parameter of the configured forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @form_id | int | IN | dbo25.form_dimensions.form_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_parameter_values_unit_id
This procedure selects units for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.units.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.units
xls25.xl_parameter_values_username
This procedure selects usernames for Excel ribbon parameters.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.users.company_id |
The procedure selects usernames of members of the planning_app_users role only.
To manage users, grant the VIEW DEFINITION permission. Other permissions are not required.
Underlying tables: sys.database_principals, sys.database_role_members
xls25.xl_validation_list_axis_type_id
This procedure selects axis types to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.axis_types
xls25.xl_validation_list_calc_type_id
This procedure selects calculation types to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.calc_types
xls25.xl_validation_list_calc_type_id_by_dimension_id
This procedure selects calculation types to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @dimension_id | tinyint | IN | dbo25.dimension_calc_types.dimension_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.calc_types
xls25.xl_validation_list_default_member_id_code
This procedure selects possible default members to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
Underlying table: dbo25.members
xls25.xl_validation_list_dimension_id
This procedure selects dimensions to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.dimension_properties.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.dimensions
xls25.xl_validation_list_member_id
This procedure selects members to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_validation_list_member_id_code_by_dimension_id
This procedure selects members to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | tinyint | IN | dbo25.members.dimension_id |
Underlying table: dbo25.members
xls25.xl_validation_list_member_id_code_by_rowset_id
This procedure selects members to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @rowset_id | int | IN | dbo25.members.id |
Underlying table: dbo25.members
xls25.xl_validation_list_name_format_id
This procedure selects name formats to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.name_formats
xls25.xl_validation_list_previous_period_id_by_dimension_id
This procedure selects previous period members to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | tinyint | IN | dbo25.members.dimension_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_validation_list_root_member_id_code
This procedure selects possible root members to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
Underlying table: dbo25.members
xls25.xl_validation_list_root_member_or_rowset_id_code
This procedure selects possible root members to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
Underlying table: dbo25.members
xls25.xl_validation_list_rowset_id
This procedure selects rowsets to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_validation_list_same_period_id_by_dimension_id
This procedure selects the same period members to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.members.company_id |
| @dimension_id | tinyint | IN | dbo25.members.dimension_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.members
xls25.xl_validation_list_tax_rate_id_by_dimension_id
This procedure selects tax rates to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.tax_rates.company_id |
| @dimension_id | tinyint | IN | dbo25.members.dimension_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.tax_rates
xls25.xl_validation_list_unit_id_by_dimension_id
This procedure selects units to use as an Excel validation list source.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @company_id | int | IN | dbo25.units.company_id |
| @dimension_id | tinyint | IN | dbo25.members.dimension_id |
| @data_language | varchar(10) | IN | Context data language |
Underlying table: dbo25.units
xls25a.usp_update_table_format
This procedure updates Excel table formats of online dynamic forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @schema | nvarchar(128) | IN | |
| @name | nvarchar(128) | IN | |
| @ExcelFormatXML | xml | IN |
Underlying table: dbo25.formats
Analysts and developers may use the Save Table Format menu item to save formats.
Users may use the Load Table Format menu item to load formats.
xls25b.usp_update_table_format
This procedure updates Excel table formats of offline dynamic forms.
| Parameter | DataType | Mode | Comment |
|---|---|---|---|
| @schema | nvarchar(128) | IN | |
| @name | nvarchar(128) | IN | |
| @ExcelFormatXML | xml | IN |
Underlying table: dbo25.formats
Analysts and developers may use the Save Table Format menu item to save formats.
Users may use the Load Table Format menu item to load formats.