Skip to content
No description, website, or topics provided.
JavaScript Dockerfile
Branch: master
Clone or download
Latest commit 0521c78 Nov 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Fix image name Nov 4, 2019
lib Set iamToken to undefiend if it is no set at all Nov 4, 2019
spec Fix seeds Sep 9, 2019
.eslintrc
.gitignore
Dockerfile Update node alpine version May 10, 2019
LICENSE Create LICENSE Jul 25, 2018
README.md
component.json Update README Jul 30, 2018
logo.png
package-lock.json
package.json
verifyCredentials.js Rename credential field mandant_name Jul 17, 2018

README.md

wice-adapter

Wice CRM is a CRM Software which offers different modules for address management, tasks management, project management, calendars and a knowledge base for knowledge management. The software could be used to manage sales opportunities and offers too. In addition, Wice CRM offers the possibility to manage and create invoices, open items and incoming payments.

This adapter connects Wice CRM which with third-party applications. With this adapter you are able to create different application flows. It supports "Triggers" (e.g. getPersonsPolling, getOrganizationsPolling) as well as "Actions" (e.g. upsertPerson, upsertArticle, updatePersonsOrganization, etc.), therefore with this adapter you could both read and fetch data from Wice CRM and write and save data in Wice CRM.

Before you begin

Before you can use the component you must be a registered Wice CRM user. Please visit the home page of Wice CRM to sign up.

Any attempt to reach Wice CRM endpoints without registration will not be successful

After you are already registered in Wice CRM you have to generate your API Key.

For activation you have to be logged in, then click of Admin and under Plugins click of Client API Backend. Once you are in click the button Create new to generate your API key.

Once the activation is done you have an access to API Key which is required for an authentication when you make a request to Wice CRM.

Actions and triggers

The connector supports the following actions and triggers:

Triggers:

  • Get persons - polling (getPersonsPolling.js)
  • Get organizations - polling (getOrganizationsPolling.js)
  • Get articles - polling (getArticlesPolling.js)
  • Get deleted persons - polling (getDeletedPersonsPolling.js)
  • Get deleted organizations - polling (getDeletedOrganizationsPolling.js)

All triggers are of type 'polling' which means that the trigger will be scheduled to execute periodically. It will fetch only these objects from the database that have been modified or created since the previous execution. Then it will emit one message per object that changes or is added since the last polling interval. For this case at the very beginning we just create an empty snapshot object. Later on we attach lastUpdated to it. At the end the entire object should be emitted as the message body.

Actions:

  • Upsert person (upsertPerson.js)
  • Upsert organization(upsertOrganization.js)
  • Upsert article(upsertArticle.js)
  • Delete person (deletePerson.js)
  • Delete organization (deleteOrganization.js)
  • Delete article (deleteArticle.js)
  • Lookup person (lookupPerson.js)
  • Lookup organization (lookupOrganization.js)
  • Lookup article (lookupArticle.js)

NOTE: As mentioned before, to perform an action or call a trigger you have to be a registered Wice CRM user and you have to pass your API Key when you send a request.

In each trigger and action, before sending a request we create a session in Wice CRM via calling the function createSession() from wice.js file, which is located in directory utils. This function returns a cookie which is used when we send a request to Wice CRM

Get persons

Get persons trigger (getPersonsPolling.js) performs a request which fetches all new and updated persons saved by a user in Wice CRM.

Get organizations

Get organizations trigger (getOrganizationsPolling.js) performs a request which fetches all new and updated organizations saved by a user in Wice CRM.

Get articles

Get articles trigger (getArticlesPolling.js) performs a request which fetches all new and updated articles saved by a user in Wice CRM.

Get deleted persons

Get deleted persons trigger (getDeletedPersonsPolling.js) fetches all persons which have recently been deleted.

Get deleted organizations

Get deleted organizations trigger (getDeletedOrganizationsPolling.js) fetches all organizations which have recently been deleted.

Lookup person

Lookup person action (lookupPerson.js) performs a request which fetches the corresponding person by given an id.

Lookup organization

Lookup organization action (lookupOrganization.js) performs a request which fetches the corresponding organization by given an id.

Lookup article

Lookup article action (lookupArticle.js) performs a request which fetches the corresponding article by given an id.

Upsert person

Upsert person action (upsertPerson.js) updates an existing person if it already exists. Otherwise creates a new one. At this point of time the function accepts as required parameters name and firstname, but of course you can also pass other parameters like email, phone, salutation, title, etc.

Upsert organization

Upsert organization action (upsertOrganization.js) updates an existing organization if it already exists. Otherwise creates a new one. This function accepts as required parameter only name, but if you wish you can also pass town, street, street_number, zip_code, countryetc.

Upsert article

Upsert article action (upsertArticle.js) updates an existing article if it already exists. Otherwise creates a new one. This function accepts as required parameter description, but if you wish you can also pass number, sales_price, purchase_price, in_stock, unitetc.

Delete person

Delete person action (deletePerson.js) deletes a person in Wice CRM. The required parameter is rowid of the person which you want to delete.

NOTE: We do NOT really delete the person from our database, we just set a value in field deactivated to 1 which actually marks the person as deactivated .

Delete organization

Delete organization action (deleteOrganization.js) deletes an organization in Wice CRM. The required parameter is rowid of the organization which you want to delete.

Delete article

Delete article action (deleteArticle.js) deletes an article in Wice CRM. The required parameter is rowid of the article which you want to delete.


License

Apache-2.0 © Wice GmbH

You can’t perform that action at this time.