Top

On-Premise Installation - Instructions

This section will give instructions on how to install ConceptShare on a single server instance (all services on the same box). These instructions do NOT include pre-requisite setup and/or configuration.

  1. Extract the install client on the ConceptShare server to a desired location (this document will assume C:\InstallClient).
  2. Copy your license file (.LIC) to the Licenses folder (C:\InstallClient\Licenses).
  3. Launch the installer (C:\InstallClient\ConceptShare.V4.Installer.exe) and you should be presented with a screen similar to the one below.

  1. Select on “Configure Settings” and click the “Change” button. You will be presented with the settings which can be configured via the installer similar to the screenshot below. 

  1. Fill out the installer settings for your particular environment paying particular attention to the following areas:
    1. Instance Administrator – Set the name, email, and password for the user who will be the ‘super user’ for the ConceptShare installation. Remember these credentials as they will be used later on to create your first ConceptShare account.
    2. Database - Database credentials are what the application components will use to access the database.
      1. If you are using Windows Authentication it should be noted that the Queue Windows Service and IIS Application Pool MUST run under credentials that have access to the SQL database. In this scenario just set the “Database – Authenticate Type” to “Windows”, the other two settings (Sql Username/Password) will be ignored.
      2. If you are using SQL authentication, set the username and password you would like to use.
    3. Database – The remaining database settings are the name of the ConceptShare database to create, and the server location (which for this deployment scenario is ‘localhost’). If you have a named instance be sure to include it here (i.e. localhost/ConceptShare).
    4. Location – The location settings are where the data files should be stored. By default all data is stored in C:\ConceptShare. If you would like to store data on a different drive or even a network location you would specify them here. For example: Location – Data Directory could be: \\192.168.1.2\CSData\Assets. NOTE: The ConceptShare Queue windows service and the application pool within IIS must use credentials that have access to these locations. Furthermore, the DB location must also be writable by the SQL Server identity.
    5. Queue Service – These settings determine the name of the Windows Service for the ConceptShare Queue as well as the identity to run under. In a single server deployment scenario where all data resides on the same server, Local System identity is typically sufficient. If you are using a custom user identity change “LocalSystem” to “User” and specify the credentials in the settings.
  2. Once the settings are configured, click Save and return to the main installation screen. Note: Settings are stored in your license file (LIC). You are ready to begin using the Installer to deploy ConceptShare.
  1. With the ConceptShare Installer launch and settings configured, highlight the “Manage Database” option and click the “Manage” button. You should see a screen similar to the one below. 

  1. The settings at the top are pre-populated with the credentials from your installer settings. These settings will be used during this step, so there is an option to test the settings to make sure they work. Click “Test Connection” to make sure the settings are valid, if not, adjust your settings accordingly.
  2. Pre-flight configuration should only be once per installation of an instance. This step restores a template database to SQL server, and ensures the .NET CLR is enabled.
  3. In a single server deployment all steps can be done from within the installer if required.
    1. In the scenario where you want to use the installer to do the ‘leg-work’, just ensure that the ‘Perform Pre-flight Configuration’ option is selected and click “Run Scripts”. Once pre-flight is complete a template database should have been restored to the SQL server and .NET CLR enabled. If an error occurred it usually has to do with the level of credentials used. For example, enabling the CLR typically requires a sysadmin role.
    2. If you have a deployment configuration where the SQL server instance is on a separate machine or if you wish to review and perform these steps manually (for instance by your DBA), you can do the following:
      1. Uncheck all pre-flight options with the exception of the “Restore Template Database” option. Click “Preview Scripts”. This will generate the scripts that the installer will perform using your supplied credentials. At this point you can review the script, and if acceptable just have the installer run it. However, in the case where the SQL server is on a different machine, you’ll need to copy some data, and change some the script as noted below:
      2. Copy the database template file (C:\InstallClient\Data\DB\BASE.BAK) to the SQL Server where you want it placed (this document assumes you saved it to C:\CS_DB).
      3. The default restore script will look something like the one below. Since the locations are different on your SQL server, you will have to change the restore file location and the move locations for the database files. A sample altered script is below using a typical database path for SQL Server, yours may vary.
      4. Once you have replaced the restore step with your appropriate locations and successfully executed the restore step on the SQL server, the remaining pre-flight steps can be performed (either manually or by the installer). Uncheck the “Restore Template Database” and check all the remaining pre-flight options. If you are having the installer do these steps, click “Run Scripts”, otherwise preview the scripts, copy, review and execute them on your SQL Server instance.
      3. Regardless of deployment method (separate server, single server) the pre-flight steps should now be all completed.
  1. Now that the template database is restored, we now need to stamp your particular license details into the database. This is the “Initialize Database” step. Highlight the “Initialize Database” option and click the “Initialize” option. If the pre-flight steps were completed successfully this step should return with a message stating that everything was successfully initialized.

