160389, 158695, 79337, 75118
You may encounter customer requests for proprietary information around the BM software Database Schema, workings, and API. This table explains what information is available and what is required.
| Product | DB Schema | API |
| SedonaOffice | Limited / Requires NDA | Publicly Available/ Req License |
| AlarmBiller | Not Publicly Available | Not Publicly Available |
| Managely | Not Publicly Available | Not Publicly Available |
If a customer requests information in order to newly integrate or enhance AlarmBill or Managely, these requests should be filled out with the specific integration/request in the Steps to Reproduce, Case Categories properly set, and moved to Triage for assignment to Product Management for further review.
If the customer has a specific question around their database that can be directly asked of Development. Detail the specific ask with screenshots, the pertinent information such as API call or query, and what they are looking to achieve in the steps to reproduce. This case will also be fielded through Triage but as a question to Development.
For SedonaOffice the following SQL query may help in finding useful table information e.g (length, constraints, datatype, etc):
NOTE: Any custom datawork or inquiries around this information would need to be scoped through an Account Manager for a billable project.
SELECT
DB_NAME() AS [Sedona_Security],
OBJECT_SCHEMA_NAME(TBL.[object_id],DB_ID()) AS [Schema],
TBL.[name] AS [Table name],
AC.[name] AS [Column name],
UPPER(TY.[name]) AS DataType,
AC.[max_length] AS [Length],
AC.[precision],
AC.[scale],
AC.[is_nullable] AS IsNullable,
ISNULL(SI.is_primary_key,0) AS IsPrimaryKey,
SKC.name as [Primary Key Constarint],
(CASE WHEN SIC.index_column_id > 0 THEN 1 ELSE 0 END) AS IsIndexed,
ISNULL(is_included_column, 0) AS IsIncludedIndex,
SI.name AS [Index Name],
OBJECT_NAME(SFC.constraint_object_id) as [Foreign Key Constraint],
OBJECT_NAME(SFC.referenced_object_id) as [Parent Table],
SDC.name AS [Default Constraint],
SEP.value AS Comments
FROM sys.tables AS TBL
INNER JOIN sys.all_columns AC ON TBL.[object_id] = AC.[object_id]
INNER JOIN sys.types TY ON AC.[system_type_id] = TY.[system_type_id] AND AC.[user_type_id] = TY.[user_type_id]
LEFT JOIN sys.index_columns SIC on sic.object_id = TBL.object_id AND AC.column_id = SIC.column_id
LEFT JOIN sys.indexes SI on SI.object_id = TBL.object_id AND SIC.index_id = SI.index_id
LEFT JOIN sys.foreign_key_columns SFC on SFC.parent_object_id = TBL.object_id AND SFC.parent_column_id = AC.column_id
LEFT JOIN sys.key_constraints SKC on skc.parent_object_id = TBL.object_id AND SIC.index_column_id = SKC.unique_index_id
LEFT JOIN sys.default_constraints SDC on SDC.parent_column_id = AC.column_id
LEFT JOIN sys.extended_properties SEP on SEP.major_id = TBL.object_id AND SEP.minor_id = AC.column_id
ORDER BY TBL.[name], AC.[column_id]
If the customer would like documentation on proprietary systems or wants to coordinate time with a Development resource. Document as much of their request and the case should be moved to Sales to have their Account Manager follow up scoping their request as needed.
Verbiage that can be sent for these type of requests around propietary systems or Development consulting time is below.
**Be sure to update or remove the cusomer Swagger API URL line if they do not already have a SedonaWeb2.0/API site.
Good Morning {!Contact.FirstName} ,
Thank you for your interest in leveraging our platform for your internal development of custom integrations and reporting.
We do offer API Swagger access and recommend using that documentation as the primary and supported method for integrating with your Sedona Data platform provided you are utilizing a licensed setup of SedonaAPI 2.0. This ensures stability, security, and compatibility with future updates and is kept up to date with the version of the API you are running.
You can find the Swagger information from your specific site spec at https://REPLACEWITHCUSTOMERAPIURL/api/help/index.html
We keep our test environment on the latest version of SedonaOffice and API and the Swagger information, while largely unchanged, can be viewed here: https://sedonacloudtest.com/api/help/index.html
Requests for direct database schema or data dictionary information involve proprietary system details and are not publicly distributed. Access to this information requires a signed Non-Disclosure Agreement (NDA).
The next step is to move this case to our Sales queue in order to connect you with your Account Manager, who can assist with initiating the NDA process. Once the NDA is completed, you can be provided with the most recent available documentation.
Please note that the available version of Database Structure may not reflect all recent changes, so it should be used as a general reference rather than a definitive source. If there are specific asks of stored procedures and tables, those can also be fielded as Development requests. If your team would rather scope a project to discuss with a Developer directly, that can also be reviewed with your Account Manager.
Regards,
BoldGroup Support
Phone: (719) 593-2829 Fax: (719) 213-2502
4050 Lee Vance Drive, Suite 250. Colorado Springs, CO 80918
Need help with your software? Start with your Product Knowledge Base for articles, videos, training, setup guides, eLearning, and release notes.
|
