Push Favorites SQL User Guide
Push Favourites SQL User Guide
11 October 2016 Commercial in confidence
Create | Collaborate | Manage
Document automation, email and document management solutions for Microsoft SharePoint® and Office®
Table of contents 1.
Introduction ............................................................................................................................................... 2 1.1
2.
3.
4.
Push Favourites Versions .............................................................................................................. 2
Managing subscriptions with the supplied user interface ......................................................................... 3 2.1
Setting up users and groups .......................................................................................................... 4
2.2
Adding favourite locations .............................................................................................................. 4
2.3
Editing and removing favourite locations ....................................................................................... 5
2.4
Assigning favourites to users and / or groups ................................................................................ 5
Installation & Configuration ...................................................................................................................... 7 3.1
Administration Client ...................................................................................................................... 7
3.2
Pushed Favourites SQL Database................................................................................................. 7
3.3
MacroView DMF Client .................................................................................................................. 7
Connecting to your own line of business system ..................................................................................... 8
www.macroview.com.au
Push Favourites | 1
1.
Introduction MacroView Push Favourites is an optional module for MacroView DMF and MacroView Message that allows SharePoint Sites, Libraries, Folders and Document Sets to be automatically pushed to users Favourites mode in MacroView DMF and MacroView Message.
1.1
Push Favourites Versions There are a number of Push Favourite versions available to suit different SharePoint environments and the number of push favourites required. This document covers the installation and configuration of Push Favourites SQL Version
Data source
# Favorites per user
Maximum total # of Favourites
License required
Lite
SharePoint List
3
5000
No
Standard
SharePoint List
5000
5000
Yes
SQL
SQL database
Unlimited
Unlimited
Yes
Push Favourites SQL is a licensed version for users of MacroView DMF or MacroView Message which supports allocation of an unlimited number of favourites. It can be used with both on-premises SharePoint servers and SharePoint Online as well as with MacroView DMF or MacroView Message running in Client Side Only mode. MacroView DMF Push Favourites SQL lets organisations store their Push Favourites in a central SQL Server database and update the database via a simple user interface. Alternatively, a custom integration can be written to synchronise the Push Favourites database with a Line of Business systems. For assistance with integrating with a third party line of business system contact MacroView Professional services at [email protected] Push Favourites can be assigned to users directly, or they can be assigned to groups which the users then follow. Users can also be assigned to follow other users, although following groups simplifies management. Note that when a user is assigned to follow another user they only receive the favourites assigned directly to that user. They do not get any of the favourites from groups (or users) that user is following. www.macroview.com.au
Push Favourites | 2
2.
Managing subscriptions with the supplied user interface Push Favourites SQL subscriptions are maintained in an SQL database or other line of business system. MacroView Push Favourites SQL ships with a sample application for managing the subscriptions.
The sample application allows you to:
create Favourites
set up users and groups
assign favourites to users and / or groups
assign users to groups, or allow users to follow other users
To open the sample administration application, double-click on the MacroView DMF PushFavSQLUI desktop icon
www.macroview.com.au
Push Favourites | 3
2.1
Setting up users and groups
Select the Add users / edit favourites tab
Click Load/Reload to load existing users records from the database
Add a new row for each user or group by clicking on the last row in the table
Enter the following information in the new row. For users: UserNetworkID = Domain\userID UserEmail = email address UserName = Display name for the user in DMF Favourites. This will be used in the favourite group title for users being followed. The group title for a user’s own favourites is hardcoded to “My Matters”.
For groups: UserNetworkID = Group Name UserEmail = not required UserName = Display name for the group in DMF Favourites
2.2
To commit changes click Save Changes
To delete a user of group, select the row and click Delete row
Adding favourite locations
Select the Add favourites tab
Select the Favourite type
Enter the Favourite name and Favourite URL (note: for Folder and Document Set favourites you also need to enter the Library URL)
Click Add Favourite
www.macroview.com.au
Push Favourites | 4
2.3
Editing and removing favourite locations
Select the Add users / edit favourites tab
Select edit favourites from the Select to edit users or favourites menu
Click Load/Reload to load existing favourites records from the database
To edit a favourite, change the required information in the table and click Save Changes
To delete a favourite, select the row and click Delete row
2.4
Assigning favourites to users and / or groups
(a)
Assigning a Favourite
(b)
Select the Add favourites tab
In the Assign favourite / follow users or group section, select the user or group
Select the favourite to assign from the Add menu
Click Add
Removing a Favourite
Select the Add favourites tab
In the Assign favourite / follow users or group section, select the user or group
Select the favourite to be removed from the remove menu
Click Remove
www.macroview.com.au
Push Favourites | 5
Note: User will receive ALL favourites assigned to the person or group they are following. MacroView Push Favourites SQL does not filter out those favourites a user does not have rights to.
(c)
(d)
Following a Favourite
Select the Add favourites tab
In the Assign favourite / follow users or group section, select the user or group
Select the favourite to assign from the Follow menu
Click Add
Un-following a user or group
Select the Add favourites tab
In the Assign favourite / follow users or group section, select the user or group
Select the favourite to be removed from the Follow menu
Click Un-follow
www.macroview.com.au
Push Favourites | 6
3.
Installation & Configuration There are three step to installing and configuring Push Favourites SQL for use with the provided SQL database and Push Favourites administration interface:
Install the Push Favourites Administration Client
Create the Push Favourites SQL database
Install and configure the Push Favourites client extension for DMF
To connect Push Favourites SQL with your own line-of-business system you only need to install and configure the Push Favourites client extension for DMF. Refer to section 4 or contact MacroView Professional services at [email protected] for more information.
3.1
Administration Client
Install the Push Favourites Administration Client (MacroView.DMF.PushFavSQL.Admin.msi)
Set the database connection string in the following registry key: [HKEY_CURRENT_USER\Software\MacroView\DMF\Customizations\MacroView\PushFavSQL\ ConnStr]. e.g. Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=PushSQLTest;Data Source=TESTS2012SP2013; The database connection string can be set for each Push Favourites administrator using the sample PushFavConnStr.reg file located under the [Program Files]\MacroView\PushFavSQLUI\ folder or by deploying the setting using group policy. Before setting the database connection string the Push Favourites SQL Database must be created. Refer to section 3.2
3.2
Pushed Favourites SQL Database After installing the Administration Client a sample SQL script is located in the [Program Files]\MacroView\PushFavSQLUI\ folder. The sample SQL script (PFInstallScript.sql) contains the necessary commands to create the database and its various objects. It is recommended that a DBA vet the script and update it as necessary.
3.3
Edit paths and names as appropriate, and ensure you replace > with the database name.
Ensure users have enough permissions to read data and execute stored procedures from the newly created DB.
Users of the sample management application will need the ability to add, delete and modify the data.
MacroView DMF Client
Install the Push Favourites DMF Client extension that matches your version of Office MacroViewDMFPushFavSQLClient_x86.msi (32 bit Microsoft Office) MacroViewDMFPushFavSQLClient_x64.msi (64 bit Microsoft Office)
Set the following registry key to the database connection string, adjusted to suit your own SQL server. [HKEY_CURRENT_USER\Software\MacroView\PushFav] e.g. "ConnStr"="Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=PushFavDatabase;Data Source=SQLServerInstance;"
www.macroview.com.au
Push Favourites | 7
4.
Connecting to your own line of business system MacroView DMF calls a stored procedure, passing the users network login (domain\user) as a parameter, which returns Favourites for the user. The supplied database structure can be changed provided that the stored procedure returns results in the required format. This may require creation of their own management utilities as the management application supplied with MacroView Push favourites SQL may not continue to work. The key requirement of any user interface is that the GUID IDs for each favourite need to be added to the database when a favourite is added.
www.macroview.com.au
Push Favourites | 8
Business Technology Pty Limited ABN 29 081 117 777 Level 12 171 Clarence Street Sydney NSW 2000 Australia GPO Box 5149 Sydney NSW 2001 Australia T: +61 2 9249 2700 F: +61 2 9279 4111 www.macroview.com.au
About MacroView Create | Collaborate | Manage MacroView is a leader in document automation, email and document management solutions for Microsoft SharePoint® and Microsoft Office®. Our solutions use the latest technologies across desktop, mobile and the cloud. MacroView software is licensed and used by hundreds of organisations globally across a diverse range of industries. Key features of the software include deep integration with Microsoft Office ®, comprehensive document management functionality and efficient support for large volume SharePoint document stores.
© 2016 MacroView Business Technology Pty Limited All rights reserved.
Create | Collaborate | Manage
Document automation, email and document management solutions for Microsoft SharePoint® and Office®
11 October 2016 Commercial in confidence
Create | Collaborate | Manage
Document automation, email and document management solutions for Microsoft SharePoint® and Office®
Table of contents 1.
Introduction ............................................................................................................................................... 2 1.1
2.
3.
4.
Push Favourites Versions .............................................................................................................. 2
Managing subscriptions with the supplied user interface ......................................................................... 3 2.1
Setting up users and groups .......................................................................................................... 4
2.2
Adding favourite locations .............................................................................................................. 4
2.3
Editing and removing favourite locations ....................................................................................... 5
2.4
Assigning favourites to users and / or groups ................................................................................ 5
Installation & Configuration ...................................................................................................................... 7 3.1
Administration Client ...................................................................................................................... 7
3.2
Pushed Favourites SQL Database................................................................................................. 7
3.3
MacroView DMF Client .................................................................................................................. 7
Connecting to your own line of business system ..................................................................................... 8
www.macroview.com.au
Push Favourites | 1
1.
Introduction MacroView Push Favourites is an optional module for MacroView DMF and MacroView Message that allows SharePoint Sites, Libraries, Folders and Document Sets to be automatically pushed to users Favourites mode in MacroView DMF and MacroView Message.
1.1
Push Favourites Versions There are a number of Push Favourite versions available to suit different SharePoint environments and the number of push favourites required. This document covers the installation and configuration of Push Favourites SQL Version
Data source
# Favorites per user
Maximum total # of Favourites
License required
Lite
SharePoint List
3
5000
No
Standard
SharePoint List
5000
5000
Yes
SQL
SQL database
Unlimited
Unlimited
Yes
Push Favourites SQL is a licensed version for users of MacroView DMF or MacroView Message which supports allocation of an unlimited number of favourites. It can be used with both on-premises SharePoint servers and SharePoint Online as well as with MacroView DMF or MacroView Message running in Client Side Only mode. MacroView DMF Push Favourites SQL lets organisations store their Push Favourites in a central SQL Server database and update the database via a simple user interface. Alternatively, a custom integration can be written to synchronise the Push Favourites database with a Line of Business systems. For assistance with integrating with a third party line of business system contact MacroView Professional services at [email protected] Push Favourites can be assigned to users directly, or they can be assigned to groups which the users then follow. Users can also be assigned to follow other users, although following groups simplifies management. Note that when a user is assigned to follow another user they only receive the favourites assigned directly to that user. They do not get any of the favourites from groups (or users) that user is following. www.macroview.com.au
Push Favourites | 2
2.
Managing subscriptions with the supplied user interface Push Favourites SQL subscriptions are maintained in an SQL database or other line of business system. MacroView Push Favourites SQL ships with a sample application for managing the subscriptions.
The sample application allows you to:
create Favourites
set up users and groups
assign favourites to users and / or groups
assign users to groups, or allow users to follow other users
To open the sample administration application, double-click on the MacroView DMF PushFavSQLUI desktop icon
www.macroview.com.au
Push Favourites | 3
2.1
Setting up users and groups
Select the Add users / edit favourites tab
Click Load/Reload to load existing users records from the database
Add a new row for each user or group by clicking on the last row in the table
Enter the following information in the new row. For users: UserNetworkID = Domain\userID UserEmail = email address UserName = Display name for the user in DMF Favourites. This will be used in the favourite group title for users being followed. The group title for a user’s own favourites is hardcoded to “My Matters”.
For groups: UserNetworkID = Group Name UserEmail = not required UserName = Display name for the group in DMF Favourites
2.2
To commit changes click Save Changes
To delete a user of group, select the row and click Delete row
Adding favourite locations
Select the Add favourites tab
Select the Favourite type
Enter the Favourite name and Favourite URL (note: for Folder and Document Set favourites you also need to enter the Library URL)
Click Add Favourite
www.macroview.com.au
Push Favourites | 4
2.3
Editing and removing favourite locations
Select the Add users / edit favourites tab
Select edit favourites from the Select to edit users or favourites menu
Click Load/Reload to load existing favourites records from the database
To edit a favourite, change the required information in the table and click Save Changes
To delete a favourite, select the row and click Delete row
2.4
Assigning favourites to users and / or groups
(a)
Assigning a Favourite
(b)
Select the Add favourites tab
In the Assign favourite / follow users or group section, select the user or group
Select the favourite to assign from the Add menu
Click Add
Removing a Favourite
Select the Add favourites tab
In the Assign favourite / follow users or group section, select the user or group
Select the favourite to be removed from the remove menu
Click Remove
www.macroview.com.au
Push Favourites | 5
Note: User will receive ALL favourites assigned to the person or group they are following. MacroView Push Favourites SQL does not filter out those favourites a user does not have rights to.
(c)
(d)
Following a Favourite
Select the Add favourites tab
In the Assign favourite / follow users or group section, select the user or group
Select the favourite to assign from the Follow menu
Click Add
Un-following a user or group
Select the Add favourites tab
In the Assign favourite / follow users or group section, select the user or group
Select the favourite to be removed from the Follow menu
Click Un-follow
www.macroview.com.au
Push Favourites | 6
3.
Installation & Configuration There are three step to installing and configuring Push Favourites SQL for use with the provided SQL database and Push Favourites administration interface:
Install the Push Favourites Administration Client
Create the Push Favourites SQL database
Install and configure the Push Favourites client extension for DMF
To connect Push Favourites SQL with your own line-of-business system you only need to install and configure the Push Favourites client extension for DMF. Refer to section 4 or contact MacroView Professional services at [email protected] for more information.
3.1
Administration Client
Install the Push Favourites Administration Client (MacroView.DMF.PushFavSQL.Admin.msi)
Set the database connection string in the following registry key: [HKEY_CURRENT_USER\Software\MacroView\DMF\Customizations\MacroView\PushFavSQL\ ConnStr]. e.g. Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=PushSQLTest;Data Source=TESTS2012SP2013; The database connection string can be set for each Push Favourites administrator using the sample PushFavConnStr.reg file located under the [Program Files]\MacroView\PushFavSQLUI\ folder or by deploying the setting using group policy. Before setting the database connection string the Push Favourites SQL Database must be created. Refer to section 3.2
3.2
Pushed Favourites SQL Database After installing the Administration Client a sample SQL script is located in the [Program Files]\MacroView\PushFavSQLUI\ folder. The sample SQL script (PFInstallScript.sql) contains the necessary commands to create the database and its various objects. It is recommended that a DBA vet the script and update it as necessary.
3.3
Edit paths and names as appropriate, and ensure you replace > with the database name.
Ensure users have enough permissions to read data and execute stored procedures from the newly created DB.
Users of the sample management application will need the ability to add, delete and modify the data.
MacroView DMF Client
Install the Push Favourites DMF Client extension that matches your version of Office MacroViewDMFPushFavSQLClient_x86.msi (32 bit Microsoft Office) MacroViewDMFPushFavSQLClient_x64.msi (64 bit Microsoft Office)
Set the following registry key to the database connection string, adjusted to suit your own SQL server. [HKEY_CURRENT_USER\Software\MacroView\PushFav] e.g. "ConnStr"="Provider=SQLOLEDB.1;Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=PushFavDatabase;Data Source=SQLServerInstance;"
www.macroview.com.au
Push Favourites | 7
4.
Connecting to your own line of business system MacroView DMF calls a stored procedure, passing the users network login (domain\user) as a parameter, which returns Favourites for the user. The supplied database structure can be changed provided that the stored procedure returns results in the required format. This may require creation of their own management utilities as the management application supplied with MacroView Push favourites SQL may not continue to work. The key requirement of any user interface is that the GUID IDs for each favourite need to be added to the database when a favourite is added.
www.macroview.com.au
Push Favourites | 8
Business Technology Pty Limited ABN 29 081 117 777 Level 12 171 Clarence Street Sydney NSW 2000 Australia GPO Box 5149 Sydney NSW 2001 Australia T: +61 2 9249 2700 F: +61 2 9279 4111 www.macroview.com.au
About MacroView Create | Collaborate | Manage MacroView is a leader in document automation, email and document management solutions for Microsoft SharePoint® and Microsoft Office®. Our solutions use the latest technologies across desktop, mobile and the cloud. MacroView software is licensed and used by hundreds of organisations globally across a diverse range of industries. Key features of the software include deep integration with Microsoft Office ®, comprehensive document management functionality and efficient support for large volume SharePoint document stores.
© 2016 MacroView Business Technology Pty Limited All rights reserved.
Create | Collaborate | Manage
Document automation, email and document management solutions for Microsoft SharePoint® and Office®
