File-level configuration
When creating or editing an *.onesrv file adding the following part is a file-level way to configure the authentication:
<RequiresAuthentication>false</RequiresAuthentication>
<ServiceUserImpersonate>
<UserName>john@doe.com</UserName>
<Password>plain-text-password</Password>
</ServiceUserImpersonate>
Element | Description | ||||||
---|---|---|---|---|---|---|---|
RequiresAuthentication | Boolean that when set to true expects the request to contain an authticket header to authenticate. If set to false, it is important to add a ServiceUserImpersonate element, otherwise the Service cannot pass the authentications | ||||||
ServiceUserImpersonate |
|
Database-level configuration
Instead of editing the *.onesrv file, the user can update the authentication details from the Web Services Management page inside OneDealer.
Clicking on the Web Services Management menu item the Service Files page opens:
If there's no menu, you can create one in "administration/menuadministration" with data:
Description | Web Services Configuration |
---|---|
/SetupEntities/OneSrvFiles | |
Icon | fa-keyboard-o |
Color | #85B8C9 |
OD0007081 |
This page shows all of the *.onesrv files available at the server's \Files\Services directory.
Important! Keep in mind that this list is cached for performance improvements. If a change is made on any of the *.onesrv files server-side, the changes will not be mirrored in the list unless the Refresh Cache button at the top right corner of the page is pressed.
Adding a database-level configuration
To add a database-level configuration, from the Service Files list click on any row action and choose .
The following two-section popup appears:
Input | Description |
---|---|
Company | Choose the company the configuration will be saved for. If left empty, the configuration will be saved as default. |
RequiresAuthentication | Same as the file-level RequiresAuthentication |
Username | Same as the file-level UserName. CANNOT be empty if Requires Authentication is set to No |
Password | Same as the file-level Password. CANNOT be empty if Requires Authentication is set to No |
Viewing all configurations
To view all configurations for a Service File, from the Service Files list click on any row action and choose .
The Service Configuration Page will open:
On this page, you can also create a new configuration for that Service File by clicking at the top right corner this time. The same popup will appear.
Editing a configuration
From the Service Configuration Page, click on any row action and choose .
The same popup as Create will appear with all data already entered for the user to change.
Deleting a configuration
From the Service Configuration Page, click on any row action and choose .
Uniqueness in configurations
When creating or editing a configuration, keep in mind that at any time, for a specific Service File, there can be only one configuration with the same Company.
This is true for configurations without bound Company (Default Configurations).
File-level and database-level priority
Because the data can be different from the file-level to the database-level, a priority is set on to which data to use first and then roll to the next priority level.
The highest priority is given to Company-chosen database-level configuration.
If no database-level configuration is found for the specific service file, then the next (medium-priority) level is to use the default database-level configuration. Default is a configuration that is not bound to any company for the specific Service File.
Lastly, if all of the above criteria are not met, the low-level priority resides within the *.onesrv file.
Add Comment