Practical samples of M-Files COM and REST API that you can use.
If you are a developer and building solutions and integrations with M-Files, the Intelligent document and information management system, you've found the M-Files application platform reference documentation some what lacking, as I did.
In my quest in learning the M-Files applications platform, practical-m-files
is my write-up of simple applications with the M-Files APIs and some proposals for lacking features, like using Serilog for logging in vault application.
To open and run the samples from practical-mfiles
, you'll need the following software and frameworks:
- M-Files Online Full Installation with M-Files Desktop, M-Files Server and M-Files Server tools.
- Microsoft Visual Studio 2019 or Microsoft Visual Studio Code with C#.
- .NET Full framework 4.x en .NET 5.x.
The practical-m-files samples work with a local sample vault, called practical-m-files
, that you can find in the /vault folder.
TODO
Use these instructions to import the sample practical-m-files.mfb
vault:
-
Git clone this repository to your harddisk
-
Start MF Admin
-
Go to the
Local Computer\Document Vaults
node. -
Right click the
Document Vaults
node and choose `Restore Document Vault'. -
Open the
practical-m-files
vault toUsers
and click 'New User' to add your Windows login account to the vault.- In the
Login account
dropdown, choose your M-Files Windows account. - In the
Administrative rights in vault
section, select 'Full control of vault'. - Click
OK
to create the user.
- In the
Create a M-Files Desktop settings entry.
-
In the Windows traybar, right click the M-Files icon and choose
Settings
, M-Files Desktop settings
-
Click
Add...
and enter connection settings.- In
Name
, enter '`practical-m-files' . - In the server section, enter
Localhost
inName
,2266
withPort number
and protocol TCP/IP. - Choose
Current Windows user
with Authentication. - Pick
practical-m-files
in theVault on server
dropdown. - Click
OK
to complete the vault connection settings..
- In
Theres are a lot of samples. Click in the code panel to go to the sample source code.