For your IT person

Not your job? Send this page to whoever looks after your ERPNext. Open only the part you need.

sigzenlead_connector Version 1.1.1 Frappe 16 ERPNext 16 MIT licence

Install

Frappe 16 and ERPNext 16. The app refuses to install without ERPNext.
An Address Template on the site (Setup, Printing and Branding, Address Template). A site created without the setup wizard has none, and ERPNext cannot save any Address without one.
A SigzenLEAD business account on a plan that includes the ERPNext connection.

Self-hosted bench

Get the app

bench get-app https://github.com/Sigzen-Team/sigzenlead_connector.git --branch master

Install it on your site

bench --site <your-site> install-app sigzenlead_connector

Migrate
```
bench --site <your-site> migrate
```

Frappe Cloud

The connector is not listed on the Frappe Marketplace yet. Write to support@sigzen.com.

Afterwards a SigzenLEAD - Connector tile on the desk opens a workspace with the settings, the received leads and the log.

Setup: user, roles, Business ID and token

Create the integration user. For example scan.integration@yourcompany.com, not your own login.

Role	Why
Sales User	Create and update Lead, Contact and Address. Or the sales role you already use.
Connector Integration	Added by this app. Create and update the connector's own link records.

Fill in Connector Settings. Tick Enabled. Set Business ID to the SigzenLEAD business ID, unless a System Manager user will connect (then it fills in by itself). Only a System Manager can change it later.
Generate the connector token. Click Generate Connector Token and copy it. It is shown once, and only a hash is stored on your site.
Connect from SigzenLEAD. Website: Dashboard, then Connectors. App: Profile, then ERPNext Settings. Enter the site address, user and password, save, and click Test Connection.
If the user is not a System Manager. Generate an API key (User, API Access, Generate Keys) and give the key, the secret and the token to your SigzenLEAD administrator. A System Manager user has these created by SigzenLEAD. Avoid that role unless you want this.

After a scan, Last Request On in the settings shows when SigzenLEAD last reached your site.

What lands where

From the card	In ERPNext
Name	Lead and Contact: `first_name`, `middle_name`, `last_name`
Company	`Lead.company_name`, `Contact.company_name`
Job title	`Lead.job_title`, `Contact.designation`
All emails	`Contact.email_ids`. The first also goes to `Lead.email_id`
All phones	`Contact.phone_nos`. The first also goes to `Lead.mobile_no`
Website	`Lead.website`
Source	`Lead.utm_source` on ERPNext 16
Address lines	`Address.address_line1`, `address_line2`, `city`, `state`, `country`, `pincode`
Address as printed	`Lead.custom_address`, the one added field
Card photos	File attachments on the Lead, private

The app also adds a workspace, Connector Settings, Connector Lead Link, Connector Source Link, Connector Log and the Connector Integration role. No standard ERPNext field is hidden, renamed or made read-only.

Security: how it works

It only receives. No outbound connection, scheduled job, email or webhook, so your firewall needs no outbound rule for it.
Installing or migrating creates, modifies and deletes no existing Lead, Contact or Address.
Every delivery needs the integration user's API key and the connector token. Either alone is refused.
Disable the user, or untick Enabled, and deliveries stop at once.

Troubleshooting

Open Connector Log first: the newest row says why a delivery was refused.

What you see	What to do
`SETUP_REQUIRED`	Create an Address Template. Nothing was lost; the lead is retried.
`UNAUTHENTICATED`	No ERPNext user was recognised. Check the integration user's API key and secret.
`TOKEN_INVALID`	The token in SigzenLEAD does not match. Generate a new one and enter it again.
`BUSINESS_MISMATCH`	The Business ID in the settings is not the one the leads are sent for.
`REMOTE_PERMISSION`	The integration user is missing one of the two roles.
`CONNECTOR_DISABLED`	Tick Enabled in the settings, and check that Business ID is set.
SigzenLEAD - Connector needs Frappe/ERPNext v16	Upgrade the bench to v16 before installing or migrating this app.
Lead: Options must be a valid DocType for field Email IDs	A site left half-installed by an older release. Complete it: `bench --site <your-site> migrate`
Base URL must point at a public ERPNext server	The address resolves to a private one. Use the site's public address.
ERPNext URL redirects to ...	Enter the final address it names.
Cannot reach ERPNext server	Check the address, the port, the firewall, and that ERPNext is running.
ERPNext login failed	Verify the integration user's username and password.
This ERPNext is already linked to another SigzenLEAD business	An ERPNext System Manager must change Business ID in Connector Settings first.
Only the Business Manager can use ERPNext Connector	Ask your business manager to connect.

Upgrade from an older name

Only if bench --site <site> list-apps shows vc_connector, sigzen_ai_scan_crm_connector or ai_snaplead_connector. Do it in a maintenance window: deliveries that arrive while the site is down are retried, and none are lost.

Back up every site that has the connector
```
bench --site <site> backup
```
Get the app under its new name
```
bench get-app https://github.com/Sigzen-Team/sigzenlead_connector.git --branch master
```
If bench asks to overwrite an existing directory, answer yes: the old folder moves to archived/apps/, it is not deleted.
Migrate
```
bench --site all migrate
```
A site that lists an old name is renamed automatically, with one line per site.
Only if a folder under an old name is left
```
bench remove-app vc_connector
```

Rebuild and restart

bench build --app sigzenlead_connector
bench restart

Check
```
bench --site <site> list-apps
```
It shows sigzenlead_connector and no old name.

The pairing, the API and your records do not change, and nothing has to be entered again. If something goes wrong, restore the backup: the old release keeps working with the old database.

Uninstall

bench --site <your-site> uninstall-app sigzenlead_connector

Leads, Contacts and Addresses the connector created are ordinary ERPNext records and stay. Its own settings, link rows and log are removed.

Version and licence

Version	What changed
1.1.1	Business ID is filled in during onboarding. A new app logo. Upgrade with bench migrate.
1.1.0	Security and robustness fixes. Frappe below 16 is refused. Upgrade with bench migrate.
1.0.0	First public release.

MIT. Publisher: Sigzen Technologies Pvt. Ltd.. Need help? Email support@sigzen.com with your site address and the relevant row from Connector Log.

Connect ERPNextThe short version for the business owner. ERPNext connectorWhat it does, and common questions. HelpSet-up guides, step by step.