Wyn Enterprise Administration Guide

Wyn Enterprise: Installing on WindowsOS

To install and use Wyn Enterprise on WindowsOS, you need the following environment.

Requirements

Framework

.NET Framework 4.6.1

Operating System

Windows 10
Windows Server 2016

Browser

Internet Explorer 11 and above, Microsoft Edge, Google Chrome, and Safari.

Note : Before installing, please disable the anti-virus software on your computer. Such software can interfere with the installation and functionality of Wyn Enterprise.

To Install

Download and execute the installer (.exe) as System Administrator. The installer will prompt you to install PostgreSQL.
Click Next to start its installation.
Confirm the software agreement, set the installation directory, and click Next.
Select the components you want to install. By default, all the components are selected. Click Next to continue with the installation.
In the Software Registration form, fill in the details, and click install.

The installation progress is displayed.
Choose from the built-in or custom database and click Start Program to continue.
Depending on your OS, the installer may ask for your permission to install one or two operating system updates during installation. Wait until the installation is finished.

After the installation is complete, click Open Portal to open Wyn Enterprise portal - http://localhost:51980/ in the browser. The default credentials that should be used are:
Username: admin
Password: admin

Following are the installer-added services:

WynDatabase: Maintains a PostgreSQL database.
WynService: Hosts several processes to maintain Wyn Enterprise websites and other modules.

Default Ports

Wyn Enterprise uses the following ports by default.

Server: 51981
Portal: 51980
Reporting Worker: 51982
Identity Service: 51980

You can reassign the ports in the config file.

To Configure

You can change Wyn Enterprise behavior by modifying the primary config file Wyn.conf, located here - C:\Program Files\Wyn Enterprise\Monitor\. The changes are applied after the WynService is restarted. All settings have default values, if you want to change the default value, just uncomment the line and change the value.

Wyn.conf

