User guide NotifySCM Installer
TABLE OF CONTENTS 1 Overview... 3 2 Office 365 Users synchronization... 3 3 Installation... 5 4 Starting the server... 17 2 P a g e
1 OVERVIEW This user guide provides instruction on the installation of NotifySCM Workspace. To facilitate a smooth installation, it is recommended that you first use the NotifySCM testing tool to ensure that your VM and infrastructure are ready. 2 OFFICE 365 USERS SYNCHRONIZATION The following instructions are a workaround for customers that do not have a standard identities source such as Active Directory on premises. If you have an LDAP compatible server, please use it for user synchronization and skip this chapter. To be able to use NotifySCM with an Office 365 account, a dedicated mail account is required to synchronize users. Create a new account with notify@<yourcompany.com> Login with this account Figure 1: Office365 - Login page After you have logged in, you will be see a standard outlook webpage with emails. From the Navigation bar at the top, select the People option. 3 P a g e
Select Offline Global Address List Select the contact you want to synchronize with NotifySCM Add to contacts Select the added contact Fill in the data, then expand the work option as shown in the figure below. Enter the user in the Department field that will be recognized by NotifySCM's synchronization mechanism as the grouping parameter. Entering email address is mandatory, as this address needs to match the user's login. This is where NotifySCM gets that information. The Department parameter is also important if you plan to synchronize multiple groups or you want to only allow users in specific departments to use NotifySCM. Figure 2: Office365 - create new user fields entered 4 P a g e
3 INSTALLATION To start installation, browse to the location of the installation files on your computer. To run properly, installation must be started in privileged mode (as administrator). Click on Run as administrator to bypass the security warnings. Figure 3: Run as administrator Prerequisites: The installer will install C++ 2008 redistributable prerequisites (to install NotifySCM as service). After the prerequisites have been installed, a language selection panel is displayed. Select a language and click OK. 5 P a g e
Step 1: Welcome After the prerequisites have been installed and a language has been selected, a welcome page displays. Click Next. Figure 4: Welcome screen 6 P a g e
Step 2: Set installation path The Installation folder selection screen displays. Select the location on your machine where NotifySCM will be installed. Click Browse, or enter the path in the textbox. Figure 5: Installation path selection If the folder does not exist, a textbox pops up prompting you to click OK in order to create the specified folder. Figure 6: Target directory will be created 7 P a g e
Step 3: Synchronization settings Enter the settings for one of the following infrastructure configurations: NotifySCM with a Microsoft Exchange Server NotifySCM with an IBM Lotus Domino Server Office 365 Cloud Server (workaround) Figure 7: Sync server configuration for Exchange 8 P a g e
NotifySCM with a Microsoft Exchange Server NotifySCM, when used with your own Exchange server, will synchronize groups and users from your Active Directory. You will need to enter the following information to accommodate that: LDAP hostname (e.g. ldap://ldap.notify.local): The internal URL of your Active Directory. LDAP base (e.g. dc=notify,dc=local): The base of your Active Directory. Domain name alias (e.g. notify): The NotifySCM domain that end users may use to login into the workspace. With the domain notify, end users will be allowed to login with username or username@notify. LDAP Query User: A query user with read rights (Any LDAP account can work as Query user). LDAP Query Password: The password of the above query user. NotifySCM with an IBM Lotus Domino Server NotifySCM, when used with your own Lotus Domino server, will synchronize groups and users from the LDAP server within your Domino environment. You will need to enter the following information to accommodate that: LDAP hostname (e.g. ldap://ldap.notify.local): The internal URL of your Lotus Domino server LDAP base: Leave blank. 9 P a g e
Domain name alias (e.g. notify): The NotifySCM domain that end users may use to login into the workspace. With the domain domino end users will be allowed to login with username or username@domino. LDAP Query User: A query user with read rights (Any mail account can work as Query user). LDAP Query Password: The password of the above query user. Step 4: SSL certificate import or generate key If you want to generate a new server certificate, click on the Generate certificate button. Server hostname or IP is the name of the machine for which the certificate is being generated (usually this one). Figure 8: Generate/import certificate key If you want to use a dedicated certificate for this appliance, you can import it by selecting a PKCS12 file and entering the private key password. Figure 9: Generate certificate success 10 P a g e
Step 5: NotifySCM URL This URL allows you to select the external address (or IP) that will be used to download the NotifySCM device application. The address must be entered as it will be seen from the internet. Figure 10: Set Download URL If you do not use a firewall, NotifySCM will listen to http connection on port 8080 or https connection on port 8443. 11 P a g e
If you are not using a trusted SSL certificate, please enter the URL that has been given by Notify Technology Corporation. This URL should follow the scheme https://<poc.company.com>. This redirection will be used only for download. No sensitive information will go through Notify Technology server. 12 P a g e
Step 6: Email settings Enter the settings that match your mail server: Server type (e.g. Exchange, Office365 or Domino): Select the type of mail server you have according to the synchronization parameter you used at step 5. If you select Office365, Use SSL/Bypass SSL - Hostname options will be automatically filled in. Hostname (e.g. exchange.company.com): The hostname or ip address of your mail server. Use SSL: Select it if your Exchange server needs to be connected with an SSL connection. For Domino, please follow instructions in the knowledge base article: Enable SSL Connection Between NotifySCM and IBM Domino Bypass SSL: Bypass SSL must be selected if your mail server does not use an SSL certificate signed by a trusted CA or uses a self-signed certificate. Username and password for test: Enter username or password if you want to test entered information. Figure 11: Email settings 13 P a g e
Step 7: Document Server Settings This screen allows setting of the CMIS connector details: Full URL is the location of the CMIS connector information. Bypass SSL is used when the connector requires SSL connection, but there are some issues with certificates. You can test your connection settings with Test Connection button. Figure 12: Document server settings 14 P a g e
Step 8a: Installer Processes The Pack installation progress bar will appear and complete. Step 8b: Installer Processes Figure 13: Pack installation progress The processing installer jobs will scroll and finish. Figure 14: Installation jobs progress 15 P a g e
Step 8c: Installer Processes The installation is complete! Figure 15: Installation done 16 P a g e
4 STARTING THE SERVER Once the installation completes, the NotifySCM server service is configured to start automatically when your machine boots. If you open the 'Services.msc' console, you can manually start the NotifySCM server without restarting your entire server. Figure 16: starting sense services Wait until the server starts and then test whether the server is running by going to the web page from your VM http://localhost:8080/sense/secserver If you see a login page like this: Well done, your server is working! 17 P a g e