XLCubed is now FluenceXL. The new wiki can be found here: https://help.fluencexl.com/

Difference between revisions of "SQL Repository/Version 9"

(Active Directory Based)
 
(6 intermediate revisions by 3 users not shown)
Line 22: Line 22:
 
The security model can be based on roles or Active Directory groups.
 
The security model can be based on roles or Active Directory groups.
  
====Role based====
+
====Role based - Recommended ====
  
 
Active-directory groups and users are assigned to Roles - these roles are then assigned permissions to reports/functionality. This has the advantage that no Active Directory import is required.
 
Active-directory groups and users are assigned to Roles - these roles are then assigned permissions to reports/functionality. This has the advantage that no Active Directory import is required.
Line 87: Line 87:
 
===Role Based===
 
===Role Based===
  
# Using SQL Server Management Studio, you should now add a Login for the XLCubed application pool user (if the default XLCubed application pool is used with the ''Application Pool Identity'', then you can use {{Code|IIS AppPool\XLCubed}} as the Windows Authentication login name)
+
# Using SQL Server Management Studio, you should now add a Login for the XLCubed application pool user (if the default XLCubed application pool is used with the ''Application Pool Identity'', then you can use {{Code|IIS AppPool\XLCubed}} as the Windows Authentication login name - see [[Creating default IIS application pool user in SQL]])
 
# On the {{Menu|User Mappings}} screen map that user to the {{Code|XLCUBED_USER}} role
 
# On the {{Menu|User Mappings}} screen map that user to the {{Code|XLCUBED_USER}} role
 
# If any users should be able to administer the repository (see [[#Administration|below]]), map those users to the {{Code|XLCUBED_ADMIN}} role
 
# If any users should be able to administer the repository (see [[#Administration|below]]), map those users to the {{Code|XLCUBED_ADMIN}} role
Line 95: Line 95:
 
[[File:SQLRepositoryrole.png]]
 
[[File:SQLRepositoryrole.png]]
  
 +
===Active Directory Based===
  
===Active Directory Based===
+
''NB. We would always recommend Role-based setup''
  
 
You will now need to import the active directory users:
 
You will now need to import the active directory users:
Line 111: Line 112:
 
# Define which users will have "Root" folder access to create new folders and to manage permissions from in Excel, Select {{Menu|Admin|Folder Permissions}}: [[File:SQLRepositoryRootAccess.png|frame|center|Select SYS Reports Root Folder - for the standard report publication area or the required item for connections, templates etc.]]
 
# Define which users will have "Root" folder access to create new folders and to manage permissions from in Excel, Select {{Menu|Admin|Folder Permissions}}: [[File:SQLRepositoryRootAccess.png|frame|center|Select SYS Reports Root Folder - for the standard report publication area or the required item for connections, templates etc.]]
  
 +
===Hybrid Mode===
  
===Hybrid Mode===
+
# Using SQL Server Management Studio, you should now add a Login for the XLCubed application pool user (if the default XLCubed application pool is used with the ''Application Pool Identity'', then you can use {{Code|IIS AppPool\XLCubed}} as the Windows Authentication login name - see [[Creating default IIS application pool user in SQL]])
 +
# On the {{Menu|User Mappings}} screen map that user to the {{Code|XLCUBED_USER}} role
 +
# If any users should be able to administer the repository (see [[#Administration|below]]), map those users to the {{Code|XLCUBED_ADMIN}} role
  
 
If the file system is your chosen location for storing the reports, then no further configuration is necessary.
 
If the file system is your chosen location for storing the reports, then no further configuration is necessary.
Line 126: Line 130:
 
==Scheduling==
 
==Scheduling==
 
If [[Scheduling]] is desired, a few additional steps are required to use it with the SQL Repository. The [[Scheduling Installation with the SQL Repository]] page has full details.
 
If [[Scheduling]] is desired, a few additional steps are required to use it with the SQL Repository. The [[Scheduling Installation with the SQL Repository]] page has full details.
 
==Administration==
 
There are two applications that can be used to administer the SQL repository:
 
