Edmund AI Documentation
/SETUP GUIDES

Part B — Operation

Day-to-day work once the connector runs: files, folder structure, mapping a folder to a project, and replacing the client secret.

Part B is the customer’s own work. Files and folders are managed in SharePoint; mapping a folder to a project and replacing the client secret are done in Edmund by a user with the Administrator role. Neither needs involvement from Edmund.

7. What Edmund monitors

Edmund reads one document library on one site, and within it only the folders mapped to a project. Subfolders of a mapped folder are included.

FrequencyA change is detected within 10 minutes. How long processing then takes depends on volume — a single added document is a matter of minutes, the first load of a folder holding hundreds of files runs for hours
DirectionOne-way. Nothing Edmund does is written back to SharePoint
ScopeMapped folders only. A file outside them is invisible to Edmund, whatever its type

Not read:

  • Files outside a mapped folder
  • File formats outside the appendix

500 MB per file is the supported ceiling; do not place larger files in a monitored folder. In machine documentation that limit is rarely met — where it is, the file is usually a scan worth splitting into parts, which also makes it easier to search.

What Edmund records about a file

RecordedUsed for
Name and full path in the libraryIdentifying the file and the project it belongs to
SizeReporting
Created and last-modified dateDetecting a change
Content hashDetecting a change, and recognising a file already held

Nothing else from SharePoint is read: not the author, not the last editor, and not custom columns of the library. A document’s metadata in Edmund therefore does not carry them, and a change to them alone does not trigger anything.

8. Day-to-day work with files

8.1 Uploading a new file

  1. Upload the file into the mapped folder of the project it belongs to.
  2. Open the project in Edmund. The file appears in the document list while it is still being processed, with its status — indexing while Edmund works on it, then indexed successfully — and its Source, which reads SharePoint.
  3. Once the status shows the document is indexed, it is available to answers in chat.

A document already present in Edmund from another route is not duplicated when the same file appears in SharePoint: where the content matches, the existing document remains and its source changes to SharePoint. That makes it safe to move a project from manual uploads to SharePoint — file the same documents in the monitored folder and they are adopted rather than doubled.

8.2 Updating a file

Upload the new version into the same folder under the same name. Edmund detects the change, reads the new content and replaces the document: the previous one is removed and the project keeps a single entry for that file. No cleanup is needed.

The new content is used in answers as soon as the status shows the document is indexed. Until then the previous version answers, so there is never a moment when the document is missing from the project.

One consequence worth knowing: an updated file is a new record in Edmund. The content is not lost and the document is in the list under the same name, but a link to the previous document — from a conversation saved earlier, say — stops resolving. That follows from the document being replaced whole, and is not a fault.

Re-uploading a file that has not changed does nothing — an identical name, date and content is recognised and skipped.

8.3 Versioning

SharePoint keeps a version history of every file in the library. Edmund does not read it. Only the current version of a file is ever fetched.

Consequently there is no version history in Edmund and no way to ask about a previous version of a document. When a file changes, the current version replaces what was there before.

Leave versioning switched on in the library — it is your way back. To return to an earlier state, restore the earlier version in SharePoint; Edmund takes it over at the next check like any other change.

8.4 Deleting and restoring

Deleting the file in SharePoint removes the document from Edmund. This is how a document is withdrawn from use — nothing has to be deleted in Edmund separately.

Restore a file from the SharePoint recycle bin into a mapped folder and Edmund takes it over at the nightly reconciliation at the latest, usually sooner. Do not re-upload it by hand in the meantime — that produces a duplicate somebody then has to clean up.

Deletion propagates in one direction only, like every other change: Edmund never deletes anything in SharePoint.

9. Renaming and moving

Renaming or moving a file is a change like any other: Edmund reads it again and replaces the document, because the name and the path are part of what identifies it. The project ends up with one entry under the new name; the old one is removed. Moving a file out of every mapped folder removes its document, at the nightly reconciliation at the latest.

Renaming a subfolder inside a mapped folder leaves the mapping intact, but every file below it changes path and is therefore read and indexed again. In a folder of three hundred files that is three hundred re-indexings — not a fault, but not something to do casually either.

Renaming a mapped folder

