Configure SupplierConnect Notifications
Article Index
- 1 Pre-Requisite
- 2 Step 01 - Web Portal Pre-Requisite Checklist
- 3 Step 01a - Web Server Requirements
- 4 Step 01b - Ensure Installation Of Microsoft SQL Server Native Client
- 5 Step 01c - Configure Microsoft SQL Server For Mixed Mode Authentication
- 6 Step 01d - Configure Microsoft SQL Server User Account
- 7 Step 01e - Install Internet Information Services
- 8 Step 02 - Web Portal Environment Setup Checklist
- 9 Step 02a - Download PHP
- 10 Step 02b - PHP Installation
- 11 Step 02c - Microsoft SQL Server Driver For PHP
- 12 Step 02d - PHP Configuration
- 13 Step 02e - Configure Firewall Settings
- 13.1 Microsoft SQL Ports
- 14 Step 03 - Configure ODBC DSN Connection
- 15 Step 04 - Install SupplierConnect Portal
- 16 Step 04a - Copy Ixed File
- 17 Step 04b - Implement Framework SupplierConnect Files
- 18 Step 04c - Installation - Folder Permissions
- 19 Step 04d - Portal Configuration
- 20 Step 04e - Configure Internet Information Services
- 20.1 Configure IIS 7.5
- 21 Step 04f - Installation - Test Framework SupplierConnect Portal
- 22 Step 05 - Portal Email Configuration
- 23 Step 06 - Logistics Desktop Monitor User And Mailbox Setup
- 24 Step 07 - Install Logistics Desktop On The Server
- 25 Step 07a - Install Logistics Desktop
- 26 Step 07b - Run Logistics Desktop As A Service
- 27 Step 08 - Install Microsoft Outlook
- 28 Step 09 - Create Email Templates
- 28.1 Create Email Templates
- 28.2 Examples
- 29 Step 10 - Configure Framework Preferences For Logistics Notifications
- 30 Step 11 - Enable Supplier Entities For Notifications
Pre-Requisite
Framework ECM is installed and in use.
Framework Logistics Tablet is installed and in use.
Step 01 - Web Portal Pre-Requisite Checklist
The following are summary topics that list the steps required before proceeding with the installation of any Framework Web Portal Software. This information is for internal IT staff responsible for the deployment of the Framework Web Portal Software and its integration into internal systems and business processes.
Step 01a - Web Server Requirements
The following is required on the web server that will host the Framework SupplierConnect Web Portal software:
If your organisation is running web based applications or hosting a website locally, please Contact Insula Software.
Microsoft Windows Server 2008 or above.
Microsoft IIS Version 5 or above.
An SSL website created for the Web Portal Software under Internet Information Services (IIS), accessible to clients requiring access to the Framework product Suite Web Portal Software website (SSL is recommended for improved security).
Framework Web Portal Software specific IIS website configuration changes (password control).
PHP v5.3.xx (standard binary installation).
Framework Product Suite Web Portal Software specific PHP configuration changes.
Framework Product Suite Web Portal Software configuration file changes (for correct Framework DSN).
Microsoft SQL Server 2008, 2008 R2, 2012, 2014 or 2016.
ODBC DSN for the Framework ECM database.
ODBC DSN for the Framework Licence database.
ODBC DSN(s) for the Framework Web Portal Software site configuration database(s).
Step 01b - Ensure Installation Of Microsoft SQL Server Native Client
Installs the native client for Microsoft SQL Server on the web server.
Install - Microsoft SQL Native Client
Open Windows Explorer.
Browse to: \[fw folder]\Setup\Database - MSSQL 2008\Microsoft - SQL Server Native Client Driver\
Double-click the relevant setup file. The Microsoft SQL Server Native Client installation will begin.
Click the Next The Licence Agreement step will be displayed.
Select I accept the terms in the licence agreement.
Click the Next The Registration Information step will be displayed.
Enter the registration details.
Click the Next The Feature Selection step will be displayed.
Click the Next The Ready To Install the Program step will be displayed.
Click the Install button to begin the installation.
Click the Finish button to complete the installation.
Step 01c - Configure Microsoft SQL Server For Mixed Mode Authentication
During the installation of Microsoft SQL Server (MSSQL) 2008 or above on your server, Insula Software recommended installing MSSQL in Mixed Mode Authentication. If Microsoft SQL Server was already installed prior to Framework or was installed in Windows Authentication Mode only, it needs to be configured in Mixed Mode Authentication (SQL Server and Windows Authentication Mode) to run the Framework Product Suite Web Portal Software.
This will require the SQL services to be restarted and should be performed out of hours so that there are no database connections.
Configure Microsoft SQL Server For Mixed Mode Authentication
On the SQL server:
Open Microsoft SQL Server Management Studio (Start > All Programs > Microsoft SQL Server 2008> SQL Server Management Studio).
Connect to the required server.
Right-click on the server and select Properties. The Server Properties dialog will be displayed.
From the sidebar, select Security.
Change the Server Authentication to SQL Server and Windows Authentication Mode.
Click the OK A message prompt will be displayed.
Click the OK
Close Microsoft SQL Server Management Studio.
Step 01d - Configure Microsoft SQL Server User Account
The following procedure creates a new Microsoft SQL Server login using SQL Server Authentication.
This applies to the SQL database server where the Framework databases reside.
Your organisation may already have an authenticated Microsoft SQL User available.
The following server security changes are the minimum requirements to access the Framework databases. Refer to Microsoft SQL Server documentation for more information on Microsoft SQL Server security.
The following procedure is based on Microsoft SQL Server 2008 Express Edition and should be used as a guide only
Open Microsoft SQL Server Management Studio (Start > All Programs > Microsoft SQL Server 2008 > SQL Server Management Studio).
Connect to the required server.
Expand: [Server Name] > Security
Right-click Logins and select New Login. The Login - New dialog will be displayed.
In the Login Name field, enter: FworkPortalUser
Tick: SQL Server authentication
In the Password field, enter: P@ssword
In the Confirm Password field, enter: P@ssword
From the Default database drop-down list, select: master
From the sidebar, select User Mapping.
From the Users Mapped to This Login list, tick the required Framework database(s).
For the FworkSQLECM and FworkSQLLic databases, ensure the following two items are ticked in the Database role membership for: [framework database] list:
db_owner
public
Click the OK button.
Close Microsoft SQL Server Management Studio.
Step 01e - Install Internet Information Services
Internet Information Services (IIS) is a set of Internet-based services for servers using Microsoft Windows. IIS assist in configuring websites. Your organisation may already be configured for IIS depending on if the organisation currently runs any web-based software or runs their own website using local servers.
Different versions exist for different operating systems and, in general, an operating system's IIS cannot be updated to a newer edition.
IIS is a Microsoft Windows Component that is installed using the Add/Remove Programs (in Windows XP) and Programs and Features (Windows Vista and Windows 7).
Currently the web portal software supports the following IIS versions:
IIS 5 (Windows 2000)
IIS 5.1 (Windows XP)
IIS 6 (Windows Server 2003, Windows XP 64-Bit Edition)
IIS 7 (Windows Server 2008, Windows Vista)
IIS 7.5 (Windows Server 2008 R2, Windows 7)
To install IIS on your system, please consult the Microsoft Operating System documentation.
Step 02 - Web Portal Environment Setup Checklist
The following are summary topics that list the steps required on the day (or evening prior to) the installation of the Framework Product Suite Web Portal Software. This information is for internal IT staff responsible for the deployment of the Framework Product Suite Web Portal Software and its integration into internal systems and business processes.
Step 02a - Download PHP
PHP is a widely used scripting language that is designed for web development to produce dynamic web pages. Framework's web portal software, including MyNewHome, QuickView, and SupplierConnect, uses PHP to view the web portal.
Framework's Web Portal software currently uses PHP Version 5.3.xx (Zip Package version).
Download from http://www.php.net/releases.
Step 02b - PHP Installation
PHP is a computer scripting language designed to help produce dynamic web pages. The Framework Product Suite Web Portal software uses PHP to create the website and to connect the website to the required Framework databases.
Unzip PHP to the folder: C:\php (on the target machine).
In the C:\php folder, rename the ini-recommended file to be php.ini.
Step 02c - Microsoft SQL Server Driver For PHP
The SQL Server Driver for PHP v1.0 is designed to enable reliable, scalable integration with Microsoft SQL Server for PHP applications deployed on the Windows platform. The Driver for PHP is a PHP 5 extension that allows the reading and writing of Microsoft SQL Server data from within PHP scripts. It provides a procedural interface for accessing data in all editions of Microsoft SQL Server (including Express Editions).
Install - Microsoft SQL Server Driver For PHP
Open Windows Explorer.
Browse to: \[fw folder]\Setup\Database - MSSQL\Microsoft SQL Server Driver for PHP\
Double-click the setup file. The Microsoft SQL Server Driver for PHP installation will begin.
Click the Yes The File Extraction step will be displayed.
Enter a location to extract the files (e.g., C:\phpext\). If the folder does not exist, confirm the folder creation. The files will be extracted.
Browse to the extracted file location (e.g., C:\phpext\).
Copy the following files:
dll
dll
Browse to: \php\ext\
Paste the files into the C:\php\ext\ folder.
Step 02d - PHP Configuration
Configures the PHP initialisation files.
Open Windows Explorer.
Browse to the location of the ini file (typically: C:\php\).
Edit the ini file.
Update the following settings:
The following default settings may be different to those listed depending on the PHP version (the following information is based on PHP 5.2.11)
Field Name | Default Setting | Required Setting |
---|---|---|
safe_mode | Off | Off |
max_execution_time | 30 | 60 |
error_reporting ** | E_ALL | E_ERROR & E_WARNING |
register_globals | Off | Off |
Offregister_long_arrays | Off | Off |
regOffister_argc_argv | Off | Off |
auto_gOnlobals_jit | On | On |
magic_quOffotes_gpc | Off | Off |
extension_dir | "./" | "C:\php\ext" |
enable_dl | On | Off |
cgi.force_redirect * | 1 | 0 |
fastcgi.impersonate * | 1 | 1 |
SMTP | localhost | [server name or IP address] |
smtp_port | 25 | [server's smtp port number] |
sendmail_from * | me@example.com | [administrator@acmehomes.com.au] |
odbc.defaultlrl | 4096 | 65536 |
session.auto_start | 0 | 0 |
* If a semi-colon (;) appears at the beginning of the line, users MUST remove it. ** Ensure the uncommented error_reporting field (with no semi-colon (;)) and not the commented ;error_reporting field (with semi-colon (;)) is updated. |
Find the Windows Extensions section of the ini file.
Add the following extensions:
;extension=php_sqlsrv.dll (including the leading semi-colon(;))
;extension=php_sqlsrv_ts.dll (including the leading semi-colon(;))
extension=ixed\ixed.win
Uncomment the following extension (by removing the leading semi-colon (;)):
extension=php_gd2.dll
Save the ini file.
Close the ini file.
Step 02e - Configure Firewall Settings
If the Framework Product Suite web portal web server is separated from the Framework database server by a network firewall (recommended), your firewall may require configuration of the following ports:
Microsoft SQL Ports
To configure the Firewall Ports, please consult your Microsoft documentation for more information.
Port | Required | Firewall Changes |
---|---|---|
1433 | Compulsory | Microsoft SQL ODBC. |
53 | Optional | The DNS port is not required by Framework however is sometimes enabled to address network communications performance issues. |
Step 03 - Configure ODBC DSN Connection
Provides Framework SupplierConnect Portal with the connection to read and write from the database.
ODBC DSN Configuration - Framework
On the web server:
Open Data Sources (ODBC).
Select the System DSN
Click the Add The Create New Data Source dialog will be displayed.
Select SQL Server Native Client 10.0.
Click the Finish The Create a New Data Source to SQL Server dialog will be displayed.
Enter the following details:
Name: FworkSQLECM_Portal
Description (optional): Enter a description for the database connection. For example, Framework SupplierConnect Portal.
Server: Select the SQL Server from the Server drop-down list.
OR
Enter the SQL Server name.
Click the Next
Select With SQL Server authentication using a login ID and password entered by the user.
In the Login Name field, enter: FworkPortalUser
In the Password field, enter: P@ssword
Click the Next
Tick Change the default database to.
From the drop-down list select, select the Framework ECM SQL Database.
Click the Next
Click the Finish The ODBC Microsoft SQL Server Setup dialog will be displayed.
Click the Test Data Source...
If successful, click the OK
Click the OK The ODBC Microsoft SQL Server Setup dialog will close.
Click the OK The Data Sources (ODBC) dialog will close.
ODBC DSN Configuration - Framework Licence
On the web server:
Open Data Sources (ODBC).
Select the System DSN
Click the Add The Create New Data Source dialog will be displayed.
Select SQL Server Native Client 10.0.
Click the Finish The Create a New Data Source to SQL Server dialog will be displayed.
Enter the following details:
Name: FworkSQLLic_Portal
Description (optional): Enter a description for the database connection. For example, Framework SupplierConnect Licence Portal.
Server: Select the SQL Server from the Server drop-down list.
OR
Enter the SQL Server name.
Click the Next
Select With SQL Server authentication using a login ID and password entered by the user.
In the Login Name field, enter: FworkPortalUser
In the Password field, enter: P@ssword
Click the Next
Tick Change the default database to.
From the drop-down list select, select the Framework Licence SQL Database.
Click the Next
Click the Finish The ODBC Microsoft SQL Server Setup dialog will be displayed.
Click the Test Data Source...
If successful, click the OK
Click the OK The ODBC Microsoft SQL Server Setup dialog will close.
Click the OK The Data Sources (ODBC) dialog will close.
Step 04 - Install SupplierConnect Portal
The purpose of this document is to introduce the Framework SupplierConnect Web Portal product and act as a discussion paper to assist in determining the implementation requirements of the system. This analysis aims to address the following issues:
Framework SupplierConnect configuration
Collection of current website content.
Creation of new website content.
Framework data requiring review
Framework functionality for Framework SupplierConnect
Technical requirements.
Pre-Requisite Checklist
Complete the Web Portal Pre-Requisite Checklist
Complete the Web Portal Environment Checklist.
Step 04a - Copy Ixed File
The ixed file contains decompile scripts for the Framework SupplierConnect Portal.
Open Windows Explorer.
Browse to: \[fw folder]\Setup\Framework SupplierConnect Portal\Ixed\
Right-click on the win file and select Copy.
Browse to: C:\php\ext\ folder and select Paste.
Step 04b - Implement Framework SupplierConnect Files
Copies the Framework SupplierConnect Portal files to the web server.
Open Windows Explorer.
Browse to: \[fw folder]\Setup\Framework SupplierConnect Portal\WebSiteFiles\
Select and copy all of the files and folders contained in the WebSiteFiles
Browse to: x:\inetpub\wwwroot\[portalWebsiteFolder]\
Where:x is the local target drive, and
[portalWebsiteFolder] is the folder name of the web portal software (e.g., supplierconnectportal, scp, etc.).
Paste the files and folders into the [portalWebsiteFolder], overwriting any files in the process.
The folder structure should look like:
x:\inetpub\wwwroot\[portalWebsiteFolder]\design
x:\inetpub\wwwroot\[portalWebsiteFolder]\feedback
x:\inetpub\wwwroot\[portalWebsiteFolder]\help
x:\inetpub\wwwroot\[portalWebsiteFolder]\home
x:\inetpub\wwwroot\[portalWebsiteFolder]\images\banner
x:\inetpub\wwwroot\[portalWebsiteFolder]\images\common
x:\inetpub\wwwroot\[portalWebsiteFolder]\images\header
x:\inetpub\wwwroot\[portalWebsiteFolder]\images\title
x:\inetpub\wwwroot\[portalWebsiteFolder]\inc_files
x:\inetpub\wwwroot\[portalWebsiteFolder]\my_details
x:\inetpub\wwwroot\[portalWebsiteFolder]\notifications
x:\inetpub\wwwroot\[portalWebsiteFolder]\orders
x:\inetpub\wwwroot\[portalWebsiteFolder]\response
x:\inetpub\wwwroot\[portalWebsiteFolder]\sessions
Step 04c - Installation - Folder Permissions
The following folders must have their security permissions updated for the following group or user names:
Folder | Permissions |
---|---|
x:\inetpub\wwwroot\[portalWebsiteFolder]\ | Read |
x:\inetpub\wwwroot\[portalWebsiteFolder]\sessions | Read Write Modify |
x:\php\ext\ixed | Read |
Where:
- x is the local target drive, and
- [portalWebsiteFolder] is the folder name of the Web Portal software (e.g., SupplierConnect.).
Step 04d - Portal Configuration
Configures the logon and configuration files for the Framework SupplierConnect Portal.
Configure Config.php File
Open Windows Explorer.
Browse to: x:\Inetpub\wwwroot\[portalWebsiteFolder]\inc_files\
Where:
- x is the local target drive, and
- [portalWebsiteFolder] is the folder name of the web portal software (e.g., SupplierConnect).Right-click on php and select Open With....
When opening the following files, untick Always use the selected program to open this kind of file.From the Open With... dialog, select Notepad. This opens the file for editing.
Find the text $dsn = "[Insert DSN]";
Replace [Insert DSN] with FworkSQLECM_Portal.
Find the text $user = "";
Within the inverted commas, enter FworkPortalUser.
Example: $user = "FworkPortalUser";
Find the text $pass= "";
Within the inverted commas, enter P@ssword.
Example: $pass= "P@ssword";
Find the text $footer = "Copyright Framework Homes";
Replace Copyright Framework Homes with your organisation's copyright details.
Example: Copyright Acme Homes. All Rights Reserved.
Save the file and close Windows Notepad.
Step 04e - Configure Internet Information Services
Proceed to the next step if a Framework portal has already been configured and working on the same server.
IIS (Internet Information Services) is a set of Internet-based services for servers using Microsoft Windows. IIS assists in configuring websites. Your organisation may already be configured for IIS depending on if the organisation currently runs any web-based software or runs their own website from their local servers.
Different versions exist for different operating systems and, in general, an operating system's IIS cannot be updated to a newer edition.
The implications of the following settings should be carefully considered as a part of the overall web server/site installation and security.
IIS is a Microsoft Windows Component that is installed using the Add/Remove Programs (in Windows XP) and Programs and Features (Windows Vista / Windows 7 / Windows 8).
The following guide details the steps required for IIS 7.5.
Configure IIS 7.5
Open IIS 7.5.
From the Connections list, expand: [server_name] > Sites.
Highlight Default Web Site, ensuring that the Features View is selected.
Open Handler Mappings.
From the Actions list (on the right-hand side of the screen), click Add Module Mapping. The Add Module Mapping dialog will be displayed.
Enter the following details:
Request Path: *.php
Module: From the drop-down list, select FastCgiModule
If FastCGIModule is not available, ensure CGI has been installed.Executable: Using the browse button, browse to the location of the php-cgi.exe file.
Name: PHP
Click Request Restrictions.... The Mapping tab of the Request Restrictions dialog will be displayed.
Edit the following details:
Ensure Invoke handler only if request is mapped to: is selected.
Click File or folder.
Select the Verbs.
Ensure that All verbs is selected.
Select the Access tab.
Ensure that Script is selected
Click OK.
Click OK.
Step 04f - Installation - Test Framework SupplierConnect Portal
Once Framework SupplierConnect is installed and configured, the website must be tested.
To access the newly created website:
Open Internet Explorer.
In the URL, enter:
http://[server name]/SupplierConnect/response/response.php
Step 05 - Portal Email Configuration
PHP settings for SMTP, smtp_port, and sendmail_from must contain the server and address information. This information, will allow the web portal to send notification responses to supervisors.
Example:
SMTP: Server name.
smtp_port: 25
sendmail_from: supplierconnectresponses@acmehomes.com.au
Step 06 - Logistics Desktop Monitor User And Mailbox Setup
Details the user and mailbox requirements for Logistics Desktop Notifications.
Framework Logistics Desktop Notifications User And Mailbox Account
A user account and mailbox must be created for Framework Logistics Desktop Notifications. This account is the mailbox that receives the office copy of the notifications sent from supervisors and suppliers.
Ensure the Mail Server has POP3 enabled.
Ensure the Mailbox Account has POP3 enabled.
Public Folders Setup
Public folders, or an archive equivalent, must be setup for archive/audit tracking of all Logistics notifications. Public folders are optional but HIGHLY recommended as they provide invaluable information from a support perspective (both internally for the business and externally for Insula Software. Public folders can have standing rules to auto-delete old notifications (e.g., after 1 to 3 months).
Three public folders are recommended:
Archive - Supplier Notifications: A copy of all notifications sent from supervisors to suppliers.
Example: supplierconnectnotifications@acmehomes.com.au.Archive - Supplier Responses: A copy of responses sent from the SupplierConnect Portal to supervisors.
Example: supplierconnectresponses@acmehomes.com.au.Archive - Logistics Desktop Notifications: A copy of all notifications sent from supervisors to the office. This public folder must forward a copy of the emails to the user account created above.
Example: logisticsdesktopnotifications@acmehomes.com.au.
Step 07 - Install Logistics Desktop On The Server
Install Logistics Desktop on a server for the purposes of notification monitoring.
Step 07a - Install Logistics Desktop
On a server internal to the network (typically the database server):
Open Windows Explorer.
Browse to: \[fw folder]\Setup\Framework Logistics Desktop\vx.x.x\Setup\ (where x.x.x refers to the latest version of Framework Logistics Desktop).
Double-click exe. The Framework Logistics Desktop installation process will begin.
Click the Next The Framework Licence Agreement step will be displayed.
Select I accept the terms in the licence agreement.
Click the Next The Customer Information step will be displayed.
Enter User Name and Organisation
Select Anyone who uses this computer (all users).
Click the Next The Setup Type step will be displayed.
Select Complete.
Click the Next The Ready To Install the Program step will be displayed.
Click the Install button to begin the installation.
Click the Finish button to complete the installation.
Step 07b - Run Logistics Desktop As A Service
Before installing Logistics Desktop Monitor as a service, ensure that the following two files are accessible on your system.
exe: Service installer.
exe: Applications as service utility.
Installation
Open the Run dialog (Start menu > Run).
Enter: \\path\instsrv "Framework Logistics Desktop Monitor" \\path\srvany.exe
Open the Services screen (Control Panel > Administrative Tools > Services).
Right-click Framework Logistics Desktop Monitor and select Properties. The Framework Logistics Desktop Monitor Properties (Local Computer) dialog will be displayed.
On the General tab, ensure Startup Type is set to Automatic.
On the Log On tab, ensure This account is ticked.
Click the Browse button to find the user created in Step 06 - Logistics Desktop Monitor User and Mailbox Setup
In the Password field enter the user's password.
In the Confirm password field enter the user's password.
Click the OK The dialog will close.
Close the Services screen.
Specifying Framework Logistics Desktop Monitor As The Application To Start
Open the Run dialog (Start > Run).
Enter: Regedit. The Registry Editor will be displayed.
Browse to: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Framework Logistics Desktop Monitor
From the Edit menu, select New then Key.
Enter Parameters as the new key name.
Right-click the Parameters key and select New then String Value.
Enter Application as the new string value name.
Right-click on Application and select ... The Edit String dialog will be displayed.
In the Value Data field, enter the full path to the Framework Logistics Desktop executable (including the extension and switch).
Click the OK
Close the Registry Editor.
Remove Framework Logistics Desktop Monitor As A Service
To disable the Logistics Desktop Monitor as a service:
Open the Services screen (Control Panel > Administrative Tools > Services).
Right-click Framework Logistics Desktop Monitor and select Properties. The Framework Logistics Desktop Monitor Properties (Local Computer) dialog will be displayed.
On the General tab, ensure Startup Type is set to Disabled.
Click the OK The dialog will close.
Close the Services screen.
To Remove The Framework Logistics Desktop Monitor Service:
Open the Services screen (Control Panel > Administrative Tools > Services).
Right-click Framework Logistics Desktop Monitor and select Stop.
Close the Services screen.
Open the Run dialog (Start > Run).
Enter: \\path\instsrv "Framework Logistics Desktop Monitor" remove.
Step 08 - Install Microsoft Outlook
On the server running Logistics Desktop Monitor, install Microsoft Outlook (2003, 2007, or 2010). After Microsoft Outlook is installed, logon to Microsoft Windows as the user created in Step 06 - Logistics Desktop Monitor User and Mailbox Setup and configure Outlook for that user.
Step 09 - Create Email Templates
Logistics Desktop Notifications uses template emails that are used to send information to suppliers.
Create Email Templates
In Framework Administration:
From the Administration menu, select CRM then Email Template.
From the Category list, select Construction Logistics.
From the Email Template Level, select Default.
Click the Email A shadow will appear around the list to indicate it is selected.
Click the New The Email dialog will be displayed.
Enter a name and reference name for the email template.
Click the OK The dialog will close.
Click the Email Template A shadow will appear around the list to indicate it is selected.
Click the New The General tab of the Email Template dialog will be displayed.
Enter a subject heading.
Enter the HTML email code.
Tip: Use the Insert Field button to enter Framework fields into the HTML code. Use the Preview tab to preview an email template.
When completed, click the OK
Two examples are provided below.
Examples
The following is a full Called and Called Off email template examples. Update your company details in the following code before finalising the email template.
Called
Subject:
Acme Homes: RELEASE For Delivery - ({jobAddress})
HTML:
{{supplierName}},
This is an automated notification from Acme Homes.
Please release for delivery the following purchase order:
Order Number: {{orderNumber}}
Activity: {{cstLActivityName}}
Date Required: {{dCalledForAct}}
Job Address: {{jobAddress}}
Supervisor: {{supervisorName}}
Job Number: {{jobNumber}}
Additional Instructions: {{suppInstructions}}
YOU MUST PROVIDE A RESPONSE TO THIS NOTIFICATION.
{{generatedOrderURL}}
IMPORTANT:
If you cannot deliver on the requested date you MUST make direct contact with the supervisor:
Supervisor: {{supervisorName}}
Mobile: {{supervisorTelMob}}
Email: {{supervisorTelEmail}}
Thank you for your assistance,
Acme Homes
Called Off
Subject:
Acme Homes: CANCEL Delivery - ({jobAddress})
HTML:
{{supplierName}},
This is an automated notification from Acme Homes.
Please CANCEL the requested delivery of the following purchase order:
Order Number: {{orderNumber}}
Activity: {{cstLActivityName}}
Date Required: {{dCalledForAct}}
Job Address: {{jobAddress}}
Supervisor: {{supervisorName}}
Job Number: {{jobNumber}}
You are NOT required to respond to this notification.
{{generatedOrderURL}}
IMPORTANT:
If required, you can contact the supervisor:
Supervisor: {{supervisorName}}
Mobile: {{supervisorTelMob}}
Email: {{supervisorTelEmail}}
Thank you for your assistance,
Acme Homes
Step 10 - Configure Framework Preferences For Logistics Notifications
Preferences in Framework ECM needs to be configured.
Update Notification Preferences
In Framework ECM:
Open the Security module (File > Module > Security).
From the Security menu, select Preference.
Expand Framework Construction Logistics > SupplierConnect Portal > Notifications.
Preference Number | Preference Name | Setting |
---|---|---|
-50000 | Enable SupplierConnect Notifications | Enables the SupplierConnect notification function. |
-11050 | Email Address for Notifications to Desktop | The default email address to which all notification emails are sent to the office. |
-50078 | Source of Supplier Details for Notifications | The location where notifications will search for supplier details. Settings
|
-11003 | Notifications Response Page URL | The URL response page of the SupplierConnect Web Portal. This is the page that the supplier accesses when responding to a notification. |
-50040 | SupplierConnect Portal Status | The status of the SupplierConnect Web Portal. Settings
|
Update Configuration - Logistics Desktop Preferences
In Framework ECM:
Open the Security module (File > Module > Security).
From the Security menu, select Preference.
Expand Framework Construction Logistics > SupplierConnect Portal > Configuration - Logistics Desktop.
Preference Number | Preference Name | Setting |
---|---|---|
-11053 | Notification Monitor (Minutes) – Desktop | The time, in minutes, between Logistics Desktop Monitor probing Microsoft Outlook for new notifications. |
-11054 | Notification Monitor (Minutes) – Shadow | The time, in minutes, between Logistics Desktop Monitor updates. |
-11051 | MAPI Inbox Subfolder for Notifications – Desktop | The sub-folder for Logistics Desktop notifications. |
-50079 | Monitoring Email Transport | The email transport method.
|
-50080 | POP3 Server Name | The SMTP/POP3 server name. Enter a server name if the previous item (Monitoring Email Transport) is set to SMTP/POP3. Settings [enter the SMTP/POP3 server name] |
-50081 | POP3 Server Requires Encryption | The encryption status of the SMTP/POP3 server. Settings
|
-50082 | POP3 User Name | The username required to login to the SMTP/POP3 server. Setting [enter a username for the SMTP/POP3 server] |
-50083 | POP3 Password | The password required to login to the SMTP/POP3 server for the entered username. Settings [enter a password for the SMTP/POP3 server for the entered username] |
-50084 | Enable Monitoring Report | Enable or disable the emailing of daily monitor reports. Settings
|
-50085 | Monitoring Report Email Address (To) | The email address the monitoring report will be sent to. |
-50086 | Monitoring Report Email Address (Cc) | The carbon copy email address the monitoring report will be sent to. |
-50087 | Time of Day to Send Monitoring Report | The time the monitoring report will be sent to the entered email addresses. |
Update Configuration - Logistics Tablet Preferences
In Framework ECM:
Open the Security module (File > Module > Security).
From the Security menu, select Preference.
Expand Framework Construction Logistics > SupplierConnect Portal > Configuration - Logistics Tablet.
Preference Number | Preference Name | Setting |
---|---|---|
-11052 | Notification Monitor (minutes) – Tablet | The time, in minutes, for how often the tablet will update and search Microsoft Outlook for notifications. |
-50046 | Prompt User To Confirm Notification | Toggle a Tablet PC user confirmation prompt prior to sending notifications.
|
-50047 | Show Notification Sent Confirmation | Toggle a Tablet PC user informing that a notification has been sent. Settings
|
-11048 | Enable Notification Monitoring | This option enables or disables the monitoring of notification responses from the supplier. Settings
|
-50088 | MAPI Inbox Subfolder for Notifications – Tablet | This is the sub-folder for Tablet PC notifications. This sub-folder is where the Tablet PC monitor will search for notifications if a subfolder was setup. |
Update Notification Emails Preferences
This is where we setup the Email template for each Called and Called Off notification type. The templates are created in Logistics Desktop and are currently assigned at a user level.
In Framework ECM:
Open the Security module (File > Module > Security).
From the Security menu, select Preference.
Expand Framework Construction Logistics > SupplierConnect Portal > Notification Emails.
Preference Number | Preference Name | Setting |
---|---|---|
-11008 | Called Email – Tablet | Used to assign the email template for called email notifications sent from the Tablet PC. |
-11009 | Called Off Email – Tablet | Used to assign the email template for called off email notifications sent from the Tablet PC. |
-50089 | Called SMS Email – Tablet | Used to assign the email template for called SMS notifications sent from the Tablet PC. |
-50090 | Called Off SMS Email – Tablet | Used to assign the email template for called off SMS notifications sent from the Tablet PC. |
-50091 | Called Email – ECM/Office | Used to assign the email template for called email notifications sent from the office. |
-50092 | Called Off Email – ECM/Office | Used to assign the email template for called off email notifications sent from the office. |
-50093 | Called SMS Email – ECM/Office | Used to assign the email template for called SMS notifications sent from the office. |
-50094 | Called Off SMS Email – ECM/Office | Used to assign the email template for called off SMS notifications sent from the office. |
Update Supplier Reminders Preferences
In Framework ECM:
Open the Security module (File > Module > Security).
From the Security menu, select Preference.
Expand Framework Construction Logistics > SupplierConnect Portal > Supplier Reminders.
Preference Number | Preference Number | Setting |
---|---|---|
-50095 | Send Daily Reminders | This setting is used to enable daily reminders that will be sent to suppliers as a reminder of outstanding notifications (to be verified). |
-50096 | Time of day to Send Reminders | Used to set the time the daily supplier reminder will be sent. |
Update Notification Email Delivery Preferences
In Framework ECM:
Open the Security module (File > Module > Security).
From the Security menu, select Preference.
Expand Framework Construction Logistics > SupplierConnect Portal > Notification Email Delivery.
Preference Number | Preference Number | Setting |
---|---|---|
-11004 | Live – Supplier Email Address (Cc) | This email address is used to send a carbon copy of the notification when a notification is sent to a supplier via the Tablet PC or office. This email address is used when the portal has a status of Live. |
-11005 | Live – Supplier Email Address (Bcc) | This email address is used to send a blind carbon copy of the notification when a notification is sent to a supplier via the Tablet PC or office. This email address is used when the portal has a status of Live. |
-11006 | Live – Supplier Email Request Delivery Receipt | This preference is used to enable delivery receipts for when a notification is sent from the Tablet PC or office. This preference is only valid when the portal has a status of Live. |
-11007 | Live – Supplier Email Request Read Receipt | This preference allows the notification to request a read receipt from the supplier when receiving the notification email. This preference is only valid when the portal has a status of Live. |
Step 11 - Enable Supplier Entities For Notifications
To enable supplier entities for notifications:
Open Framework ECM.
Open the Administration module (File > Module > Administration).
From the Administration menu, select Entity then Entity. The Entity screen will be displayed.
From the Entity Roles list, select a supplier. The Entities list will be updated.
From the Entities list, select a supplier.
Click the Edit The General tab of the Company Details dialog will be displayed.
Select the Profiles
In the Notifications group, toggle the Email field from No to Yes.
Click the OK The supplier will now be enabled for notifications via email.