Photos dropped in a folder¶
Your crews already keep job photos in shared folders. Point a folder at one of your checks and Sight checks each new photo as it lands: nobody has to call the API or open the console. Results come back in the console, to your results webhook, as a results file written into the folder and, if you ask, with the photos sorted into Pass, Fail and Needs a person.
Amazon S3, OneDrive, SharePoint, Google Drive, Azure Blob Storage, Google Cloud Storage and Dropbox are supported.
Folders are set up by a company's admins, on the Folders page of the console (sight.raku.so/folders).
How a folder becomes jobs¶
- A subfolder is a job. Photos in
jobs/Site 12/Job 4411/are one job, calledSite 12/Job 4411. - Each folder's jobs are its own. Two folders can both have a
Job 4411and they stay two jobs, even after one has finished. The folder's results file and its Latest photos show the plain name. Elsewhere in Sight, such as the job list and results webhooks, the name also carries the folder's tag:Site 12/Job 4411 (folder 4f8c2d1e9a7b). - A photo on its own is its own job, named after the file.
- A job is finished when its folder goes quiet: once no new photo has arrived for the folder's quiet time (30 minutes unless you choose another). Each photo is checked as it arrives; the job's verdict, and anything still missing, is settled when it finishes.
- Each photo is checked once per version. Replace a photo and the new one is checked; leave it and it is never checked twice.
- Only JPEG and PNG photos up to 25 MB are checked. Other files are left alone.
Connect Amazon S3¶
Sight never holds a key to your bucket. You make a role in your own AWS account that lets Sight in, only with a code that belongs to this connection, and only to the bucket and folder you choose.
- On the Folders page, choose Connect Amazon S3 and give the bucket's name and region, and a folder in it if Sight should only see part of it.
- Sight shows a trust policy. In AWS, make a role with the name Sight
suggests (it must start with
SightFolders) and paste the trust policy in. It names Sight's AWS identity and this connection's own external ID, so nobody else can use the role through Sight. - Give the role the permissions policy Sight shows. It lets Sight list and read photos under your folder. Its last statement lets Sight write the results file and sort photos; leave it out if Sight should only read.
- Paste the role's ARN and choose Connect. Sight tests it straight away; if something is wrong it says what, in a sentence.
Connect OneDrive or SharePoint¶
- On the Folders page, choose Connect OneDrive or SharePoint, give the storage a name, and choose Sign in to Microsoft.
- Sign in with the Microsoft account whose files Sight should see, and choose Accept. Sight asks only for access on that person's behalf (it can see what they can see, and nothing more) and to stay connected; none of it needs your admin's consent, though your company may ask for it anyway.
- You are back on the Folders page, connected to that account's OneDrive. To
use a SharePoint library instead, give the site's address (like
https://contoso.sharepoint.com/sites/field) and the library's name (often Documents) and choose Use this library, before adding any folders.
Sight keeps the sign-in sealed and never shows it. If the person leaves, or their admin takes the consent back, the storage says so: connect it again with another account. Disconnect removes the sign-in from Sight completely.
Connect Dropbox¶
- On the Folders page, choose Connect Dropbox, give the storage a name, and choose Sign in to Dropbox.
- Sign in with the Dropbox account the photos go to, and choose Allow.
- You are back on the Folders page, connected. Sight sees only its own folder in that Dropbox, Apps › Raku Sight, and nothing else there. Put the photos (or the job folders) in it, and point Sight at a folder inside it.
Sight keeps the sign-in sealed and never shows it. If the person removes Sight from their Dropbox's connected apps, the storage says so: connect it again. When Sight sorts a photo into a folder that already has one with the same name, Dropbox keeps both and numbers the new one. Disconnect removes the sign-in from Sight completely.
Connect Azure Blob Storage¶
- In the Azure portal, open the storage account, then the container your photos are in, then Shared access tokens.
- Under Permissions choose Read and List. Add Create, Write and Delete if Sight should write the results file and sort the photos; without them Sight only reads, and results come back in the console and to your webhook.
- Set an end date (a year is usual), set Allowed protocols to HTTPS only, and choose Generate SAS token and URL. Copy the Blob SAS token.
- On the Folders page, choose Connect Azure Blob Storage, give the storage a name, the storage account's name, the container's name and, if you like, a folder inside it, paste the token, and choose Connect.
Sight tests the token at once, keeps it sealed and never shows it. It refuses a token for the whole storage account, one that works over plain HTTP, and one that cannot read and list. A month before the token ends, the storage says so and asks for a new one; paste it there and nothing else changes. Disconnect deletes the token from Sight. To make the token itself useless too, revoke it in Azure: a token signed with an account key stops working when that key is rotated.
If your storage account accepts connections only from selected networks, Sight cannot reach it: it must accept connections from the internet.
Connect Google Cloud Storage¶
- On the Folders page, choose Connect Google Cloud Storage, give the storage a name, the bucket's name and, if you like, a folder inside it, and choose Add.
- Sight shows its identity for your company: a Google service account that
only your company's storage uses. Grant it the bucket with the command shown
(in Cloud Shell, or anywhere
gcloudis signed in), or in the Google Cloud console under the bucket's Permissions, Grant access:- Storage Object Viewer to check photos only. Results come back in the console and to your webhook.
- Storage Object User so Sight can also write the results file and sort the photos.
- Choose Test again. A new grant can take a few minutes to work.
Sight keeps no key to your bucket. To cut it off, remove its identity from the bucket's permissions, then Disconnect.
Connect Google Drive¶
- On the Folders page, choose Connect Google Drive, give the storage a name and paste the folder's link (in Google Drive, open the folder and copy the address, or use Share, Copy link). Choose Add.
- Sight shows its identity for your company: a Google service account that
only your company's storage uses. In Google Drive, open the folder, choose
Share and add that identity:
- Viewer to check photos.
- In a Shared drive, Content manager so Sight can also write the results file and sort the photos.
- Choose Test again.
In a personal My Drive, Sight checks the photos but cannot write the results file or sort them: Google does not let a service account make files there. Results come back in the console and to your webhook. For the results file and sorting, use a folder in a Shared drive.
Sight never signs in as you and keeps no token to your Drive: it sees only what you share with its identity. To cut it off, remove the identity from the folder's sharing, then Disconnect.
Point a folder at a check¶
Under Add a folder, choose the storage, the folder, the check its photos get and the model that looks at them, and how long a job's folder must be quiet before the job is finished. Then choose:
- Write a results file into the folder:
Sight results.csv, one row per photo: its job, its own verdict, its job's verdict and the reason. - Sort the photos: when a job is finished, each photo is moved into
Sight pass,Sight failorSight needs a person, keeping its job's subfolder. A photo gets the worst verdict of the checks it was evidence for. Sight never checks anything it sorted, or its own results file.
A folder holds one kind of photo. When the check looks at a named kind (a photo slot, such as Site photo), Sight puts every photo from the folder in that slot. A check that needs photos of more than one kind, such as a box photo and a test screen, cannot be used for a folder yet: the page says so when you add the folder.
Each folder is checked with its own key, made when you add the folder and cancelled when you remove it, so its photos count against your plan exactly as photos sent through the API do. If your plan says no, the photo shows why on the folder's Latest photos.
Pause, change or remove¶
Pause stops checking a folder until you resume it; photos that arrive in the meantime are checked when you do. Remove stops it for good and cancels its key. Disconnect removes a storage and every folder in it. Every change is recorded in your company's activity.