NOTE: This step does NOT affect any data. No data (other than contractual details) is changed or modified at this time. Your assets, commenting and other data will remain intact.

  1. At this point, the database is installed, configured, and ready for use!

 

 

  1. From the main installer application window, select “Initialize File System” and click “Install”.
  2. Ensure the base path is correct where the location of your data files is, and click “Deploy”. The installer will copy the data files to their specified locations for use with ConceptShare.

 

  1. ConceptShare uses a windows service to process files, event management, email processing, etc. This step will install that service. All settings are pulled from the Installer settings including the credentials to use. From the main installer application window, select “Manage ConceptShare Queue Server” and click the “Manage” button.
  2. Since this is a new installation, the first (pre-selected) option is what we want to do. Clicking on the Install button will create the windows service and copy the appropriate queue files to the queue application folder and generate the appropriate configuration file. NOTE: You must have sufficient credentials to create a windows service.
  3. Once complete, the windows service should be visible via the Services snap-in under Administrative Tools within Windows. If appropriate credentials were given, the windows service should also be able to start.
  1. From the ConceptShare Installer main application form, select “Manage ConceptShare Website”, ensure the path selected is the desired location for the website files and click “Deploy”. This will install the required files and setup the appropriate settings in the web.config file.
  2. Open up the IIS snap-in and navigate to Application Pools. Click “Add Application Pool” on the right hand-side. Create an application pool named “ConceptShare”, choose “.NET Framework v4.0.30319” for the framework version and choose “Integrated” for the pipeline mode.

  1. Once created, highlight it from the list and click on “Advanced Settings” on the right-side. Change the following settings (you can configure additional settings as required):
    1. Enable 32-Bit Applications: True
    2. Identity: Set to an identity with sufficient privileges to access files. If all files reside on the system and you don’t want to use a custom account you can choose LocalSystem. Note: These credentials must also have access to the SQL database if you choose Windows Authentication for the application user credentials.
    3. Load User Profile: True
  2. If ConceptShare is the only website being hosted on the web server, you can delete the “Default Web Site”.
  3. Right-click on the “Sites” node within IIS, and choose Add Web Site.
    1. Under Site Name, enter “ConceptShare” and for the Application Pool, select the ConceptShare application pool you created in step 2.
    2. The physical path should point to the location where you selected ConceptShare website files to reside (C:\ConceptShare\website).
    3. If you have to bind ConceptShare to a specific IP address, restrict to a specific hostname, or apply SSL you would do so at this stage. Generally most deployments leave IP unassigned, and hostname blank. NOTE: Self-signed certificates are not compatible with ConceptShare when uploading via the User-Interface.
    4. For the ConceptShare API to work properly you can only have one HTTP and one HTTPS binding per website. Multiple HTTP/HTTPS bindings will cause the API to fail.
    5. Once satisfied with the settings click OK to create the website.
  4. At this point the website should be setup within IIS. Highlight the website from within IIS and on the right there should be an option to “Browse” the website. If everything is successful when you attempt to browse the website you should be redirected to www.conceptshare.com. The reason for this is because we do not have an account configured in ConceptShare for this domain.

 

  1. Assuming your website is resolvable via localhost, navigate to the administration panel by going to the following location: http://localhost/AdminPanel. You should be presented with a login screen. The instance administrator you configured in your installer settings are the credentials that will work for the administration panel. Login into the administration panel with those credentials and should see a screen similar to the one below.
  2. Click on the “Instance Settings” tab.
  3. There are several sections you’ll want to pay particular attention to:
    1. Email Settings – This is where you should fill out your SMTP settings so that emails generated by ConceptShare can be sent.
    2. Location Settings – This section is the various paths where ConceptShare will locate files. Most of these paths should be accessible by all ConceptShare servers by using a central location. This section is CRITICAL and must be set properly for ConceptShare to work.
    3. Maintenance Settings – This section is used to determine data retention policies of ConceptShare data.
  1. Assuming your website is resolvable via localhost, navigate to the administration panel by going to the following location: http://localhost/AdminPanel. You should be presented with a login screen. The instance administrator you configured in your installer settings are the credentials that will work for the administration panel. Login into the administration panel with those credentials and should see a screen similar to the one below.
  2. Click on the “Accounts” tab and then click on “New Account”.
  3. Enter the settings for the account as follows:
    1. Is Active – Checked.
    2. Owner Email – The instance administrator email address.
    3. Account Name – The name for your ConceptShare account.
    4. Domain – The domain in which people will access ConceptShare. This domain appears in emails regardless if other aliases are used. An example domain would be: conceptshare.yourcompany.com/
    5. Header Text: This is the text that will appear in the header bar or title of the browser window. Typically this is the same as the account name.
    6. Package: Typically you only have one package choice, but in the case your contract specifies multiple, select the appropriate package.
    7. User Limit: This is the number of users to assign to the account. Most installations only have one account so you can assign all the users in your contract to this account.
    8. Storage/Storage Per User: This field will determine the amount of storage available to the ConceptShare account. It is a good idea to leave a buffer in terms of space vs actual physical storage so that the system doesn’t halt due to lack of space. Also, ConceptShare only calculates storage based on actual assets and their proxies and does not include temporary files, system files, and supporting files (thumbnails, page extractions, etc.). As a general rule, if you take 50% of your total storage and make that your ConceptShare limit you should be safe. The difference between Storage and Storage per User is that Storage is fixed total amount regardless of user count. The other method allows you to assigned storage based on the number of users in an account. For example if you want to assign 1GB for every user you would put that in Storage Per User. Note: There is a storage calculator off to the right as the textboxes require storage amounts to be in bytes.
  4. Once all settings are configured, click “Save”, then click “Search”. The account should be listed and if you click on the “Primary Domain” field, you should be either presented with the ConceptShare login screen, or in case where the primary domain is the current domain you are on (i.e. localhost) you should be auto-logged in.

 Congratulations!

 

You have successfully navigated the instructions for establishing your On Premise deployment.


 

Further Reading

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request