Renaming or moving a mapped folder stops synchronisation for that folder. The mapping addresses one folder and finds it by its path; once the path no longer exists, SharePoint does not return the folder and the synchronisation fails.

Two things do not happen: documents are not deleted, and they do not stop working. Edmund deliberately gives up before working out what disappeared from SharePoint, so an unreachable folder never leads to a bulk deletion. Documents already indexed keep answering; they simply stop being updated, and new files in that folder do not arrive.

How you see it. Every mapped folder carries its own state under Settings → Connections → SharePoint. While synchronisation runs, the folder shows the time of the last successful run. After the folder is renamed the state flips to stopped, that timestamp freezes at the moment before the rename, and the folder reports that Edmund could not find it at the stored path. Nobody has to notice that no documents have arrived for a week.

How you fix it, yourself, in under a minute:

  1. Copy the new folder address

    Open the folder in SharePoint and copy its address from the browser.

  2. Paste it over the old one

    In the project, replace the folder row with the address you copied and select Validate. Edmund confirms it can see the folder and reports how many files it found.

  3. Save

    Synchronisation resumes at the next run, within 10 minutes.

Nothing is re-uploaded and nothing is lost: the files keep the same identity in SharePoint, so Edmund picks up where it stopped. Every file’s path has changed, though, so the first run after remapping reads them all again and takes longer than usual.

To reorganise without a stop at all: create the new folder, map it to the project, move the files, then remove the mapping of the old folder. Done in that order, synchronisation never fails.

The same file in two mapped folders is read twice, once per folder. Where those folders belong to different projects, the document appears in both — which is the intended way to share a document between projects, and the reason a copy left behind after a move shows up twice.

10. Creating a structure for a new machine

One folder is one project, and one project is one machine or station. Keeping projects narrow keeps answers accurate; a single project holding everything increases processing time and degrades results.

Name folders down the hierarchy the plant is organised by — plant, line, operation, machine — and give the Edmund project the same name as its folder, so the two can be read side by side.

Naming: the only technical limit is a folder path of 512 characters. Accented characters, spaces and symbols such as & are fine — Edmund encodes the address itself. One recommendation stands: choose a name that will not need to change, because renaming a mapped folder stops synchronisation until it is remapped (chapter 9), and every file in the folder is then read again.

Order of work:

  1. Create the folder in the monitored library.
  2. Create the project in Edmund — New project, name and tags.
  3. Map the folder to the project (chapter 11).
  4. Upload the documents.

Uploading before the mapping exists is safe. The files are read on the first run after the mapping is created.

A project with no mapped folder is invisible to synchronisation: nothing is fetched and nothing fails. Projects can therefore be prepared in advance and mapped once the structure in SharePoint is settled.

11. Connecting a folder to a project

Mapping is done in Edmund by an Administrator, in either of two places: on the Integrations card in a project’s settings, or under Settings → Connections → SharePoint, which lists every project at once and can be searched and filtered by tag. The second is the one to use when setting up many machines.

It carries the SharePoint folder address, so no path syntax is involved.

  1. Copy the folder address in SharePoint

    Open the folder in the document library and copy its address from the browser.

  2. Paste it into the project

    Paste it into a folder row. Edmund resolves the address to the folder it points at.

  3. Validate

    Select Validate. Edmund reads the folder and reports how many files it found, with a sample of them. An empty result is a valid answer: the folder is reachable but holds no files of a supported type — subfolders are not counted here.

  4. Save

    The mapping takes effect from the next synchronisation run.

A project can carry up to 20 mapped folders. The same folder can be mapped in several projects, which is how a document that applies everywhere is filed once and read by each project that needs it — but see chapter 12 for what that costs.

An address from another host, another site or another library is rejected: Edmund reads one document library. Mapping does not touch the application registration or the site grant, and needs no work in Entra ID.

Two things to expect:

  • It is not a folder tree to browse. You paste an address and confirm it, rather than clicking down through the library.
  • Mapping comes after the project exists, and is not a field in the new-project form. Create the project, then map its folder.
Documents/
  global_documents/
  Project_A/
  Project_B/
