How to Host HTML documentation on SharePoint
Jan 30th, 2023,
Sharing data model documentation is vital for organizations looking to maintain consistency and accuracy in their data management. Data models provide a clear representation of the structure and relationships within databases, making it easier for stakeholders to understand and utilize data effectively. ERBuilder is a valuable data modeling tool that enables users to create and visualize data models and generate HTML documentation.
By hosting HTML documentation generated by ERBuilder on SharePoint, organizations can effortlessly share and collaborate on data models with stakeholders.
In this blog post, we will outline the steps to create a site and host the HTML documentation on SharePoint.
What is SharePoint
SharePoint is a Microsoft-developed web-based platform that provides collaboration and content management capabilities. It helps organizations to manage their information, data, and documents in a central location. It offers features such as website creation, document libraries, lists, version control, access permissions, search, and content management, and can integrate with other Microsoft tools like Office 365. This makes SharePoint a widely used platform for enterprise collaboration and information management.
Step 1: Exporting Data Model Documentation from ERBuilder
First, to export the HTML documentation from ERBuilder, you can either open an existing ER diagram in the software or create a new project by reverse-engineering your database.
Next, navigate to the "Tools" menu and select "Generate model documentation".
After that, select "HTML" as the export format, and finally, choose a location to save the exported files.
This will generate your documentation a set of HTML files.
Step 2: Creating a SharePoint Site
Once you exported the HTML documentation, the next step is to create a SharePoint site.
This can be done by logging in to SharePoint and then navigating to the "create site" menu. From there, follow the provided steps to create the site.
Step 3: Allowing Frame Insertions from Your Domain
In order to insert the HTML documentation generated by ERBuilder into a web part on your SharePoint site, you will need to allow frame insertions from your domain. This is a security measure to prevent cross-site scripting (XSS) attacks.
To do this, you will need to add your domain to the list of Trusted Sites in SharePoint.
To add your domain to the list of Trusted Sites, first navigate to the “Site Contents”, to do so click on the cogwheel located in the top right corner, then select "Site Contents".
After that, click the "Site Settings" button located on the right side.
In the Site Settings, select "HTML Field Security".
If contributions are already being allowed from any domain, there's no need to make any changes.
However, if contributions are not allowed from the domain where your ERBuilder documentation is hosted, choose the third option.
Enter the domain in the appropriate field, click "Add", and then confirm the changes by clicking the "OK" button.
Step 4: Embedding the HTML Documentation
The way to host HTML documentation on SharePoint is to embed it as a webpart on a SharePoint page.
This way, users don't have to leave the SharePoint site to view the documentation.
To embed the HTML documentation, click the "Add" button in the center of the box and choose the "Embed" option.
In the right panel, you can paste either the page address or the embed code. As an example, past the following embed code into the window:
<iframe src="https://soft-builder.com/en/docs/SamplesDocs/ERBuilderDocumentation" width="100%" height="700"></iframe>
By hosting HTML documentation generated by ERBuilder on SharePoint, organizations can enhance their data model collaboration and accessibility.
The steps outlined in this blog post guide organizations through the process of exporting data models documentation from ERBuilder, uploading it to SharePoint, and sharing it with stakeholders. Additionally, the option to embed the HTML documentation on a SharePoint page increases its accessibility for stakeholders without the need for them to navigate away from the SharePoint site.
How ERBuilder Helps
ERBuilder is a GUI data modeling tool that allows you to visualize, design, and model databases by using entity relationship diagrams and automatically generates the most popular SQL databases. Generate and share the data Model documentation with your team. Optimize your data model by using advanced features such as test data generation, schema comparison, and schema synchronization.
Read more related posts
Subscribe To Our Newsletter
Subscribe to our email newsletter today to receive updates of the latest news, tutorials and special offers!