Setting Up the Enhanced Document Storage Solution

NetForum Enterprise provides two document storage options to choose from: local storage and the new Enhanced Document Storage solution. A new section has been added to all config files that configures the Storage Provider in iWeb, eWeb, and xWeb, where configuration details can be entered, such as Provider Type, Purposes, AccessKeyId, SecretAccessKey, AwsS3BucketName, and AwsS3RegionEndpoint.

To upgrade document storage from the local storage option to the Enhanced Document Storage (cloud) solution, customers should contact their NetForum Enterprise implementation representative for assistance.

Web Config File

The config file has Amazon S3 and Local settings under the Storage Configuration section.

For Local Storage:

<StorageConfigItem ProviderType="Avectra.netForum.Common.StorageProvider.LocalStorageFactory, common" Purposes="Default,CacheProvider,Import,Test" />

For Amazon S3 Storage:

<StorageConfigItem ProviderType="Avectra.netForum.Common.StorageProvider.AwsS3StorageFactory, common"

Purposes="Default,CacheProvider,Import,Test"

AccessKeyId=""

SecretAccessKey=""

AwsS3BucketName=""

AwsS3RegionEndpoint=""/>

Config Options

To simplify the config execution, some of the command line arguments were moved to the config file. Only the section of the config that needs modification is mentioned below. If a section is not mentioned below that section of the config file should not be modified.

Note: The values mention in the examples below are sample values for reference only and should not be used for configuration.

 

Section Name: configSection

Contents: a section that outlines the storage solution configuration

Purpose: assist with the connection to the new storage solution selected by the user

Example:

<section name="StorageConfiguration" type="Avectra.netForum.Common.StorageProvider.RegisterStorageConfigSection, common" />

 

Section Name: connectionStrings

Contents: connection strings

Purpose: provide the necessary information to connect to the database being converted. For ease of use you can simply copy the connection strings from the current iWeb web.config file.

Example:

<add name="sqlConnectionString" connectionString="Data Source=[server];Initial Catalog=[database];Trusted_Connection=Yes" providerName="System.Data.SqlClient"/>

 

Section Name: appSettings

Contents: key value pairs

Purpose: contain values that would be difficult to pass in as command line arguments; primarily directory locations of folders

Note: the key “commonRoot” will be used as the default for any other location except key “moveFolder”. The key “moveFolder” is required when finalize action is set to move.

Example:

<add key="commonRoot" value="c:\temp"/>

 

Section Name: StorageConfiguration

Contents: storage configuration items

Purpose: provide the necessary details for the conversion app to connect to the new storage solution selected by the customer. For ease of use you can copy the section from the current iWeb web.config file.

Example:

<!--

Alternative declaration of StorageConfigItems is to add a PurposeObjectMapPath which is a full path to an override config file that overrides the default PurposeObjectMap. Learn more about PurposeObjectMap and it's usage via help.

<StorageConfigItems PurposeObjectMapPath="C:\path\StorageProviderPurposeConfig.xml">

-->

<StorageConfigItems>

 

<StorageConfigItem

ProviderType="Avectra.netForum.Common.StorageProvider.LocalStorageFactory, common"

Purposes="Default,CacheProvider,Import,Test" />

<!--

Alternative Providers. You can have multiple providers for different purposes as defined in the PurposeObjectMap. You can override the PurporseObjectMap via the PurposeObjectMapPath shown above in the StorageConfigItems declaration.

 

[Amazon S3 Example]

<StorageConfigItem

ProviderType="Avectra.netForum.Common.StorageProvider.AwsS3StorageFactory, common"

AccessKeyId="<Your S3 Access Key Goes Here, must encrypt using nfc.exe -ecrypt [key]>"

SecretAccessKey="<Your S3 Secret Access Key Goes Here, must encrypt using nfc.exe -ecrypt [key]>"

AwsS3BucketName="<Name of Amazon Bucket goes here. This is the root folder for all NetForum files for this customer.>"

AwsS3RegionEndpoint="<The Amazon region display name goes here. This is an enum lookup so use the Amazone RegionEndpoint

lookups not the region name from Amazon. Exmaple: "USEast1", not us-east-1/>

 

<StorageConfigItem

ProviderType="Avectra.netForum.Common.StorageProvider.AwsS3StorageFactory, common"

AccessKeyId="uenqHpxbJdacDc4vOrInuf7yg1x5m3JT"

SecretAccessKey="y6S0+DZm45sERNN9oKiVA+wQcnX5RyuvOgVQunLXNEFKKXdvumTMXt9QCrnKqwQz"

AwsS3BucketName="netforumenterprise.dev.customer1.files"

AwsS3RegionEndpoint="USEast1" />

[Supported Amazone Region Names]

USEast1,USEast2,USWest1,USWest2,EUNorth1,EUWest1,EUWest2,EUWest3,EUCentral1,APNortheast1,APNortheast2,APNortheast3,

APSouth1,APSoutheast1,APSoutheast2,SAEast1,USGovCloudEast1,USGovCloudWest1,CNNorth1,CNNorthWest1,CACentral1

-->

</StorageConfigItems>