ScanCircle - All Forums

Autotask

Tue, 30 Sep 2025 21:12:03 +0200

NOTE: No changes have been made yet in Autotask to support this integration and the integration has not been certified by Datto yet.
NOTE: the information below describes the functionality of release 2.12 (currently release 2.11 is operational)

By specifying the Autotask ticket number as a reference code for a scan, by default:

The device specs are stored as a Configuration Item (asset), so that you don't need to enter this data manually;
The Configuration Item is linked to the ticket;
The scans are logged as internal comments (so you can track the status of the device from check-in to check-out);
Any changes to the device specs are also logged in the internal comment (so you can see what has been changed between scans).

You can also automatically create a new ticket when performing a scan, so you don 't need to do this upfront.

Please watch the partner video first. @TODO

Setup instructions:

In your Autotask account, create a new API user: Admin > COMMONLY USED: Resources (Users) > Click the 'V' next to '+ New' > Select 'New API user':
1. First Name: 'API'
2. Last Name: 'ScanCircle'
3. Email address: 'api@scancircle.com'
4. Security Level: any security level (e.g. 'API User (system) Can't Read Costs')
5. Primary Internal Location: any location (e.g. 'Headquarters')
6. Click the Generate Key button (optionally change it to e.g. scancircle@...) and copy/remember this value
7. Click the Generate Secret button and copy the generated value
8. Under API Tracking Identifier, select 'Integration Vendor' and 'ScanCircle'
  - If 'ScanCircle' is not yet available as 'Integration Vendor', select 'Custom (Internal Integration)', Internal Integration Name: 'ScanCircle' and copy the generated 'Tracking Identifier' (don't overwrite the Secret value in the clipboard)
9. Click Save & Close
In your ScanCircle partner environment, add the Autotask integration: Login > Integrations tab > Integration = 'Autotask':
1. User Name: the generated Username (Key) value
2. Client Secret: the generated Password (Secret) value
3. If you selected 'Custom (Internal Integration)', then add tracking= and the generated 'Tracking Identifier' to the More options setting
4. Click Connect to connect to Autotask and retrieve the select list options and the default values
5. Next, optionally change other fields and the Advanced settings, but the defaults usually suffice (for all fields, a description is shown at the righthand side)
6. Click Check to validate the configuration and generate/update the Shortcuts value (under 'Advanced settings'). If configuration entities are missing in Autotask, you will be prompted to have them created automatically. This will create a 'Configuration Item Category' with the name 'ScanCircle Device' (or the first name specified in the asset parameter), with the user defined fields Make & Model, OS, Motherboard, BIOS, Processor, Memory, Disk Info, Display Adapter(s), OS Installed, Product Keys, IP Address (fields that do not yet exist will be created) as well as the 'Configuration Item Type' and 'Product' with the same name
7. Finally, click OK and don't forget to click Save
Under the Scan widget tab:
1. Specify the name of a URL parameter (e.g. 'ticketno') if you want to set the ticket number in a link, e.g. https://domain.com/scan?ticketno=xyz
2. Specify an input field label (e.g. 'Ticket number') if you want the end-user to see/change/enter the ticket number
3. Optionally specify a category (e.g. 'ticket') if you want this widget to only handle specific Autotask reference codes (those containing the text 'ticket:'). Make sure you specify the same category in the 'Integrations' setting. You do not need to specify this if you use a single scan widget and want to allow other reference codes (e.g. email address or phone number) which do not match any ticket number (as failed matches will be forwarded to the next integrations option)
4. Copy the generated HTML code or shortcode to your website

Day-to-day use:

Create a new ticket in Autotask: fill in the required fields and click Save (NOT Save & Close). This will show the ticket number generated at the top (e.g. T20250930.0001);
Then perform a ScanCircle scan on the device and enter the generated ticket number as reference code. This will store the device specs in a Configuration Item linked to the ticket and log the scan in the ticket;
Now print/email a claim ticket for the customer if required and start fixing the device;
Before you return the device, always perform another scan with the ticket number as reference code (logs the end state) and optionally print/email the ScanCircle Scan report (containing the before-and-after state) for the customer;
You may allow the customer to periodically scan its device using the ticket number (tip: send them a link containing the ticket number after e.g. 3 months);
If you want to update the device specs manually, use the default 'Changes' setting, then update the specs based on the changes in the internal comments.

Note: This plugin is as standard provided and maintained by ScanCircle. You do no need to install anything yourself.

If you want to use this plugin, please subscribe to this discussion using the option in the lower left corner of this page so that you will be notified of any updates automatically.

HaloPSA

Fri, 15 Aug 2025 21:37:57 +0200

NOTE: No changes have been made yet in HaloPSA to support this integration, but they are working on a market place which may make the configuration even easier.

ScanCircle can forward the device specifications and scans to HaloPSA, by default:

The device specs are stored as an asset (so that you don't need to enter this data manually);
The asset is linked to the ticket number specified in the reference code when running a scan;
The scans are logged as internal comments for that ticket (so you can track the status of the device from check-in to check-out);
Any changes to the device specs are also logged in that internal comment (so you can see what has been changed between scans).

Please watch the partner video first. @TODO

Requirements:

In your HaloPSA account:
1. Create a new API application: Configuration > Integrations > HaloPSA API > View Applications > + New
2. Enter the following: Application Name = 'ScanCircle', Authentication Method = 'Client ID and Secret (Services)', Agent to log in as = select the agent account that will be used to perform the API operations
3. Copy the generated Client Secret (it will only be shown once): optionally click Generate to generate a new value and click Copy
4. On the Permissions tab, check the following options (admin is only required during initial): admin, read:tickets, edit:tickets, read:assets, edit:assets
5. Switch back to the Details tab, save the changes and leave this page open: Details tab > Save
In your ScanCircle partner environment:
1. Add the HaloPSA integration: Login > Integrations tab > Integration = 'HaloPSA'
2. First fill in the copied Client Secret
3. Then copy the Client ID from the open HaloPSA API application Details tab
4. Fill in the Subdomain with the HaloPSA subdomain
5. Optionally change other fields and the advanced settings, but the defaults usually suffice (for all fields, a description is shown at the righthand side)
6. Click Check to validate the configuration. If the asset type does not yet exist, you will be prompted to have it created automatically. This requires the 'admin' permission and will create the asset type ('ScanCircle Device' or the name specified under Asset type(s)) for asset group 'Computing' withthe fields: Name (as key field 1), Serial Number (as key field 2), Model, OS Version, Main Board, BIOS, Processor, RAM Memory, Disc Size, Video Card, OS Date, Licence Number, IP Address (fields that do not yet exist will be created)
7. Finally, click OK and don't forget to click Save
Go back to your HaloPSA account and remove the 'admin' permission: Edit > Permission tab > uncheck 'admin' > Save
Go back to your ScanCircle partner environment to the Scan widget tab:
1. Specify a 'Label input field' (e.g. 'Email address / ticket number') if you want visitors to enter their email address or a ticket number for a scan. This will be used as reference code to match a ticket in HaloPSA. If there is no match, then the scan notification will be forwarded to the next integration specified (or ultimately the specified email address)
2. Specify a 'URL parameter' (e.g. 'ticket') if you want to set the ticket number in a link for your clients, e.g. https://domain.com/scan?ticket=xyz
3. Copy the generated HTML code or CMS shortcode to your website
Day-to-day use:
1. Create a new ticket in HaloPSA: select/enter the end-user, fill in the required fields and click Submit. This will show the ticket number generated in the top left corner and on the tab (e.g. ID:0001234 and 1234);
2. Then perform a ScanCircle scan on the device and enter the generated ticket number as reference code (in this case 1234). This will store the device specs in an asset linked to the ticket and log the scan in the ticket;
3. Now print/email a claim ticket for the customer if required and start fixing the device;
4. Before you return the device, always perform another scan with the ticket number as reference code (logs the end state) and optionally print the ScanCircle Scan report (containing the before-and-after state) for the customer;
5. You may allow the customer to periodically scan its device using the ticket number (tip: send them a link containing the ticket number after e.g. 3 months);
6. If you want to update the device specs manually, use the default 'Changes' setting, then update the specs based on the changes in the internal comments.

My Gadget Repairs

Tue, 28 Nov 2023 18:22:46 +0100

Credits: My Gadget Repairs have been enormously helpful getting this interface to work optimally (even making changes to their API). Using their 3rd Party Integration, all configuration is done automatically for you.

By specifying the My Gadget Repairs ticket number as a reference code for a scan, by default:

The computer specs are stored as an asset (so that you don't need to enter this data manually);
The asset is linked to the ticket;
The model and serial number are also stored in the ticket;
The scans are logged as internal comments (so you can track the status of the computer from check-in to check-out);
Any changes to the computer specs are logged as internal comments (so you can see what has been changed between scans).

Please watch the partner video first.

Requirements:

In your My Gadget Repairs account, go to the "ScanCircle Computer Diagnosis" integration (under "3rd Party Integration"). If you have not yet generated an API Key, one will be created for you and sent to you by email. Make sure you click "Save Configuration" to:
1. Create the "ScanCircle device" asset type;
2. Create the following custom fields (in addition to the standard fields name, serial and model): OS, Mobo, BIOS, CPU, RAM, Disks, Video, Installed, Licenses (only for scans in partner mode) and IP. If you would like to disable any of these custom fields, go to Tickets/Customers > Asset Manager > Custom Fields & Form Fields Mapping and change the "Status" of the required field from "Active" to "Inactive";
3. Create a "Generic brand ("*") to which the ScanCircle models will be linked. ScanCircle models are in the format: " (
  )", e.g. "Dell Inc. XPS 17 9700 (Mobile)". This is a technical limitation that may cause some duplication e.g. if you already have models like "XPS 17 9700" linked to brand "Dell";
In your ScanCircle partner environment, select the Integrations tab. Add the destination "My Gadget Repairs" and fill in the required fields (only "API Key" is required). Optionally change the other fields and the advanced settings, but the defaults usually suffice. For all fields, a description is shown at the righthand side. Click "Check" to check the connection and then click "OK". Optionally add alternative destinations (e.g. for other categories) and make sure to finish with an "Email" address to which unhandled scan notifications and referral notifications will be sent. Finally click "Save";
Now generate a scan widget in your ScanCircle partner environment (on the "Scan widget" tab) and copy the generated HTML code or shortcode to your website:
1. Specify the name of a URL parameter (e.g. "ticketno") if you want to set the ticket number in a link, e.g. https://domain.com/scan?ticketno=xyz;
2. Specify an input field label (e.g. "Ticket number") if you want the end-user to see/change/enter the ticket number;
3. Optionally specify a category (e.g. "ticket") if you want this widget to only handle specific My Gadget Repairs reference codes (those containing the text "ticket:"). Make sure you specify the same category in the "Integrations" setting. You do not need to specify this if you use a single scan widget and want to allow other reference codes (e.g. email address or phone number) which do not match any ticket number (as failed matches will be forwarded to the next integration option as standard);
Day-to-day use:
1. Create a new ticket in My Gadget Repairs, fill in the required fields (Customer and Short info) and click '+ Add New Ticket'. This will show the ticket number generated in the top left corner under the tabs (e.g. RPR-1);
2. Then perform a ScanCircle scan on the computer and enter the generated ticket number as reference code. This will set the specs and log the initial state of the computer;
3. Now print a claim ticket for the customer and start fixing the computer;
4. Before you return the computer, always perform a last scan with the ticket number as reference code (logs the end state) and optionally print the ScanCircle Scan report (containing the before-and-after state) for the customer;
5. You may allow the customer to periodically scan its computer using the ticket number (tip: send them a link containing the ticket number after 3/6/12 months);
6. If you want to update the computer specs manually, use the default "Changes" setting, then update the specs based on the changes in the internal comments.

Scan results on your own website

Wed, 22 Jul 2020 21:45:19 +0200

If you want to redirect the end-user to your own website instead of to your ScanCircle partner environment, then you can specify your "Own results page" under "Advanced settings". This accepts 3 parameters (language, advice URL, reference code) e.g. https://domain.com/scanresults?language=%s&advice=%s&reference=%s. The own results page is not used for scans done in partner mode.

If you want to include the scan results page in an IFRAME on your own results page, then you can assign the value of the advice URL parameter to the src attribute of the IFRAME (e.g. using PHP or JavaScript). To prevent cross-site scripting, make sure to check that the advice URL is really a ScanCircle results URL (i.e. starts with http(s)://PARTNER.scancircle.com/, where PARTNER is your own partner code).

WordPress and Joomla websites that have the ScanCircle plug-in installed can use the [scancircle_results partner="PARTNER" param="ADVICE" IFRAME-ATTRIBUTES] shortcode (where PARTNER is your own partner code, ADVICE is the name of the advice URL parameter and IFRAME-ATTRIBUTES are standard IFRAME attributes like width and height), which performs the required checks and changes the src attribute.

Windows 10 app

Fri, 01 May 2020 18:04:37 +0200

The ScanCircle Windows 10 app is an additional option to the existing "portable" scan program available in ScanCircle release 2.0. It requires Windows 10 1607 and admin rights to install but has the following benefits:

Windows 10 keeps on nagging when downloading executables that do not come from the Microsoft Store;
People that want to perform the scan periodically have to download the scan program each time again;
Or they store the scan program on their computer, but then they don't get the newer versions of the scan program (any many ignore the warning on the results page);
Updates for Windows 10 apps are automatically applied by the Microsoft Store;
The scan results can now be shown in the app itself (can also be opened in the default browser);
In manual mode, the scan data can also be shown in the app itself (and uploaded or saved to file for manual upload).

Installation (does not require admin rights):

The app can best be installed with the 'Use the app' option of the scan widget (this option appears when you hover over the scan button). In this case, the partner and optional reference code are forwarded to ScanCircle and the user is redirected to ScanCircle app in the Microsoft Store for installation (the user may need to confirm opening the Microsoft Store);
Alternatively, the user can search for the ScanCircle app in the Microsoft Store app and install it from there, but then the partner code will not be set and will default to the main (www) environment.

Launching (after the app has been installed):

The app can be started from the Windows Start menu or from the Microsoft Store (e.g. immediately after installation). The first scan can only be performed in 'Automatic' or 'Manual' mode (since the app does not know any partner code yet). If the partner code and optional reference code have been forwarded to ScanCircle (installation option 1), then these will be matched against the uploaded scan (on IP address) and used in these scan results. The partner code is remembered by the ScanCircle app, so the next time the ScanCircle app is started, scans can also be performed in 'Partner' mode;
The partner code can be updated by running a new scan from the preferred partner website with the 'Use the app' option of the scan widget (which opens the Microsoft Store and shows the option to start the app if it is already installed) or by using the 'Launch app with selected settings' option available under the 'More information' link (this starts the app with the partner code, language code and optional reference code as parameters; the user must confirm running the ScanCircle app);
The app can also be started via the command-line or an email link, see this post.

P.S. Clicking the word scan in the disclaimer still runs the portable scan program in "Partner mode".

d7x

Wed, 01 Jan 2020 18:29:47 +0100

Partners using d7x (v19.12.10.0+) can use variables for client name and ticket number, %name% and %num% respectively, so you would use them like https://domain.com/scan?reference=%num%

Feed emails into PSA/RMM/ticketing systems

Tue, 13 Feb 2018 23:10:39 +0100

To feed scans into ticketing systems that support creating tickets based on an email, you can specify that email address in the "Integrations" setting.

To avoid creating unnecessary tickets you may want to create "workflow rules" to filter the required notifications:

Sender equals "noreply@scancircle.com";
Subject starts with "Reference scan", "Partner scan" or "Anonymous scan " (excludes "Internal referral" and "External referral" notifications);
Subject contains or ends with a specific reference between parenthesis: e.g. specify "ticket" as reference code during the scan then Subject will end with "(ticket)";
Body contains a specific target name: on the partner "Advertisements" tab, add one or more Targets with a specific "Name" and "Condition" (e.g. "CREATE_TICKET" for "Minimum scan score is NOT 6").

Thanks to partner TrotsIT for implementing and testing this with Autotask AEM PSA.

Translation mechanism

Wed, 29 Nov 2017 13:55:07 +0100

To make the ScanCircle website, scan program and mailings multi-lingual, the international GNU gettext standard (see https://gnu.org/software/gettext/manual/gettext.html) has been adopted. This works with the following file types:

.pot: the translation template containing all keywords (msgid) including instructions for the translator. There is only 1 .pot file for each domain and it is used by ScanCircle to create and update the .po files before distributing it to the translator;
.po: the translation file containing all translations (msgstr) including comments by the translator. There is 1 .po file per language for each .pot file and it is updated by the translator using a .po file editor and sent back to ScanCircle when completed;
.mo: the compiled translation file. There is 1 .mo file for each .po file, it is created by ScanCircle from the .po file and used by the applications to retrieve the translations for specific keywords within a specific domain in a specific language.

The following domains are used:

Scanner: minimal definitions for the scan program (about 50 phrases*);
Global: the global definitions, mainly for the website (about 450 phrases*);
Results: definitions for scan results, registrations and end-user mailings (about 650 phrases*);
Partner: definitions for partner program, partner mailings and invoices (400-450 phrases*). Since this is only for interaction with partners, translation is optional (defaults to English).

In most gettext implementations, the msgid contains the original (English) text itself. However, a slightly different approach was chosen because:

a lot of the output (e.g. menus, pages, lists, advices, mailings, invoices) is generated programmatically which means that the keyword should not be free text;
the MVC implementation on the website does not allow special characters in parameters;
the original English text may need corrections (would require changing the msgid).

So instead, the msgid contains a tag like "home:easy:desc" (home page, easy block, description). Unfortunately, this would mean that the original English text is missing in the .po file which makes it difficult for the translator. Also most .po file editors expect the msgid to contain the original (English) text in order to offer automated translations from previous or machine translations. Therefore, for the translators, the msgid value (tag) is moved to the msgctxt field (message context) and the msgid is replaced with the original English text. This also has the advantage that in some .po file editors, the msgctxt field (which is an indication where the text is used) is shown as well and that the msgid in combination with the msgctxt is always unique (because the msgctxt always is, where the original English text might not be). To differentiate between the normal .po and .pot files, these files are named .xlt.po and .xlt.pot. When the translation in the .xlt.po file is completed, this process will be reversed before creating the .mo file. So the translator will not see much difference other than the extra message context field.

Translation tips:

Download POEdit from www.poedit.net (the free version suffices) or use another .po file editor;
When ScanCircle creates a .xlt.po file for a new language, machine translations will be used to prefill the msgstr fields. Although this helps with about 90% of the translation, it may be in the completely incorrect context. Therefore all machine translations will be marked “fuzzy” meaning that they require your attention so please check this carefully and update the translation or turn off the “Needs work” option;
During the creation of the .xlt.po file, some special characters in the original text are counted. If the translated text contains less or more of these characters, this is logged as a “translator comment” (shown as a text balloon icon in POEdit). Please note that these comments may be incorrect, so optionally adjust the translation and remove the comment when handled;
If the language has a formal and informal version (e.g. French vous/toi, German Sie/du), then use the formal version but it should not be over-polite;
Try and keep the translations about the same length as the original, especially if it concerns headers or labels, unless it negatively affects the translation;
Leave the *bold*, _italics_, [links], %s parameters and newlines (\n) in the translation and don’t use double quotes (");
Please pay special attention to singular/plural translations (date/time units in the global domain) and make sure you check both translations (shown in separate tabs in POEdit);
If in doubt about a certain translation, please check with ScanCircle or add a translator comment. Also please inform ScanCircle about any errors in the original English text;
If any updates are required to the original English text, the .xlt.pot file will be updated by ScanCircle and the original English text will be included as the “previous untranslated string”. The .xlt.pot file will then be used to update the .xlt.po files, causing the previous translation to be marked “Needs work”. The original English text is also shown to the translator until he/she updates the translation or turns off the “Needs work” indicator;
Before returning the .xlt.po file to ScanCircle, first save your changes. In POEdit, this will perform some extra checks (warnings shown as a yellow triangle icon in the left margin). Enable “View > Input with errors first”, but note that these warnings may be incorrect;
Next, use the “Validate” function of the .po file editor, to make sure there are no other errors and no more translations that require your attention. Also check if all translator comments (text balloons in the left margin in POEdit) have been accounted for;
Do not manually edit the .xlt.po file and certainly do not change the msgctxt or the order within the .xlt.po file (it is okay to view the .xlt.po file in a different order in a .po file editor);
If you have manually edited the .xlt.po file and cannot open it anymore using the .po file editor, the file may contain non-UTF8 characters. Please replace these by their UFT-8 equivalents.

For the moment, the exchange of .xlt.po files from ScanCircle to the translator and back will be done by means of email. At a later stage, a translation platform like Pootle may be used.

If you want to contribute and translate ScanCircle to your local language, please reply to this post or send me an email or Private Message using the buttons below.

*) A phrase can be 1 word, 1 line or a number of lines.

Scan widget on your own website

Sat, 17 Jun 2017 19:56:06 +0200

To include the scan widget on your own website, please log in to your partner dashboard and select the "Scan widget" tab. Here you can select the desired options and copy the generated HTML code or shortcode (in combination with our WordPress or Joomla plugin) to your own web page.

The scan widget ensures that initially:

The required Cascading Style Sheet is added to the
All text appears in the selected language;
Optionally, an input field for a reference code is shown with the specified label;
Optionally, the specified URL parameter or specified fixed value is taken as a reference code;
The correct text will be shown on the scan button (depending on the scan mode);
The available other scan options will be shown on mouse-over;
The "More information" link is added next to the scan button;
The disclaimer line is shown beneath the scan button;
A hidden link is added to the word "scan" in the disclaimer so that partners simply perform a scan in the partner mode;
Optionally, the ScanCircle speedometer is shown.

And after pressing the scan button, another scan option or the hidden link:

The content of any input fields are combined to form a reference code, optionally preceded by the indicated category;
It checks whether the reference code is required and meets the specified format;
The reference code is exchanged with the scan program (if possible) or via the database;
In MSIE/Edge1, it examines whether the correct .NET version is already available and if not offers a download option;
It examines which action is to be taken:
1. Install the app from the Microsoft Store (change the label to "Opening Store ..." during 10 sec);
2. Launch the app with the selected parameters (change label text to "Staring app ..." during 10 sec);
3. The executable for .NET4 / Windows 8+ (change the label to "Downloading scanner ..." with 3 dots during 10 sec);
4. The executable for .NET2 (change the label to "Downloading scanner .." with 2 dots during 10 sec);
Then the text of the "More Information" link will change to "Did it not work?".

A few notes:

Enter the address of your own scan page as "Own scan page" so that the links in the e-mail to registered users and social media posts refer to it;
The best option is to include a ScanCircle logo on your homepage (http://www.scancircle.com/scancircle.png) and link this to the scan page on your website, explaining what the scan do, why you use it and that you can help solve problems;
If you want to give the elements a different color, font, size or place, you can use the following CSS elements (use !Important to override the default value):
- #scancircle_button the scan button;
- #scancircle_dropdown the other scan options on mouse-over on the scan button;
- #scancircle_info: the more information link;
- #scancircle_terms: disclaimer (make sure it is always visible);
- #scancircle_hidden: the hidden "scan" link in the disclaimer (make sure the link and pointer is always hidden);
- #scancircle_prompt: the label for the input field;
- #scancircle_refcode: the contents of the input field;
- #speedometer: the speedometer div;
If JavaScript is disabled on your computer or HTTPS does not work, then you will only see the link "ScanCircle" which links to the scan page in your partner environment (without HTTPS);
On scancircle.com nearly the same code is used, but it also works if JavaScript is disabled.

RepairShopr/SyncroMSP

Fri, 10 Mar 2017 16:58:27 +0100

IMPORTANT NOTE: No changes have been made yet in RepairShopr/SyncroMSP to support this interface and some steps need to be done manually at this moment. If sufficient interest is shown in the interface, they may automate some of these steps (e.g. 1, 2 and 5b2).

By specifying the RepairShopr or SyncroMSP ticket number as a reference code for a scan, by default:

The computer specs are stored as an asset (so that you don't need to enter this data manually);
The scans are logged as internal ticket comments (so you can track the status of the computer from check-in to check-out);
Any changes to the computer specs are logged as internal ticket comments (so you can see what has been changed between scans).

Please watch the partner video first (needs to be updated to reflect the new Integrations user interface and other changes in release 2.11).

Requirements:

In your RepairShopr/SyncroMSP account, create a new asset type ScanCircle Device (Admin > Asset Custom Fields > + New Asset Type) and add the (non-required text) fields listed below (Manage Fields). Use the exact field names (respect their case) en reorder them in any way you want. You may omit any field that you are not interested in, except for "Serial":
- Serial
- Make
- OS
- CPU
- RAM
- Video
- Disks
- Board
- BIOS
- Installed
- Licenses
- IP
Create an API key (Admin > API Tokens > New Token > Custom Permissions) named "ScanCircle" without expiration with the permissions listed below, click "Create API Token" and copy the API token created:
- Assets - List/Search
- Assets - Edit
- Assets - Create
- Tickets - List/Search
- Tickets - View Details
- Tickets - Edit
- Ticket Comments - New
In your ScanCircle partner environment, select the Integrations tab. Add the destination "RepairShopr" or "SyncroMSP" and fill in the required fields ("Subdomain" and "API Key"). Optionally change the other fields and the advanced settings (e.g. set unwanted fields to "ignore"), but the defaults usually suffice. For all fields, a description is shown at the righthand site. Click "Check" to check the connection and then click "OK". Optionally add alternative integrations (e.g. for other categories) and make sure to finish with an "Email" address to which unhandled scan notifications and referral notifications will be sent. Finally click "Save";
Generate the scan widget in your ScanCircle partner environment (on the Scan widget tab) and copy the generated HTML code or shortcode to your website:
1. Specify the name of a URL parameter (e.g. "ticketno") if you want to set the ticket number in a link, e.g. https://domain.com/scan?ticketno=12345;
2. Specify an input field label (e.g. "Ticket number") if you want the end-user to see/change/enter the ticket number;
3. Optionally specify a category (e.g. "ticket") if you want this widget to only handle RepairShopr/SyncroMSP reference codes (those containing the text "ticket:"). Make sure you specify the same category in the "Integrations" setting. You do not need to specify this if you use a single scan widget and want to allow other reference codes (e.g. email address or phone number) which do not match any ticket number (as failed matches will be forwarded to the next integration option as standard);
Day-to-day use:
1. Create a new ticket in RepairShopr/SyncroMSP by filling in the required fields and click "Create Ticket";
2. Then perform a ScanCircle scan on the computer and enter the new ticket number as reference code (this will set the specs and log the initial state of the computer):
  1. If nomatch=one (default) and the customer does not have any computer assets at all or if nomatch=any and there is no match on name andserial number, then a new computer asset will be created and linked to the customer;
  2. You can link that asset to the ticket by editing the ticket and under 'Relevant Assets', click 'Add existing', select/search the asset and click 'Add';
3. Now print a claim ticket for the customer and start fixing the computer;
4. Before you check out the computer, always perform a last scan with the ticket number as reference code (logs the end state) and optionally print the ScanCircle before-and-after report for the customer;
5. You may allow the customer to periodically scan its computer using the ticket number (tip: send them a link containing the ticket number);
6. If you want to update the computer specs manually, use the default changes setting (log), then update the specs based on the changes in the internal comments and optionally remove the internal comments;
7. Note: only the first digits of the reference code (excluding any category) are used to find a match, so you may add additional information (e.g. '123 client A' will match 123).

Notes:

This plugin is as standard provided and maintained by ScanCircle. You do no need to install anything yourself;
The standard RepairShopr/SyncroMSP 'Asset Serial Number' is not used because it must be unique and computer serial numbers unfortunately aren't;
The RepairShopr/SyncroMSP Computer Asset field 'Service Tag' is not used because the general term is 'Serial Number'.

If you want to use this plugin, please subscribe to this discussion using the option in the lower left corner of this page so that you will be notified of any updates automatically.

Third party advantages

Tue, 10 May 2016 21:57:41 +0200

ScanCircle partners get the following third party advantages:

PC Repair Tracker: $50 discount for first time buyers (i.e. $150 instead of $200), send a mail to luke@pcrepairtracker.com and mention your ScanCircle partner code;
More advantages will be added soon ...

PC Repair Tracker

Thu, 19 Nov 2015 16:13:33 +0100

TO USE THE LATEST FUNCTIONALITY, DOWNLOAD THE ATTACHED scancircle2pcrt.php AND INSTALL IT IN YOUR PCRT repair DIRECTORY

By specifying the PC Repair Tracker (PCRT) asset/device id (pcid) as a reference code for a scan, by default:

The computer specs are stored with the asset/device (so that you don't need to enter this data manually);
The scans are logged as asset attachments (so you can track the status of the computer from check-in to check-out);
Any changes to the computer specs are logged as internal notes (so you can see what has been changed between scans).

Please watch this partner video first (needs to be updated to reflect the new Integrations user interface in release 2.8).

Requirements:

In your PC Repair Tracker environment:
1. Go to Settings > Integration Info >Go and copy the API key for the ScanCircle integration. If you don't have an API key yet or want to change it, select Settings > Create New Store Hash > Go;
2. This interface relies on the mainassetinfofields table in the PCRT database to contain the following matchwords (the fields marked with "*" are non-standard and can be manually added to the database table if required):
  - serial (serial number)
  - operatingsystem
  - cpu
  - ram
  - partition (disk drives)
  - videocard
  - bios
  - installedon
  - windowsproductkey (only for scans in partner mode)
  - computername*
  - motherboard*
  - ipaddress*
In your ScanCircle partner environment, select the Integrations tab. Add the destination "PC Repair Tracker" and fill in the required fields (only "URL" and "Store Hash" are required). Optionally change the other fields and the advanced settings, but the defaults usually suffice. For all fields, a description is shown at the righthand site. Click "Check" to check the connection and then click "OK". Optionally add alternative destinations (e.g. for other categories) and make sure to finish with an "Email" address to which unhandled scan notifications and referral notifications will be sent. Finally click "Save";
Generate the scan widget in your ScanCircle partner environment and copy the generated HTML code or shortcode to your website:
1. Specify the name of a URL parameter (e.g. "pcid") if you want to set the pcid in a link , e.g. https://domain.com/scan?pcid=1234;
2. Specify an input field label (e.g. "PC number or email address") if you want the end-user to see/change/enter the pcid;
3. Specify a category if you want this widget to only handle PCRT reference codes. Make sure you specify the same category in the "Integrations" setting. You do not need to specify this if you use a single scan widget and want to allow other reference codes (e.g. e-mail address or phone number) which do not match any PCRT pcid (as failed matches will be forwarded to the next integration option as standard);
Day-to-day use:
1. When you check in a new computer, you do not need to enter the computer specs and do not print the claim ticket yet;
2. Then perform a ScanCircle scan on the computer and enter the new pcid as reference code (this will set the specs and log the initial state of the computer);
3. Now print the claim ticket for the customer and fix the computer;
4. Before you check out the computer, always perform a last scan with the pcid as reference code (logs the end state) and optionally print the ScanCircle before-and-after report for the customer;
5. You may allow the customer to periodically scan its computer using the pcid (suggestion: give them a link containing the pcid).
Notes:
1. Only the first digits of the reference code (following any category+colon) are used to find a match, so you may add additional information (e.g. "1234 client A" will match 1234);
2. This add-on was as standard provided in PCRT v2.1-v9. Since there have not been any new releases, please install the attached scancircle2pcrt.php in your PCRT repair directory;
3. If you want to add any pre or post processing, you can create a file called scancircle2pcrt_pre.php and/or scancircle2pcrt_post.php with your own PHP code in your PCRT repair directory;
4. If you are still using PCRT v2.0 or v1.40, please replace the wo.php file in your PCRT repair directory with the relevant attached version to open the scan links in the main repair page;
5. The standard module SimpleXML must be installed (and not disabled) in your PHP environment.

If you want to use this add-on, please make sure you subscribe to this discussion using the option in the lower left corner of this page so that you will be notified of any updates automatically.

  wo_v2.0.php (Size: 97,07 KB / Downloads: 0)

  wo_v1.40.php (Size: 118,48 KB / Downloads: 0)

  scancircle2pcrt.php (Size: 14,23 KB / Downloads: 3)

Standard notification of scans/referrals

Sun, 01 Sep 2013 14:07:29 +0200

Notifications to partners (for scans or referrals) can be done by email or by post:

Email: The email is in HTML format with a so-called plain-text alternative. The sender of the email is noreply@scancircle.com (add this email address to a white list to avoid blocking by strict spam filters)
Post: An HTTP post of an XML structure called "info" with one root node and one level of sub nodes. Use this method to process notifications automatically.

In the definitions below, the variables are enclosed in curly brackets and explained in the variable list below. The XML sub nodes contain the variables indicated by the node name (e.g. {advice}).

Scan: when a user performs a scan in your partner environment

Email subject: "{source} scan results for {name}/{volumeid}/{serial}[ ({reference})]" ([] = optional)
Email body contains: {advice}, {make}, {mobo}, {bios}, {os}, {installed}, {cpu}, {memory}, {video}, {disk}, {lastboot}, {ip} ({iplocation}), {score}, {targets}, {keys}, {message}
Post XML root node: scan
Post XML sub nodes: advice, language, scanmode, reference, name, volumeid, serial, make, mobo, bios, os, installed, cpu, memory, video, disk, lastboot, redirect, ip, iplocation, score, targets, keys, oskey*
Post reply: the script should return (echo) "OK" to indicate that it is successful or a URL to redirect the user to a specific webpage. Other responses are regarded as error, then the message will still be sent to the next alternative. This continues until no more alternatives are available.

*) To support existing scancircle2pcrt v1.35 implementations, the license keys will also be included in an node for the moment

Referral: when a user of your own partner environment clicks on one of your advertisements or asks for support (internal referral) or a user of the general www environment clicks on your entry on the map (External referral)

Email subject: "Internal referral" or "External referral"
Email body contains: {advice}, {from}, {location}, {reference}, {redirect}, {ip}, {message}, {explanation}
Post XML root node: referral
Post XML sub nodes: type, advice, from, location, reference, redirect, ip
Post reply: there is no check on the response.

Variable list:

{advice}: result URL for the expert (the Advice tab)
{bios}: device's Basic IO System
{cpu}: processor specs
{disk}: local storage devices (drive names and size)
{from}: partner code where the scan is performed (your own partner code for an internal referral, www for the general environment)
{installed}: OS installation date
{ip}: external IP address
{iplocation}: city+state+country based on IP address
{language}: active language code (en/nl)
{lastboot}: last system boot date
{keys}: license keys in the format {name}:{value}, separated by semi-colons (only in partner mode)
{location}: a Google Maps link to the city (based on IP address) or the location specified by the user (only for external referrals)
{make}: device brand and model
{memory}: total memory installed and number and size of memory modules
{message}: an optional reply/error message from a post method (scan) or an explanation (referral)
{mobo}: mother board
{name}: device name
{os}: operating system
{redirect}: the URL the end-user is redirected to (Summary tab for results or custom URL for referrals)
{reference}: optional reference code
{scanmode}: d=direct, p=partner, a=automatic, m=manual, e=alternative in MSIE
{score}: total scan score (optionally with one decimal, '?' if OS unknown)
{serial}: device serial number as specified by the manufacturer
{source}: "Partner" (if partner mode), "Reference" (if reference code specified) or "Anonymous" (otherwise)
{targets}: names of the targets that meet your specified advertisement conditions (separated by commas)
{type}: type of referral "Internal" or "External"
{video}: video adapter card(s)
{volumeid}: volume serial number of primary hard drive

File name for downloads

Sun, 03 Feb 2013 16:33:59 +0100

In all web browsers, the scan program is downloaded first and then executed by the end-user manually. Therefore the scan program file name is used to pass the parameters as follows:

ScanCircle[2|3|4][D|A|M|P][_xx][_partnercode]*.exe

Parameters:

2|3|4: not really a parameter, but an indication that this is:
- 2: the .NET2 version without certificate timestamp (for Windows XP/ME)
- 3: the .NET 2.0 with certificate timestamp (for Windows Vista/7)
- 4: the .NET4.5 version (for Windows 8+)
- without number: the .NET 4.6.2 version (for Windows 10+)
D|A|M|P: scanmode;
xx: 2-character language code;
Partnercode: partner code;
*: optional trailing characters (e.g. _1, (2), [3]).

Note: do not leave the scan program with the partner scan mode (P) in the file name on the client's computer, as they might (un)intentionally use it themselves.

See this post about the command line parameters for a description of the parameters.

Command line parameters

Fri, 29 Jun 2012 22:22:58 +0200

The following optional command line parameters are supported:

-partner (default is none or for ScanCircle app: previously selected partner)
-reference
-language (2-character language as supported by the ScanCircle website, e.g. en/nl/de/fr/es/it/pl/ee, default is current system setting or for ScanCircle app: previously selected language)
-scanmode D|A|M|P (direct, automatic, manual, partner, default=A, direct is same as automatic but starts automatically so user doe not need to hit the Start button)
-hidden (only performs the scan, no user interface)
-nocopy (does not send a notification to the partner)
-skip (skip the indicated XML nodes, separated by semi-colons, join nodes below 'scan' using a period): intended and supported for security.status.uac (but may work with other nodes)
-save [] (save the scan file, if is a directory or missing, the file name is -.xml in the specified or current directory)
-output (write the advice URL or error message to the specified file path)

This syntax is also shown when starting the scan program with incorrect parameters, e.g. scancircle.exe ?

The resulting advice URL is echoed to standard output (only visible if standard output is redirected) or to the specified output file path.

There are 2 versions of the portable scan program: .NET Framework 4 version (default for Windows 8+) or .NET Framework 2 version (default for older Windows versions). Please note that if you plan to run this on the client's computer, you need a way to update the scan program when a new version becomes available. Example (PARTNER = partner code, REF = reference code, LL = language code):

ScanCircle4.exe -partner PARTNER -reference REF -language LL -hidden -output %temp%\scancircle.txt

Otherwise use the ScanCircle app if installed. The carrot (^) is to escape the ampersand (&), otherwise it would be interpreted as a separator for multiple commands:

start scancircle://?partner=PARTNER^&reference=REF^&language=LL^&hidden^&output=%temp%\scancircle.txt

*** The following option does not yet work correctly in all situations ***
If you are not sure if the ScanCircle app is installed, you can use the following link (e.g. in emails to your customers), which will run the ScanCircle app if installed or redirect the user to your own scan page or the scan page in your ScanCircle partner environment (the language code and reference code are optional, other parameters are not supported, if your own scan page uses a URL parameter for the input field, it must be named "reference"):

https://app.scancircle.com[/LL]/PARTNER[/REF]

Also see this post about passing parameters in the scan program file name (used when downloading in browsers).