Web access administration (IRPCWebAccessAdmin)
Sets up M-Files Web in Internet Information Services (IIS) on the server computer.
NOTE: Do NOT change the layout of methods and their parameters so that older clients could utilize this interface against a newer server.
Before client can use this interface, login is needed to the server. This can be achieved through the IRPCLogin interface.
| gRPC service | MFiles.IRPCWebAccessAdmin |
|---|---|
| Book and level | Administration API, specialized |
| Methods | 7 |
| Proto file | mfiles/IRPCWebAccessAdmin.proto |
Overview
For M-Files components only. M-Files Admin uses this service in its M-Files Web configuration dialog to check the IIS prerequisites and to create or reuse an IIS web site or virtual directory for M-Files Web. Applications should not call it.
Sessions and rights. Every method requires the system administrator server role (server
right edit_web_access_settings in ServerAccess); a server-level
session is enough. Other callers get "Access denied. You do not have the server-level access
rights required by this operation.".
Typical order in M-Files Admin:
CheckCommonRequirements or
CheckCommonRequirementsForWeb,
then QueryADSIObjects to list the IIS web
sites, then UseExistingWebSite,
CreateWebSite or
CreateVirtualDirectory.
The IIS objects are addressed with ADSI paths such as IIS://localhost/w3svc/2/ROOT.
Methods
| Method | Summary | Facts |
|---|---|---|
| CheckCommonRequirements | Checks that IIS and ASP.NET are installed and configured as M-Files Web needs. | internal: not for applications admin session idempotent |
| CheckCommonRequirementsForWeb | Checks the IIS prerequisites of the new M-Files Web, including the URL Rewrite and Application Request Routing modules. | internal: not for applications admin session idempotent |
| CreateVirtualDirectory | Creates an IIS virtual directory for M-Files Web under an existing web site. | internal: not for applications admin session |
| CreateWebSite | Creates a new IIS web site for M-Files Web. | internal: not for applications admin session |
| NotifyHttpGrpcService | Tells the server's HTTP-to-gRPC gateway that web client settings (such as add-in settings or the default web client) have changed. | internal: not for applications admin session idempotent |
| QueryADSIObjects | Lists the child objects of an IIS (ADSI) path on the server computer, for example its web sites. | internal: not for applications admin session idempotent |
| UseExistingWebSite | Configures an existing IIS web site for M-Files Web. | internal: not for applications admin session idempotent |