Enterprise Azure Configuration Options

<< Click to Display Table of Contents >>

Navigation:  Enterprise > Configuration >

Enterprise Azure Configuration Options

Configure log4net.config File Logging

Configure Formats Folder

Configure the Workfolder for Enterprise Workflow (WebJob)

Configure ZipTempFolder

How to Restart Workflow WebJob

Override Default BaseUri with WEBSITE_FQDN Setting

 

After completing an Enterprise 7 Azure installation, a variety of configuration settings should be implemented to ensure proper operation of the Enterprise site. For language culture configuration, please refer to Languages article.

 

 

Configure log4net.config File Logging

1.Select your Web App from list of Web App Services.

2.Scroll down and select Advanced Tools (aka Kudu).

3.Click Go to start Kudu.

a.Click Debug console > CMD.  

b.At the command prompt, execute the following command:

  mkdir equislogs

c.Go into .\site folder.

d.Go into .\wwwroot folder.

e.Go into .\bin folder.    

f.Scroll down to the log4net.config file and click the Edit (pencil) icon.  

i.Uncomment RollingLogFileAppender (about lines 11-22).

ii.Set the file path (about line 12) to value="D:\home\equislogs\{process}.log". Use of the "D:\home\" path is necessary to work in Azure as "D:\local\temp" path does not have the appropriate permissions.

iii.If desired, scroll down and change logging level (about line 120). (Please do NOT use extensive logging for more than a short period of time.)

iv.Uncomment the RollingLogFileAppender within <root> (about line 121).

v.Click the Save button.

 

 

Configure Formats Folder

1.Select your Web App from list of Web App Services.

2.Scroll down and select Advanced Tools (aka Kudu).

3.Click Go to start Kudu.

a.Click Debug console > CMD.

b.Navigate to D:\home\.

c.Run the following cp command to copy the Formats folder from the application directory to the root directory.

cp -rfv D:\home\site\wwwroot\Formats D:\home\

 

In the ST_CONFIG table, the format definitions need to point to D:\home\Formats\. See the efdManagementConfiguration.EFD configuration article for more details.

 

Example

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

efdManagementConfiguration

efd

EQEDD

xsdFileName

D:\home\Formats\EarthSoft\EQEDD.zip

 

 

Configure the Workfolder for Enterprise Workflow (WebJob)

1.Select your Web App from list of Web App Services.

2.Scroll down and select Advanced Tools (aka Kudu).

3.Click Go to start Kudu.

a.Click Debug console > CMD.

b.At the command prompt, execute the following command:

mkdir workfolder

 

In the ST_CONFIG table, the Workfolder needs to point to D:\home\workfolder. See the efdManagementConfiguration.EFD configuration article for more details.

 

Example

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

efdManagementConfiguration

workfolder



D:\home\workfolder

 

 

Configure ZipTempFolder

1.Select your Web App from list of Web App Services.

2.Scroll down and select Advanced Tools (aka Kudu).

3.Click Go to start Kudu.

a.Click Debug console > CMD.

b.Navigate to D:\home\workfolder\

c.At the command prompt, execute the following command:

mkdir zip

 

In the ST_CONFIG table, the ZipTempFolder needs to point to D:\home\workfolder\zip. See the EarthSoft.Common.Utilities.File.zipTempFolder configuration article for more details.

 

Example

 

CONFIG_SECTION

CONFIG_KEY

OBJECT_TYPE

OBJECT_VALUE

STRING_VALUE

EarthSoft.Common.Utilities.File

ZipTempFolder



D:\home\workfolder\zip

 

 

How to Restart Workflow WebJob

 

Note: Only one Workflow should be running for each Web App. Multiple instances of Workflow on a single Web App may result in conflicting operations and is not supported by EarthSoft.

 

The Workflow WebJob may require restarting after making changes to configurations (ST_CONFIG settings). If changes are made, the following steps will restart the Workflow:

1.Select your Web App from list of Web App Services.

2.Scroll down to WebJobs.

3.Select Workflow job.

4.Click Stop; wait for job to stop. (Try the Refresh button if it does not show "Stopped" after several seconds.)

5.Click Start; wait for job to start.

 

 

Override Default BaseUri with WEBSITE_FQDN Setting

 

EQuIS Enterprise uses the site's "BaseUri" in functionality like tokens, Microsoft Entra ID — formerly known as Azure Active Directory (AAD) — authentication redirects, etc. In some scenarios, users may want to manually override the domain name used in the BaseUri. For example, users may be using a service like Azure Front Door that configures a user-facing domain name of "external.example.org", but the actual Azure App Service Web App (running EQuIS Enterprise) is "example-equis.azurewebsites.net". All tokens, Microsoft Entra ID redirects, etc. should use the user-facing domain name (i.e., external.example.org) instead of the actual Web App domain name.

 

Normally, the BaseUri is inferred based on the incoming HTTP request URI. However, in the above scenario, Azure Front Door forwards the HTTP request to the Azure Web App, so the request targets the Web App domain, not the user-facing domain. To override the default functionality, follow these steps:

Login to your Azure portal (https://portal.azure.com).

Go to the Configuration blade for the Web App.

Under Application settings, click "+ New application setting".

Set the name of the new setting to "WEBSITE_FQDN" (all uppercase, without quotes).

Set the value of the new setting to the user-facing domain name that you want to use, e.g. "equis.mydomain.com" (do not include quotes or any virtual directory name).

Click OK to add the new setting.

Click Save (and Continue) to save the new setting (this should automatically restart the Web App).

 

Adding the setting in the Configuration creates an environmental variable with the same name and value. The EQuIS Enterprise application looks for the WEBSITE_FQDN environment variable. As such, the same functionality could be achieved on a Windows web server (running IIS) by creating the WEBSITE_FQDN environment variable.

 

The WEBSITE_FQDN (if defined) will be used instead of the domain found in the incoming HTTP request URI. Any applicable virtual directory name (if present) is not affected. As such, this functionality can be used in conjunction with the "single physical directory, multiple virtual directory" method of deploying multiple Enterprise instances from a single Azure Web App. For example, you may have virtual paths of /clienta and /clientb that both map to the physical path at site\wwwroot. In this example, a single setting at the Web App level should make "example-equis.azurewebsites.net/clienta/default.aspx" appear as "external.example.org/clienta/default.aspx" and "example-equis.azurewebsites.net/clientb/default.aspx" appear as "external.example.org/clientb/default.aspx".