* Configure XLCubed Web Edition (included in the XLCubed Web Edition setup, and installed on the server's start menu)
 
* Administer XLCubed Web Edition Repository (optionally installed separately on any machine)
 
 
Either of these will allow you to:
 
* Administer users, including giving them access to the XLCubed Web application, allow and deny them access to the repository, their personal folders, scheduling and scheduling distribution groups
 
* Administer custom groups, including adding and removing users. You may also designate a group for XLCubed web access, as mentioned above
 
* Control folder access and permissions
 
* Control startup reports for users and groups
 
* Manage SMTP servers for scheduling
 
* View logs
 
 
New in [[Version 9.1]]:
 
* Set folders to be hidden, this allows them to be linked to but not selected by the user
 
* Set folder colors, the folders will appear with the chosen colors in the repository view
 
 
==Using Domain Users and Groups==
 
See [[Using Domain Users and Groups with the SQL Repository]] for details of how to import and use Domain users and groups.
 
 
==Operational Reporting==
 
The installation provides an operational reporting dashboard as shown below:
 
 
[[Image:zxzx.png|350px|centre]]
 
 
The Excel file can be accessed through the "XLCubed Administration Reports" start menu shortcut, or directly in the \Reports folder within the XLCubed Web Website. Additional operational reports can be built using the oData datasource provided with XLCubed Web (accessed through Grids & Tables - Other Sources).
 
 
The report will run against the last XLCubedWeb server connected to in the "Publishing" screen.
 
 
You can enable at a group or user level who has access to these reports:
 
 
[[Image:UserSystemDashboardPermission.png|centre]]
 
 
==Import and Export of Reports==
 
Moving reports between repositories is no longer a case of copying files between file system folders. In order to provide a mechanism for this, XLCubed Excel Edition has two menu items, which can be found on the {{Menu|XLCubed Ribbon|Extras}} menu:
 
 
[[Image:ImportExportItemsMenu.png|centre]]
 
 
Note that these options will only be available to users who have the {{Menu|Can bulk import and export reports}} permission configured, as described [[#Administration|above]].
 
 
===Exporting Items===
 
When you select the {{Menu|XLCubed Ribbon|Extras|Export Items from Web...}} menu item, the {{Menu|Export Items}} form appears. Once you connect to the web server, the list of folders and reports available to you appears in the form:
 
 
[[Image:ExportItemsForm.png|centre]]
 
 
Select any items that need to be exported and click {{Menu|OK}} to save the folders and files as a repository archive file.
 
 
===Importing Items===
 
When you select the {{Menu|XLCubed Ribbon|Extras|Import Items into Web...}} menu item, the {{Menu|Import Items}} form appears. Connect to the web server, then select the repository archive file created [[#Exporting Items|above]]. The selected items are imported into the repository in the same folder location they were exported from, but on the current web server.
 
  
 
==See Also==
 
==See Also==
 +
* [[SQL Repository Administration]]
 
* [[Scheduling with the SQL Repository]]
 
* [[Scheduling with the SQL Repository]]
* [[Using Domain Users and Groups with SQL Repository]]
+
* [[Using Domain Users and Groups with the SQL Repository]]
 
* [[Running the Scheduling Service in non-Service mode]]
 
* [[Running the Scheduling Service in non-Service mode]]
  
 
[[Category:Web Edition]]
 
[[Category:Web Edition]]
 
[[Category:Installation]]
 
[[Category:Installation]]

Latest revision as of 08:36, 6 June 2023



XLCubed Web Enterprise Edition can run in conjunction with a SQL Database, this gives various options to provide different functionality for Excel and Web-based users.


Modes

There are several options when you first setup XLCubedWeb and have access to SQL Server to run a SQL Database.

Full Sql Database

Everything is stored in the SQL Database, this gives you access to the following features:

  • Excel-based dialogs for controlling permissions and access to reports and folders
  • full version history of published items, as well as locking the live version
  • logging of report accesses, including rendering times for usage and performance monitoring
  • Extended options around integrating with existing "Forms Authentication" websites
  • Operational reporting - report usage, user activity etc.
  • Report commentary

The security model can be based on roles or Active Directory groups.

Role based - Recommended

Active-directory groups and users are assigned to Roles - these roles are then assigned permissions to reports/functionality. This has the advantage that no Active Directory import is required.

Rolesql.png

Active Directory based

Active directory import needs to be run and configured, but no further maintenance is needed. Permissions can be assigned directly to Active-directory groups and users so closely matches a file-based repository.

Adsql.png

Hybrid SQL Database

Only report usage and commentary is stored in the database, this gives you access to the following features:

  • Report commentary
  • Logging of report accesses, including rendering times for usage and performance monitoring
  • Operational reporting - report usage, user activity etc.

The reports can be stored in either the file-system or SharePoint

File-based reports

Excel users connect to XLCubedWeb to publish and the reports are stored in the file system - permissions are applied using standard NTFS security.

Ntfssql.png

SharePoint-based reports

Excel users connect to SharePoint to publish - permissions are applied in SharePoint. Reports are available and viewed in SharePoint, mobile users connect to XLCubedWeb which presents the SharePoint published reports.

Sharepointsql.png


In addition to these features, the SQL Repository feature also enhances the following:

  • scheduling: this is also accessible from Excel, and features an easier to use interface as well as integrated run history
  • error logging: available from a dedicated server administration application, this can be used on any machine and user that has server access

Installation

Regardless of the mode you run in the follow needs to be done initially:

  • You must be running SQL Server 2008 or above, any edition is fine and it can be run on a different server to XLCubedWeb without any changes to the setup process
  • Create a blank SQL Server database, and grant full access to it for the user doing the installation:
SQLRepository1.png
    • Set the "Recovery Mode" to "Simple"
    • Ensure the database is set to a case-insensitive locale and that the default locale for the server isn't case-sensitive
  • On the XLCubed Web Edition server, run the Configure XLCubed Web Edition application
  • Select the appropriate Web Edition instance (this will usually be done for you)
  • Switch to the Sql Repository tab:
SQLRepository2v9.png
  • Select the Use SQL for XLCubed Repository box
  • Enter the server and database names for the previously created blank database, and click Connect .
  • The application will ask you if you want to populate the database. Click Yes :
SQLRepository3.png
  • Select the mode to run in:
SQLRepositorymode.png

Then follow the rest of the setup for the mode you select.


Role Based

  1. Using SQL Server Management Studio, you should now add a Login for the XLCubed application pool user (if the default XLCubed application pool is used with the Application Pool Identity, then you can use IIS AppPool\XLCubed as the Windows Authentication login name - see Creating default IIS application pool user in SQL)
  2. On the User Mappings screen map that user to the XLCUBED_USER role
  3. If any users should be able to administer the repository (see below), map those users to the XLCUBED_ADMIN role

No other setup is required, by default "Everyone" is granted access to the default role. You can edit and add additional roles in the Admin Application:

SQLRepositoryrole.png

Active Directory Based

NB. We would always recommend Role-based setup

You will now need to import the active directory users:

  1. Check the Domain name and click the Load Domain Information button to load the users and groups from the domain, or see below for advanced options
  2. If desired, click the Import Repository button and enter the path to import an existing file system repository. Existing permissions will be transferred wherever possible but this should be verified once the system is available again as an initial test.
  3. Using SQL Server Management Studio, you should now add a Login for the XLCubed application pool user (if the default XLCubed application pool is used with the Application Pool Identity, then you can use IIS AppPool\XLCubed as the Windows Authentication login name)
  4. On the User Mappings screen map that user to the XLCUBED_USER role
  5. If any users should be able to administer the repository (see below), map those users to the XLCUBED_ADMIN role
  6. If you need to restrict access to XLCubedWeb:
    • In the Configure XLCubed Web Edition application, click the Administration button
    • Select the Admin > System Settings menu item
    • Select the group that should be allowed access to the Web Edition then click the Save toolbar button:
      SQLRepository4.png
  7. Define which users will have "Root" folder access to create new folders and to manage permissions from in Excel, Select Admin > Folder Permissions:
    Select SYS Reports Root Folder - for the standard report publication area or the required item for connections, templates etc.

Hybrid Mode

  1. Using SQL Server Management Studio, you should now add a Login for the XLCubed application pool user (if the default XLCubed application pool is used with the Application Pool Identity, then you can use IIS AppPool\XLCubed as the Windows Authentication login name - see Creating default IIS application pool user in SQL)
  2. On the User Mappings screen map that user to the XLCUBED_USER role
  3. If any users should be able to administer the repository (see below), map those users to the XLCUBED_ADMIN role

If the file system is your chosen location for storing the reports, then no further configuration is necessary.

If SharePoint is your chosen location for storing the reports you need to add the following line to the ApplicationSettings of the XLCubedWeb web.config file:

  <add key="SharePointServerUrl" value="http://sharepointserver"/>

Where sharepointserver is the SharePoint web server address. Then to publish Excel users should connect directly to SharePoint, for scheduling and mobile app access they should connect to the XLCubedWeb server

Continue settting up SharePoint with the SharePoint Integration guide.

Scheduling

If Scheduling is desired, a few additional steps are required to use it with the SQL Repository. The Scheduling Installation with the SQL Repository page has full details.

See Also