Custom Notification User Guide. Christopher Cook HAWK RIDGE SYSTEMS

Size: px

Start display at page:

Download "Custom Notification User Guide. Christopher Cook HAWK RIDGE SYSTEMS"

Rodger Francis
6 years ago
Views:

1 Custom Notification User Guide Christopher Cook HAWK RIDGE SYSTEMS

Table of Contents Overview... 2 System Requirements... 2 Installation... 2 Un-Installing the Add-In... 3 Disabling the Add-In... 3 Setting Up the SQL Database... 4 Creating the Database.

2 Table of Contents Overview... 2 System Requirements... 2 Installation... 2 Un-Installing the Add-In... 3 Disabling the Add-In... 3 Setting Up the SQL Database... 4 Creating the Database... 4 Setting up Custom Notifications... 5 Setting Up State Notifications... 5 Frequently Asked Questions... 7 From which configuration are variables read?... 7 What if multiple files are transitioning at the same time?... 7 Can I include HTML tags in my message text?... 7 How can I temporarily disable the add-in?... 7 Are there records of messages that are sent?

3 Overview HawkWare Custom Notification sends customized messages to specified SOLIDWORKS Enterprise PDM users when documents move through workflow transitions. The list of the recipients is dynamic as it is read from the Data Card variables of the effected document. System Requirements 1. SolidWorks Enterprise PDM 2013 or later. 2. Microsoft.NET framework 4.0 or later. 3. Running instance of Microsoft SQL Database with all Enterprise PDM clients having access to it. Installation If an older version of the add-in is already installed in the vault, it must be removed by following the removal steps described in the next section, before installing the new version. All actions regarding the add-in DLLs can be done from any machine by the administrator in the Enterprise PDM Administration tool: 1. Login to Enterprise PDM Vault Administration. 2. Expand the vault where the add-in will be used. 3. Right-click the vault name and click Import Browse to the CEX fie you downloaded from the HawkWareApps store. Click Open. 5. Alternatively, you can drag and drop the CEX file into the Administration screen on the right side, then drag the add-in from the resulting tree onto the Add-ins node in your vault. 2

Un-Installing the Add-In 1. Close open applications; exit Enterprise from tray icon if loaded. 2. Login to Enterprise PDM Vault Administration. 3. Expand the vault where the add-in is installed. 4.

4 Un-Installing the Add-In 1. Close open applications; exit Enterprise from tray icon if loaded. 2. Login to Enterprise PDM Vault Administration. 3. Expand the vault where the add-in is installed. 4. Right-Click the add-in and select Remove. 5. Click OK to confirm. After removing the add-in, it is necessary to either reboot all client machines or re-start Explorer.exe process on all of them as follows: 1. Open the task manager and end the explorer.exe process. Do not close task manager. 2. Restart Explorer.exe by selecting file > new task > type explorer.exe. Click OK. Disabling the Add-In You can temporarily disable the functionality of the add-in without having to uninstall completely. To disable or enable the add-in: 1. In the Enterprise PDM Administration, find the add-in under Add-ins node. 2. Right click on the add-in and select Diagnostics. 3. Select either the Disable or Enable radio button and click OK. Note: Enable Logging is used when troubleshooting the add-in. Make sure this option is always checked off as it affects performance. 3

5 Setting Up the SQL Database 1. Right-Click the Custom Notification add-in in Enterprise PDM Admin tool and select "Settings". 2. In the dialog box, enter Server Instance Name, SQL User Name, and Password for your SQL server. The SQL server must be accessible from all client machines running Enterprise PDM. 3. Click the OK button. Creating the Database If the SQL database needed for custom notification (<VaultName>_CustomNotification) has not already been created, a menu is available at the bottom of the login window to create it. IMPORTANT: The SQL user account specified in the log in dialog box must have sufficient rights to create new databases. Once created it must retain at least DBOwner status in order to keep the tables up to date. 4

6 Setting up Custom Notifications When a document transitions to a SOLIDWORKS Enterprise PDM workflow state, the add-in performs the following actions: 1. Checks the destination state (Including state changes due to auto-transitions). 2. Searches the settings table for Workflow and State ID's. This table is stored in Microsoft SQL database. 3. Reads the values for all card variables specified in the states table. These values are expected to be user names (Full Name or Login Name). 4. Gets the message text from the states table and sends a notification to all the users found from above step. Setting up State Notifications Note: Ensure that you have already gone through the Initial SQL Database Setup under Installation. 1. Right-Click the Custom Notification add-in in Enterprise PDM Admin tool and select "Settings". 2. Select a Workflow and State from the drop-down lists. 3. Check the card variables containing the users to be notified. 4. Select document categories for which notifications will be sent. 5. Enter the message text to be sent. All messages will contain a link to the affected file. 6. Click the Add Row button. 7. To change an existing row, highlight it, then select WorkFlow, State, Variables, Message Text and click the Update button. 8. Click Save. 5

7 In the example below, when a document transitions to 'Approved_New' state in 'Default Workflow_New' WorkFlow, the add-in finds the value of variable 'Author' and if the value is a user name (Full Name or Login Name), sends a message containing 'Test Message' in the body and a link to the document. 6

8 Frequently Asked Questions From which configuration are variables read? For SolidWorks files, the values are read from the configuration. For all other files, the values are read from the main tab (empty configuration). What if multiple files are transitioning at the same time? The add-in will send notifications for all files transitioning and present the user with a single confirmation dialog box. Can I include HTML tags in my message text? Yes. You can type HTML tags (e.g. font styles, underlines etc). Enterprise PDM message reader will interpret the HTML tags. How can I temporarily disable the add-in? Right-Click the add-in in Enterprise PDM Admin tool and select 'Diagnostics'. In the dialog box, click 'Disable' and click OK. Are there records of messages that are sent? In SQL database (<VaultName>_CustomNotificaiton), there is a table named SentMessageLog which contains records of all messages that have been sent. 7

Employee Web Services. Installation Guide

Employee Web Services. Installation Guide Employee Web Services This is a publication of Abila, Inc. Version 2017.x 2016 Abila, Inc. and its affiliated entities. All rights reserved. Abila, the Abila logos, and the Abila product and service names