15-20 min set-up time
Disclaimer: This guide is intended for product versions 2.9.0.0 and greater.
Connection Profile
If you do not already have a Connection Profile configured, you will be prompted to create one on startup.
By clicking the Create Connection Profile button or the Gear Icon in the lower left-hand corner, the settings menu will be opened.
The default tab is Connection Settings. If not already selected, navigate to the connection settings tab.
Start by giving you connection a Name and default Email Login.
Note: If you plan to use a third-party authentication provider (i.e. Azure AD, Okta, etc.) you do not have to provide a default Email Login
Service Connection Setup
If connecting directly to a LemonEdge database, please continue to the next section.
To configure a service connection, use the Connection Type dropdown to select Service.
By selecting Service, the system will automatically attempt to retrieve supported Login Methods. At first, this will fail until we provide a valid Service URI.
Enter in your Service URI. This should be provided to you by your system administrator or your LemonEdge implementation manager.
Note: Once you've entered in the Service URI, the available Login Methods should update automatically. If they do not, click the Refresh button directly left of the Login Method dropdown box.
If a Login Method and valid Service URI is provided, the Check Connection and Save button should now be enabled.
If the Login Method must be changed, do so now. A Service Connection supports the following Login Methods:
Web Service Direct: If logging in using an email and password combination
Azure Active Directory: If logging in using your administration's Microsoft account.
Azure AD B2C: If logging in with a valid B2C account.
Okta: If logging in using Okta third-party authentication.
If you are unsure of which option to select, contact your system administrator or your LemonEdge implementation manager.
You may now click Check Connection to ensure the provided details are valid or Save to save your settings.
Note: You must save your changes prior to leaving the Connection Settings tab.
Navigate back to the Login Page by clicking the arrow icon in the top-left corner. You should now see an email and password field.
Note: If you are using a Login Method other than Web Service Direct the email and password field will be disabled.
Database Connection Setup
To configure a database connection, use the Connection Type dropdown to select Database if not already.
Enter in the Server and Database Name information. If using Integrated Security tick the checkbox, otherwise enter in the Database Username and Database Password.
Once a valid configuration has been set, the Check Connection and Save buttons will be enabled.
You may now click Check Connection to ensure the provided details are valid or Save to save your settings.
Note: You must save your changes prior to leaving the Connection Settings tab.
Navigate back to the Login Page by clicking the arrow icon in the top-left corner. You should now see an email and password field.
Multiple LE Instances
If you are running multiple instances of LemonEdge, you may optionally add a Profile ID to the configuration options found in appsettings.json. Just open the appsettings.json file local to your instance of LemonEdge and add the following:
{
"LemonEdge":
{
"ClientSettings":
{
"ProfileId": "<YOUR-PROFILE-IDENTIFIER>"
},
...
}
}
The profile ID can be anything you'd like such as UAT, Production, Client1, etc. This configuration simply ensures that a created connection profile is not shared or overwritten by any other instance of LemonEdge.
Comments
Please sign in to leave a comment.