Enabling integration with Bartec Collective
In order to start using Bartec Collective from within your forms, you'll need to enable the integration within the Integrations Hub. This involves completing all the required fields with the correct account information, as provided by Bartec.
You will need your:
- Authentication Service URL
- Collective Service URL
- User Identifier
Contact Bartec support if you do not have the above details.
Enabling Bartec Collective Integration
Once you have the required connection details, enter them into the Bartec Collective Integrations Hub page. You can also optionally configure the cache timeout, which is used to determine how long to reuse data that has already been obtained from Bartec Collective, before it needs to be refreshed.
Upon clicking save the connection is tested, and the details are saved if this is successful.
If the integration is unable to connect to the endpoint provided, the hub page will display an error. Please contact either Jadu Support or Bartec to verify the endpoint and credentials provided.
Once you have successfully connected to Bartec Collective, the 'Settings' tab will become enabled. Here you can customise the integration to match your particular instance of Bartec Collective.
The settings available are:
|Garden Feature Name Match||ORGANIC||Any features with this prefix will be treated as Garden Bins (case-insensitive)|
|Residual Waste Name Match||RESIDUAL||Any work packs containing this text will be treated as Residual Waste Collection (case-insensitive)|
|Bulky Collections Name Match||BULKY||Jobs within a work pack containing this text will be treated as Bulky Waste Collection (case-insensitive)|
|Maximum Bulky Waste Collections Per Work Pack||10||The maximum number of jobs that can be added to a bulky waste collection work pack|
|Scrap Metal Collections Name Match||BINSCRAP||Jobs within a work pack containing this text will be treated as Scrap Metal Collection (case-insensitive)|
|Maximum Scrap Metal Collections Per Work Pack||10||The maximum number of jobs that can be added to a scrap metal collection work pack|
|Assisted Collection Description||Assisted Collection||The attribute description used to determine whether a property has assisted collections (case-insensitive)|
|Service Request Class||All||The service class to restrict service request creation to|
|Cache Timeout||0 Minutes||Determine how long to reuse data that has already been obtained from Bartec Collective, before it needs to be refreshed|
NOTE All fields are mandatory.
You can modify any of these settings by changing the values in this tab. Once the fields are correct for your Bartec Collective instance, click 'Save'.
This interface has a 'Log' tab, which displays a record of actions carried out in this interface, and which Administrator was responsible. It will show when the integration was enabled and disabled, as well as any errors returned from Bartec Collective when testing the provided details.
The log shows the most recent 250 entries, and can be searched by date, Administrator, error text or status.
Missing Dependency Warning
If you see the below message when accessing the Bartec Collective Integrations Hub page:
You'll need to install the PHP SoapClient module, if Jadu manage your servers please request this via Jadu Support. If you manage your servers yourself you will need to install the PHP module before continuing.