Site mapping & teach mode

The widget reads whatever screen a visitor is on, which covers the busy parts of your product quickly and the quiet corners slowly or never. These two sessions close that gap: you run them yourself, they finish in one sitting, and what they find becomes your site map and your agent's manual — never a new thing the agent may do.

Which one to use

They read different things, so they are complements rather than alternatives — map first, because it needs nothing but the embed you already have.

A site map reads pages

It opens each page it can reach and reads its markup — the forms, the routes, the links — and presses the controls it finds inside sealed copies of your pages, so nothing reaches your server. Best for mapping the shape of your product quickly.

Teach mode reads requests

You use your own product normally while a session records the requests it makes, and Syncanix works out the shape each one expects. Best when what a screen does is not obvious from the screen.

Mapping your site

Mapping runs in a browser tab you have open, signed in as you. Two things have to be true before it can start, and neither of them is anything you add to your HTML.

1. 1
   Name the address, in the dashboardYou type the exact address your widget is embedded on. If it is not on your allowed list yet, one button adds it and starts in the same press. Mapping never leaves that address.
2. 2
   Press the buttonOne press mints a link that works once and expires in five minutes, and opens your site with it. A strip appears at the top of that page reporting progress. If you would rather run it on another machine, the same button can copy the link instead.
3. 3
   Watch it, from anywhereThe dashboard moves to a page for that run. Reload it, open it in another browser, or send the address to a colleague — it is the same run, read from the server, and it survives all three.

<script
  type="module"
  src="https://cdn.syncanix.com/widget.js"
  data-key="pk_live_..."
></script>

What mapping does, in the posture you choose:

• Reads every page it can reach as you, following your own links.
• Presses the controls it finds inside sealed copies of your pages, so nothing reaches your server. That is how it learns what is behind a tab, a menu or a drawer.
• On the Live posture — which you choose, and which says so on screen the whole time it runs — it presses on your real site, as you.

Before it starts you choose how far it goes. Safe is selected for you:

• Read only — it navigates and reads, and presses nothing.
• Safe, the default — it presses and types inside sealed copies of your pages, so nothing reaches your server.
• Live — in Advanced, behind a warning you have to confirm. It presses on your real site, signed in as you, and the banner says so the whole time it runs.

What mapping never does, whatever you point it at:

• It never deletes, pays, sends messages or changes permissions — whichever posture you choose — and it never submits a form it was not asked to.
• It never leaves the address you named.
• It never keeps the values in a request or a response. It records the shape — which fields, of what kind — and not what was in them.
• It skips any address that reads like it deletes or removes something, rather than opening it to find out.

Each run has a page of its own, at an address you can come back to — a reload, another browser, or a colleague all land on the same run. The list keeps how many pages it read, and what it skipped and why. A skipped page is reported rather than quietly dropped, so a partial map never looks like a complete one.

Running a teach session

A teach session records what your product asks its own API for while you use it. Nothing is captured until you start one, and it stops the moment you say so.

1. 1
   Start a session for one addressYou name the exact origin your widget runs on. A session captures on that one address and nowhere else, and the dashboard shows you a binding token exactly once.
2. 2
   Use your product as usualSign in and do the things your customers do. The more of your product you touch, the more of it Syncanix can describe — and you are not performing actions for it to copy, only showing it what your software asks for.
3. 3
   Stop it, and reviewEnding the session stops the capture. What Syncanix keeps is a description of the shape each request expects — never the values — and that description is what your site map is built from.

What a teach session never captures:

• Password, payment-card and one-time-code fields, and anything you have marked sensitive.
• Authorization and cookie headers. They are dropped on the device and never sent.
• Anything at all, long-term. Personal data and secrets are removed in the browser before anything leaves the page, and what is recorded is erased after seven days.
• Anything inside a region you have excluded in your widget configuration.

One reading it does make: to work out where a request's value came from, it compares that value against what the page already holds — a meta tag, a hidden field, a cookie, a stored item. The comparison happens in your browser, the value is discarded as soon as it is made, and what is kept is the NAME of the place it came from. Nothing readable only by your server is visible to it.

Next steps