<SystemConfig xmlns:sys="https://extendedxmlserializer.github.io/system" xmlns="clr-namespace:ConfigMigration.Configuration.V40;assembly=ConfigMigration">
  <!-- The version of current configuration file, DO NOT MODIFY IT. -->
  <Version>4.0</Version>
  <!-- The global settings for those services listed bellow. -->
  <GlobalSettings>
    <!-- The url of the identity service which in charge of user authentication. -->
    <IdentityServerUrl>http://localhost:51981</IdentityServerUrl>
    <!-- Determines which level log events are generated, available values: Debug, Information, Warning and Error -->
    <LogLevel>
      <Default>Information</Default>
      <Override>
        <sys:Item>
          <Key>System</Key>
          <Value>Warning</Value>
        </sys:Item>
        <sys:Item>
          <Key>Microsoft</Key>
          <Value>Warning</Value>
        </sys:Item>
      </Override>
    </LogLevel>
    <!-- A value indicates how many times to try to restart the crashed service, -1 means infinite. -->
    <TryRestartCount>-1</TryRestartCount>
    <RedirectOutputOfService>false</RedirectOutputOfService>
  </GlobalSettings>
  <Services>
    <!-- Server service for management all the documents in Wyn. -->
    <Server>
      <Name>Server</Name>
      <!-- The listening address of server. -->
      <Urls>http://*:51981</Urls>
      <!-- The available plugins. -->
      <Plugins>
        <sys:string>Plugins/Dashboard/Gces.Dashboards.Plugin.dll</sys:string>
        <sys:string>Plugins/Reporting/Gces.Reporting.Plugin.dll</sys:string>
        <sys:string>Plugins/Dataset/Gces.Dataset.Plugin.dll</sys:string>
        <sys:string>Plugins/Account/Gces.Account.Plugin.dll</sys:string>
      </Plugins>
      <!-- The database settings for data extractor. -->
      <DataExtraction>
        <!-- The database provider, the supported data providers include 'Postgres', 'MySql', 'SqlServer', and 'Oracle'. -->
        <StorageType>Postgres</StorageType>
        <!-- The database connection string. -->
        <ConnectionString>Host=localhost;Port=5444;UserName=wyn-enterprise;Password=Wr8TGfe2r0;Database=wyndatacache;</ConnectionString>
      </DataExtraction>
      <!-- The database settings for server. -->
      <Storage>
        <!-- The database provider, the supported data providers include 'Postgres', 'MySql', 'SqlServer', and 'Oracle'. -->
        <StorageType>Postgres</StorageType>
        <!-- The databsae connection string. -->
        <ConnectionString>Host=localhost;Port=5444;UserName=wyn-enterprise;Password=Wr8TGfe2r0;Database=wynserverdata;</ConnectionString>
      </Storage>
      <IdentityServer>
        <!-- The valid identity server providers include 'External', 'Server' and 'Portal', the default value is 'Server'. -->
        <Provider>Server</Provider>
        <!-- The database provider for identity server, the supported data providers include 'Postgres', 'MySql', 'SqlServer' and 'Oracle'. -->
        <StorageType>Postgres</StorageType>
        <!-- The database connection string for identity server. -->
        <ConnectionString>Host=localhost;Port=5444;UserName=wyn-enterprise;Password=Wr8TGfe2r0;Database=wynis;</ConnectionString>
      </IdentityServer>
      <Cookie>
        <!-- Whether to share cookie with portal, the value must be 'true' if you use 'Server' as the identity server provider. -->
        <ShareCookie>true</ShareCookie>
        <!-- The name of cookie. -->
        <CookieName>wyn.sc</CookieName>
        <!-- The data protection key for encrypting and decrypting the cookie data. -->
        <DataProtectionKey>ifioEFEF8y8Fy3fp</DataProtectionKey>
        <!-- Default value 'Lax'. -->
        <SameSite>Lax</SameSite>
        <!-- The 'secure' should be set to 'true' if your portal is deployed over HTTPS protocol. -->
        <Secure>false</Secure>
      </Cookie>
    </Server>
    <!-- The portal service for user experience. -->
    <Portal>
      <Name>Portal</Name>
      <!-- The listening address of portal. -->
      <Urls>http://*:51980</Urls>
      <!-- The 'DependsOn' indicates which services are depended on to run current service. -->
      <DependsOn>
        <sys:string>Server</sys:string>
      </DependsOn>
      <!-- Indicate that if you want to use HTTPS connection. -->
      <RequireHttps>false</RequireHttps>
      <!-- The web application URLs you want to authorize to in your identity service. -->
      <AuthorizedWebApplicationUrls>
        <sys:string>http://localhost:51980</sys:string>
      </AuthorizedWebApplicationUrls>
      <IdentityServer>
        <!-- The valid identity server providers include 'External', 'Server' and 'Portal', the default value is 'Server'. -->
        <Provider>Server</Provider>
        <!-- The database provider for identity server, the supported data providers include 'Postgres', 'MySql', 'SqlServer' and 'Oracle'. -->
        <StorageType>Postgres</StorageType>
        <!-- The database connection string for identity server. -->
        <ConnectionString>Host=localhost;Port=5444;UserName=wyn-enterprise;Password=Wr8TGfe2r0;Database=wynis;</ConnectionString>
      </IdentityServer>
      <Cookie>
        <!-- Whether to share cookie with server, the value must be 'true' if you use 'Server' as the identity server provider. -->
        <ShareCookie>true</ShareCookie>
        <!-- Default value 'Lax'. -->
        <SameSite>Lax</SameSite>
        <!-- The name of cookie. -->
        <CookieName>wyn.sc</CookieName>
        <!-- The data protection key for entrypting and decrypting the cookie data. -->
        <DataProtectionKey>ifioEFEF8y8Fy3fp</DataProtectionKey>
        <!-- The 'secure' should be set to 'true' if your portal is deployed over HTTPS protocol. -->
        <Secure>false</Secure>
      </Cookie>
      <!-- External authentication settings. -->
      <Authentication>
        <!-- The OAuth authentications allowed to login to Wyn. -->
        <OAuth>
          <sys:Item>
            <!-- The unique identifier of the OAuth authentication. -->
            <Key></Key>
            <Value>
              <!-- The disaplay name of current OAuth authentication, this name will be displayed in login page. -->
              <DisplayName></DisplayName>
              <ClientId></ClientId>
              <ClientSecret></ClientSecret>
              <AuthorizationEndpoint></AuthorizationEndpoint>
              <TokenEndpoint></TokenEndpoint>
              <UserInformationEndpoint></UserInformationEndpoint>
              <CallbackPath></CallbackPath>
              <Scopes>
                <sys:string></sys:string>
                <sys:string></sys:string>
              </Scopes>
              <ClaimMappings>
                <!-- The user id claim type of current OAuth authentication. -->
                <Id></Id>
                <!-- The user name claim type of current OAuth authentication. -->
                <Name></Name>
                <Surname></Surname>
                <GivenName></GivenName>
                <Email></Email>
                <MobilePhone></MobilePhone>
                <Avatar></Avatar>
              </ClaimMappings>
            </Value>
          </sys:Item>
        </OAuth>
      </Authentication>
      <Backend>
        <!-- The host address of server. -->
        <Host>localhost</Host>
        <!-- The listening port of server. -->
        <Port>51981</Port>
      </Backend>
      <!-- The database provider for embedded identity service, the supported data providers include 'Postgres', 'MySql', 'SqlServer', 'Oracle' and 'Firebird'. -->
      <StorageProvider>Postgres</StorageProvider>
      <!-- The database connection string for embedded identity service. -->
      <ConnectionString>Host=localhost;Port=5444;UserName=wyn-enterprise;Password=Wr8TGfe2r0;Database=wynis;</ConnectionString>
      <Cors>
        <!-- The allowed origins for CORS. -->
        <AllowOrigins></AllowOrigins>
        <!-- The allowed headers for CORS. -->
        <ExposedHeaders>Location;Content-Disposition</ExposedHeaders>
      </Cors>
    </Portal>
    <!-- Reporting worker for rendering the reports. -->
    <Worker>
      <Name>Reporting Worker</Name>
      <!-- The listening address of reporting worker. -->
      <Urls>http://localhost:51982</Urls>
      <DisplayName>reporting-worker</DisplayName>
      <DependsOn>
        <sys:string>Server</sys:string>
      </DependsOn>
      <WorkerBackend>
        <!-- The address of back-end server. -->
        <ServerUrl>http://localhost:51981</ServerUrl>
      </WorkerBackend>
    </Worker>
    <!-- COT worker for calculating the dataset result for dashboards. -->
    <CotWorker>
      <Name>Cot Worker</Name>
      <!-- The listening address of COT worker. -->
      <Urls>http://localhost:51983</Urls>
      <DisplayName>cot-worker</DisplayName>
      <DependsOn>
        <sys:string>Server</sys:string>
      </DependsOn>
      <WorkerBackend>
        <!-- The address of back-end server. -->
        <ServerUrl>http://localhost:51981</ServerUrl>
      </WorkerBackend>
    </CotWorker>
  </Services>
</SystemConfig>

Installed Files

The Wyn Enterprise files are installed in Program Files, whose values are relative with operation system settings.

File Name	Location
CotWorker	\Wyn Enterprise\
logs	\Wyn Enterprise\
Monitor	\Wyn Enterprise\
Plugins	\Wyn Enterprise\
Account	\Wyn Enterprise\Plugins\
Dashboard	\Wyn Enterprise\Plugins\
DataSet	\Wyn Enterprise\Plugins\
Reporting	\Wyn Enterprise\Plugins\
Portal	\Wyn Enterprise\
ReportingWorker	\Wyn Enterprise\
sampledata	\Wyn Enterprise\
Server	\Wyn Enterprise\
Tools	\Wyn Enterprise\

Publish Wyn Enterprise Portal to Internet

By default newly installed Wyn Enterprise can be accessed only via local machine for security reasons.

If you want to make Wyn Enterprise accessible for other machines (on intranet and internet), you need to configure the Wyn Enterprise manually. For more information, see To Configure.

Uninstall Wyn Enterprise

Go to Settings > Add or Remove Programs.
Click Uninstall.

or

Run Wyn Enterprise installer.
Select Remove database if you do not want to preserve the database on uninstalling.
Click Uninstall.