Screenshot:CRM Connector Configuration
This article is protected against manual editing because it is automatically generated from Openbravo meta-data. Learn more about writing and translating such documents.
 | Back to Screens_Reference |
Contents |
CRM Connector Configuration
The concrete CRM connector must add a configuration in this window to allow to connect to the external system and to define the properties and filters used by Openbravo to map with the external system information.
CRM Connector Configuration
The concrete CRM connector must add a configuration in this window to allow to connect to the external system and to define the properties and filters used by Openbravo to map with the external system information.
- Organization : Organizational entity within client
- Name : A non-unique identifier for a record/document often used as a search tool.
- Description : A space to write additional related information.
- URL : An address which can be accessed via internet.
- Connectivity Type : The type of network connectivity supported by a CRM connector configuration
- Type of Integration
- Username : User Name
- Password : A secret code used to allow access to a specified window or tab.
- Timeout : Timeout is the value in seconds set by the user for the request to the defined service.
- Active : A flag indicating whether this record is available for use or de-activated.
- Columns for Detail View
- Show customer identifier on referenced documents : Flag that indicates if the customer identifier configured for the customer is to be used
- Client : Client for this installation.
- CRM Connector Configuration : Configuration for CRM integrations
API Property
An API property is like a Map which matches an external API key with an Openbravo Message. It defines the data type and any other related configuration
- Organization
- Active : A flag indicating whether this record is available for use or de-activated.
- CRM Connector Configuration : Configuration for CRM integrations
- API Key : Identifier of a concrete property into the external system
- Reference : The data type of this field.
- Mandatory : An indication noting that completing in a field is required to proceed.
- Editable : It checked, the property can be edited
- Translatable : Indicates if an option for a ExtBP configuration property is translatable
- Message : The name of the application initiated message.
- Text : A place to add observations related to a specified check point.
- Key Column : This column is the key in this table
- Key Sequence Number : It allows to specify the right order when several properties are part of the key
- Used as Record Identifier : This column is part of the record identifier
- Identifier Sequence Number : The sequence indicates the order for the properties within the identifier
- Display in View : If checked, the property will be shown in the detail view
- View Sequence Number : Sequence to display the property in detail view
- Section for View : External BP Config Section
- Colspan for View
- Display in List : If checked, the property will be shown in the results list view
- List Sequence Number : Sequence to display the property in the results list view
- Display in Edit : If checked, the property will be shown in the edit view
- Edit Sequence Number : Sequence to display the property in edit view
- Section for Edit : External BP Config Section for Edit
- Colspan for Edit
- Display in Create : If checked, the property will be shown in the create view
- Create Sequence Number : Sequence to display the property in create view
- Section for Creation : External BP Config Section for Create
- Colspan for Create
- Category Key : If checked, the property will be used as category key.
- Category Key Sequence Number : Sequence in the category key
- Use as default email : Record used as the default Email of the customer
- Use as default phone : Record used as the default Phone number of the customer
- Use as birthday date : Record used as customer's birthday
- Is Address Property : Defines if a property is considered for address only flows
- Use as Default Address : Record used as the default Address of the customer
- Display in Customers Window : If checked, the property will be shown in the Customers Window
- Customers Window Sequence Number : Sequence to display the property in Customers Window
- Colspan for Customers Window
- Use as Marketing Consent for Email : Record used to give marketing consent
- Use as identifier for scanning action
- Client : Client for this installation.
- CRM Connector Property : CRM Connector Property
Property Options
Allow to define options accepted by parent property
- Active : A flag indicating whether this record is available for use or de-activated.
- Sequence Number : The order of records in a specified document.
- Search Key : A fast method for finding a particular record.
- Default : A value that is shown whenever a record is created.
- Translatable : Indicates if an option for a ExtBP configuration property is translatable
- Message : The translatable text for the CRM API property option, if it is translatable
- Text : A descriptive name for an option accepted by a CRM combo property
- Organization : Organizational entity within client
- Client : Client for this installation.
- CRM Connector Property Option : Allows to define accepted values for parent CRM connector property
- CRM Connector Property : CRM Connector Property
API Property for Customer
This tab is similar to the API Property but filters properties that are only used for Customers
- Organization
- Active : A flag indicating whether this record is available for use or de-activated.
- CRM Connector Configuration : Configuration for CRM integrations
- API Key : Identifier of a concrete property into the external system
- Reference : The data type of this field.
- Mandatory : An indication noting that completing in a field is required to proceed.
- Editable : It checked, the property can be edited
- Translatable : Indicates if an option for a ExtBP configuration property is translatable
- Message : The name of the application initiated message.
- Text : A place to add observations related to a specified check point.
- Key Column : This column is the key in this table
- Key Sequence Number : It allows to specify the right order when several properties are part of the key
- Used as Record Identifier : This column is part of the record identifier
- Identifier Sequence Number : The sequence indicates the order for the properties within the identifier
- Display in View : If checked, the property will be shown in the detail view
- View Sequence Number : Sequence to display the property in detail view
- Section for View : External BP Config Section
- Colspan for View
- Display in List : If checked, the property will be shown in the results list view
- List Sequence Number : Sequence to display the property in the results list view
- Display in Edit : If checked, the property will be shown in the edit view
- Edit Sequence Number : Sequence to display the property in edit view
- Section for Edit : External BP Config Section for Edit
- Colspan for Edit
- Display in Create : If checked, the property will be shown in the create view
- Create Sequence Number : Sequence to display the property in create view
- Section for Creation : External BP Config Section for Create
- Colspan for Create
- Category Key : If checked, the property will be used as category key.
- Category Key Sequence Number : Sequence in the category key
- Use as default email : Record used as the default Email of the customer
- Use as default phone : Record used as the default Phone number of the customer
- Use as birthday date : Record used as customer's birthday
- Is Address Property : Defines if a property is considered for address only flows
- Use as Default Address : Record used as the default Address of the customer
- Display in Customers Window : If checked, the property will be shown in the Customers Window
- Customers Window Sequence Number : Sequence to display the property in Customers Window
- Colspan for Customers Window
- Use as Marketing Consent for Email : Record used to give marketing consent
- Use as identifier for scanning action
- Use As : Semantic field type for the CRM property
- Client : Client for this installation.
- CRM Connector Property : CRM Connector Property
Property Options for Customer
Allow to define options accepted by parent property
- Active : A flag indicating whether this record is available for use or de-activated.
- Sequence Number : The order of records in a specified document.
- Search Key : A fast method for finding a particular record.
- Default : A value that is shown whenever a record is created.
- Translatable : Indicates if an option for a ExtBP configuration property is translatable
- Message : The translatable text for the CRM API property option, if it is translatable
- Text : A descriptive name for an option accepted by a CRM combo property
- Organization : Organizational entity within client
- Client : Client for this installation.
- CRM Connector Property Option : Allows to define accepted values for parent CRM connector property
- CRM Connector Property : CRM Connector Property
API Property for Address
This tab is similar to the API Property but filters properties that are only used for Addresses
- Organization
- Active : A flag indicating whether this record is available for use or de-activated.
- CRM Connector Configuration : Configuration for CRM integrations
- API Key : Identifier of a concrete property into the external system
- Reference : The data type of this field.
- Mandatory : An indication noting that completing in a field is required to proceed.
- Editable : It checked, the property can be edited
- Translatable : Indicates if an option for a ExtBP configuration property is translatable
- Message : The name of the application initiated message.
- Text : A place to add observations related to a specified check point.
- Key Column : This column is the key in this table
- Key Sequence Number : It allows to specify the right order when several properties are part of the key
- Used as Record Identifier : This column is part of the record identifier
- Identifier Sequence Number : The sequence indicates the order for the properties within the identifier
- Display in View : If checked, the property will be shown in the detail view
- View Sequence Number : Sequence to display the property in detail view
- Section for View : External BP Config Section
- Colspan for View
- Display in List : If checked, the property will be shown in the results list view
- List Sequence Number : Sequence to display the property in the results list view
- Display in Edit : If checked, the property will be shown in the edit view
- Edit Sequence Number : Sequence to display the property in edit view
- Section for Edit : External BP Config Section for Edit
- Colspan for Edit
- Display in Create : If checked, the property will be shown in the create view
- Create Sequence Number : Sequence to display the property in create view
- Section for Creation : External BP Config Section for Create
- Colspan for Create
- Category Key : If checked, the property will be used as category key.
- Category Key Sequence Number : Sequence in the category key
- Is Address Property : Defines if a property is considered for address only flows
- Use as Default Address : Record used as the default Address of the customer
- Use as default email : Record used as the default Email of the customer
- Use as birthday date : Record used as customer's birthday
- Use as default phone : Record used as the default Phone number of the customer
- Colspan for Customers Window
- Display in Customers Window : If checked, the property will be shown in the Customers Window
- Customers Window Sequence Number : Sequence to display the property in Customers Window
- Client : Client for this installation.
- CRM Connector Property : CRM Connector Property
Property Options for Address
Allow to define options accepted by parent property
- Active : A flag indicating whether this record is available for use or de-activated.
- Sequence Number : The order of records in a specified document.
- Search Key : A fast method for finding a particular record.
- Default : A value that is shown whenever a record is created.
- Translatable : Indicates if an option for a ExtBP configuration property is translatable
- Message : The translatable text for the CRM API property option, if it is translatable
- Text : A descriptive name for an option accepted by a CRM combo property
- Organization : Organizational entity within client
- Client : Client for this installation.
- CRM Connector Property Option : Allows to define accepted values for parent CRM connector property
- CRM Connector Property : CRM Connector Property
Filter
Filters for external business partner integration. The filter has a defined type and it's linked to one or many properties
- Organization : Organizational entity within client
- Active : A flag indicating whether this record is available for use or de-activated.
- CRM Connector Configuration : Configuration for CRM integrations
- Name : A non-unique identifier for a record/document often used as a search tool.
- Reference : The data type of this field.
- Default : A value that is shown whenever a record is created.
- Main filter : This field indicates if an external business partner filter is shown in the main window
- Translatable : Indicates if an option for a ExtBP configuration property is translatable
- Message : The name of the application initiated message.
- Text : A place to add observations related to a specified check point.
- Sequence Number : The sequence indicates the priority of the grid configuration.
- Advanced Filter
- Advanced Filter Sequence Number : The sequence indicates the order for the advanced filter
- Allow Sorting : When this checkbox is checked, the column will be sortable.
- Selector Filter
- Filter Icon
- Filter used for scan : When an scanning is executed this filter will be used by CRM connector
- Minimum Characters
- Client : Client for this installation.
- CRM Connector Filter : Filters for CRM Connector integration
Filter Options
llow to define options accepted by parent filter
- Active : A flag indicating whether this record is available for use or de-activated.
- Filter Option Sequence Number : Filter Option sequence Number
- Search Key : A fast method for finding a particular record.
- Default : A value that is shown whenever a record is created.
- Translatable : Indicates if an option for a ExtBP configuration property is translatable
- Message : The name of the application initiated message.
- Text : A place to add observations related to a specified check point.
- Organization : Organizational entity within client
- Filter Option : An option to be selected in a filter
- Client : Client for this installation.
- CRM Connector Filter : Filters for CRM Connector integration
Address Mapping
Use this tab to define addresses and determine the properties that shoul be used for each location column mapping
- Organization : Organizational entity within client
- Active : A flag indicating whether this record is available for use or de-activated.
- CRM Connector Configuration : Configuration for CRM integrations
- Address Name : Address name for the mapping
- Address Line 1 : A space to write the location of a business partner.
- Address Line 2 : A space to write the location of a business partner.
- City Name : A populated defined area located within a larger area such as a state, province, or country.
- Postal Code : A identification code used to help get items to a specific location.
- Country
- Region
- Invoicing Address : Indicates that this address is the Invoicing Address
- Shipping Address : Business Partner address to ship goods to
- Client : Client for this installation.
- C_Extbp_Config_Loc_ID
| | Back to Screens_Reference |