RuleReason
One folder per projectThe mapping points at a folder
A shared folder for documents that apply everywhere, kept smallMapped into several projects, the document is filed once — but processed once per project
Nothing in the library rootRoot files belong to no project and are not read
Structure inside a mapped folder is freeSubfolders are read

What a shared folder costs

Documents are held per project. A folder mapped into twenty projects is therefore processed and stored twenty times, once for each. With five standards nobody notices; with a folder of five hundred files it is five hundred extra indexings per project, and the first load runs for a long time.

Keep the shared folder small and map it where it is genuinely needed, not into every project as a precaution. A single “global” project holding all the standards does not solve it either: a question is always answered within one project, so a document that has to be available at a machine must be mapped in that machine’s project.

13. Replacing the client secret

The client secret expires on the date set when it was created. An expired secret stops synchronisation without an error; documents stop arriving. Replace it before that date.

  1. In Entra ID, open the application and create a new client secret (Certificates & secrets → New client secret). Copy the value.
  2. In Edmund, an Administrator opens Settings → Connections → SharePoint and enters the new value. Edmund verifies it against the library before saving, so a wrong value is rejected on the spot and the working connection is left untouched. The stored secret is never displayed back — the page only shows that one is held.
  3. Delete the old secret in Entra ID.

Create the new secret before deleting the old one; both are valid until the old one is deleted, so synchronisation continues throughout. Record the new expiry date.

14. Where an administrator sets this up

Everything the connector needs sits in one place, reachable by a user with the Administrator role. Nothing here involves Edmund, and none of it touches the application registration or the site grant in Entra ID — those are part A, and are done once.

TaskWhereChapter
Enter or change the connection — tenant, client, secret, driveSettings → Connections → SharePointPart A, 6
Replace an expiring client secretSettings → Connections → SharePoint13
Map folders to projects, across every project at onceSettings → Connections → SharePoint11
Map a folder for one projectThe project’s Integrations card11
Check whether a folder is still synchronisingEither of the two9
Remap a folder that was renamedEither of the two9
Deactivate the integrationSettings → Connections → SharePoint—

Deactivating leaves the credentials and the folder mappings in place; it stops the synchronisation, and switching it back on resumes from where it left off.

15. When synchronisation stops

Documents stop appearing while nothing looks changed in SharePoint. Check in this order:

Start at Settings → Connections → SharePoint. Each mapped folder shows its state and the time of its last successful run, which answers most of this on sight.

#CheckFix
1Does a folder show a stopped synchronisation?It was most likely renamed or moved — remap it, chapter 9
2Has the client secret expired?Replace it, chapter 13
3Was the site grant deleted, or the consent withdrawn?Repeat part A, steps 3 and 4
4Is the file format one Edmund reads (appendix)?Convert the file, or ask Edmund about the format
5Was the file placed outside a mapped folder?Move it into a mapped folder, or map the folder it is in

Single files missing while others arrive point to the file, not the connection — its type, its size, or a folder that is not mapped. Validating the folder (chapter 11) reports how many files Edmund sees in it, which separates the two cases quickly. A document stuck in indexing for far longer than the rest of its batch is a case for Edmund.

When reporting to Edmund, include the file name, its full path in the library, and the time it was uploaded. Without the path, a missing document cannot be distinguished from an unmapped folder.

16. Contact

For questions and for reporting a failed synchronisation, contact devops@edmundai.com.

Appendix — supported file types

The connector reads the document formats Edmund accepts anywhere else:

CategoryExtensions
PDFpdf
Worddocx doc docm dot dotx dotm rtf odt
Excelxlsx xls xlsm xlsb xlt xltx xltm ods csv
PowerPointpptx ppt pptm ppsx ppsm potx potm odp
Texttxt md yaml yml html htm

Supported ceiling: 500 MB per file. Larger files should not be placed in a monitored folder.

A file the connector does not read stays in SharePoint untouched; it simply never appears in the project. Nothing has to be cleaned up, and no error is raised.

Note

PLC programs are not synchronised through SharePoint. They are a separate data source, imported directly from the engineering tool. Files carrying a PLC program pass the platform’s file validation, so placing one in a monitored folder produces a document rather than a PLC program — keep them out of monitored folders and import them the usual way.