Zum Inhalt

Parameter zu Contentserv-Export nach CSV

Parameter zu Contentserv-Export nach CSV

Parameter Description Type Version
Port Defines the port on the host/server to connect to. _Number

1.0.0
Port Defines the MySQL-port on the host/server to connect to. _Number

1.0.0
Port Defines the SCP-Port (default = 22), rsync (default for unencrypted=873) on the host/server to connect to. _Number

1.0.0
Port Defines the MS-SQL Port (default = 1433) on the host/server to connect to. _Number

1.0.0
Port Defines the Oracle-DB Port (Default=1521) on the host/server to connect to. _Number

1.0.0
Host Defines the database host - please indicate DNS name or IP address. _Text
1.0.0
Host Defines the database hosts of the Contentserv databases (for all DB)
- Explanation : It is important that the import database is also installed on this host.
_Text
1.0.0
RemoteDir Defines the "remote directory" in case of an FTP/SFTP/rsync transfer of files _Text
1.0.0
LocalDir Defines the "local directory" in case of an FTP/SFTP/rsync transfer of files. _Text
1.0.0
SMTPHost Defines the SMTP-host to send out the email. _Text
1.0.0
SMTPPort Defines the SMTP-port to send out the email. _Text
1.0.0
Cc Comma seperated list of email-addresses. _Text
1.0.0
Bcc Comma seperated list of email-addresses. _Text
1.0.0
To Defines the recipients of the email to be sent out be ADIB. _Text
1.0.0
From Defines the From-address for sending out emails via ADIB. _Text
1.0.0
Message Defines the message of the email sent via ADIB. _Text
1.0.0
Port Defines the port on the host/server to connect to. _Number

1.0.0
Port Defines the MySQL-port on the host/server to connect to. _Number

1.0.0
Port Defines the SCP-Port (default = 22), rsync (default for unencrypted=873) on the host/server to connect to. _Number

1.0.0
Port Defines the MS-SQL Port (default = 1433) on the host/server to connect to. _Number

1.0.0
Port Defines the Oracle-DB Port (Default=1521) on the host/server to connect to. _Number

1.0.0
User Defines the name of the user who has access to the (database) host. _Text
1.0.0
User Defines the name of the Contentserv database user who has access to the (database) host.
- Hint: This user needs to have access to all tables - and also to the ISA-import database.
_Text
1.0.0
User Defines the name of the user who has access to the (database) host. (in case of MS-SQL: root = "sa") _Text
1.0.0
Password Defines the password of the user that connects to the application. _Text
1.0.0
Password Defines the password of the user that connects to the the Contentserv database. _Text
1.0.0
Username Defines the username to the ms-access database in case it is protected. _Text
1.0.0
Query Defines the query (instead of the table) to access information from. This is useful if you want the create your own "select-SQL-statement" here - instead of defining ONE existing table or view in the database. _Text
1.0.0
Container The Excel-file to be written into or read from. _Text
1.0.0
database Name of the main Contentserv database. _Text
1.0.0
database_prefix Prefix of all tables of the contentserv database.
- Hint: Should be done like thi "cs_"
Selection_Free
  • cs (Default)

1.0.0
default_language Defines the default language in case a new product is to be imported into Contentserv. _Selection_Free
  • de

  • en (Default)

  • fr

1.0.0
default_item_parent Defines the uppermost node for the assets to be imported in the "asset tree" of Contentserv.
- Hint: Should have the EXTERNAL_KEY "ASSET_"+value
_Text
1.0.0
default_item_class Defines the default PIM-Class in case a new product is to be imported into Contentserv. Good idea to leave it blank. _Text
1.0.0
default_item_state
Defines the default state in case a new product is to be imported into Contentserv.
- Hint : You can leave it blank - and use the default value of Contentserv.
_Text
1.0.0
host Defines the database host - please indicate DNS name or IP address. _Text
1.0.0
host Defines the database hosts of the Contentserv databases (for all DB)
- Explanation : It is important that the import database is also installed on this host.
_Text
1.0.0
delete_logs_after_days Defines after how many days the log entries should be deleted.
- Hint: Please take care that this number is not too high - otherwise the deletion process will take a long time.
_Selection
  • 10

  • 50 (Default)

  • 100

1.0.0
password Defines the password of the user that connects to the application. _Text
1.0.0
password Defines the password of the user that connects to the the Contentserv database. _Text
1.0.0
password_service Define web-api-user-password towards the Contentserv application. _Text
1.0.0
isSecured Defines whether to select FTP (not recommended) or the Secure FTP (SFTP) protocol. _Selection
  • FTP

  • SFTP (Default)

1.0.0
port Defines the port on the host/server to connect to. _Number

1.0.0
port Defines the MySQL-port on the host/server to connect to. _Number

1.0.0
port Defines the SCP-Port (default = 22), rsync (default for unencrypted=873) on the host/server to connect to. _Number

1.0.0
port Defines the MS-SQL Port (default = 1433) on the host/server to connect to. _Number

1.0.0
port Defines the Oracle-DB Port (Default=1521) on the host/server to connect to. _Number

1.0.0
start_cs_import Defines whether the CS-webservice for import is to be called via ADIB. If set to false/0 then you need to trigger the ISA-import directly in Contentserv (good idea during the setup/debug phase). _Selection
  • Only fill ISA tables

  • Start CS-import after filling ISA tables (Default)

1.0.0
system_service Define the Contentserv instance (default: CSLive for a development system). _Text

Default: CSLive
1.0.0
url_main Define the URL to the Contentserv system. _Text
1.0.0
user Defines the name of the user who has access to the (database) host. _Text
1.0.0
user Defines the name of the Contentserv database user who has access to the (database) host.
- Hint: This user needs to have access to all tables - and also to the ISA-import database.
_Text
1.0.0
user Defines the name of the user who has access to the (database) host. (in case of MS-SQL: root = "sa") _Text
1.0.0
user_service Define web-api-user to access the Contentserv application. _Text

Default: admin
1.0.0
itemimport Defines if items (products / images) are to be imported into Contentserv. _Selection
  • Do not import items (products, assets)

  • Import items (Default)

1.0.0
subtableimport Defines whether subtable information are to be imported into Contentserv. _Selection
  • Do not import subtables

  • Import subtables (Default)

1.0.0
isa_database Defines the database name in which the ISA-tables of Contentserv-PIM reside. _Text

Default: cs_pimimport
1.0.0
isa_database Defines the database in which the ISA-tables of Contentserv-DAM reside. _Text

Default: cs_pimimport
1.0.0
isa_database Defines the database name in which the ISA-tables of Contentserv-PIM reside. _Text

Default: cs_damimport
1.0.0
isa_database Defines the database in which the ISA-tables of Contentserv-DAM reside. _Text

Default: cs_damimport
1.0.0
Subject Defines the "subject" of the email to be sent out by ADIB. _Text
1.0.0
Port Defines the port on the host/server to connect to. _Number

1.0.0
Port Defines the MySQL-port on the host/server to connect to. _Number

1.0.0
Port Defines the SCP-Port (default = 22), rsync (default for unencrypted=873) on the host/server to connect to. _Number

1.0.0
Port Defines the MS-SQL Port (default = 1433) on the host/server to connect to. _Number

1.0.0
Port Defines the Oracle-DB Port (Default=1521) on the host/server to connect to. _Number

1.0.0
auth_encoding Defines the encoding for a webservice (API) call. In most cases this will be "Base64". _Selection
  • None

  • Base64 (Default)

1.0.0
auth_user Shopware user
Explanation
- Shopware user
_Text
1.0.0
auth_user Defines the user (or client_id in case of OAuth2) for the API call to the webservice. _Text
1.0.0
auth_user Defines the user (or client_id in case of OAuth2) for the API call to the webservice. _Text
1.0.0
auth_key Defines the key (or password / or client_secret in case of OAuth2) for the API call to the webservice. _Text
1.0.0
auth_key Defines the key (or password / or client_secret in case of OAuth2) for the API call to the webservice. _Text
1.0.0
auth_key Defines the key (or password / or client_secret in case of OAuth2) for the API call to the webservice. _Text
1.0.0
auth_type Defines the "authentication type" for the API call to the webservice. In most cases this will be "Basic". _Selection
  • Basic (Default)

  • OAuth2

1.0.0
ws_main_URL Defines the main URL to the webservice or complete path to the elastic-search server - must start with http:// or https:// _Text
1.0.0
ws_main_URL Defines the main URL to the webservice. _Text
1.0.0
elastic_hits_per_page Defines how many hits per page in result view should be displayed. _Selection_Free
  • 10

  • 20 (Default)

  • 50

  • 100

1.0.0
Port Defines the port on the host/server to connect to. _Number

1.0.0
Port Defines the MySQL-port on the host/server to connect to. _Number

1.0.0
Port Defines the SCP-Port (default = 22), rsync (default for unencrypted=873) on the host/server to connect to. _Number

1.0.0
Port Defines the MS-SQL Port (default = 1433) on the host/server to connect to. _Number

1.0.0
Port Defines the Oracle-DB Port (Default=1521) on the host/server to connect to. _Number

1.0.0
User Defines the name of the user who has access to the (database) host. _Text

Default: sa
1.0.0
User Defines the name of the Contentserv database user who has access to the (database) host.
- Hint: This user needs to have access to all tables - and also to the ISA-import database.
_Text

Default: sa
1.0.0
User Defines the name of the user who has access to the (database) host. (in case of MS-SQL: root = "sa") _Text

Default: sa
1.0.0
bulk_size Number of elements (documents) per call to the webservice. _Selection_Free
  • 1

  • 10 (Default)

  • 50

  • 100

  • 1000

1.0.0
WhereCondition (if value is : get Value from last run!
Explanation
- I.e. ID > ID to get data from ID onward that was not exported last time.
_Text
1.0.0
ws_resource_core Defines the endpoint of the webservice in case of using the "general webservice". _Text
1.0.0
ws_main_URL Defines the main URL to the webservice or complete path to the elastic-search server - must start with http:// or https:// _Text
1.0.0
ws_main_URL Defines the main URL to the webservice. _Text
1.0.0
Passphrase In case of private/public key data transfer: define passphrase of your key file.
_Text
1.0.0
Keyfile In case of private/public key data transfer: define name of your private key file.
_Text
1.0.0
bulk_size_insert Number of elements (documents) per insert call to ElasticSearch. _Selection
  • 1

  • 10 (Default)

  • 50

  • 100

  • 1000

1.0.0
auth_user Shopware user
Explanation
- Shopware user
_Text

Default: elastic
1.0.0
auth_user Defines the user (or client_id in case of OAuth2) for the API call to the webservice. _Text

Default: elastic
1.0.0
auth_user Defines the user (or client_id in case of OAuth2) for the API call to the webservice. _Text

Default: elastic
1.0.0
auth_key Defines the key (or password / or client_secret in case of OAuth2) for the API call to the webservice. _Text

Default: changeme
1.0.0
auth_key Defines the key (or password / or client_secret in case of OAuth2) for the API call to the webservice. _Text

Default: changeme
1.0.0
auth_key Defines the key (or password / or client_secret in case of OAuth2) for the API call to the webservice. _Text

Default: changeme
1.0.0
auth_user Shopware user
Explanation
- Shopware user
_Text
1.0.0
auth_user Defines the user (or client_id in case of OAuth2) for the API call to the webservice. _Text
1.0.0
auth_user Defines the user (or client_id in case of OAuth2) for the API call to the webservice. _Text
1.0.0
auth_key Defines the key (or password / or client_secret in case of OAuth2) for the API call to the webservice. _Text
1.0.0
auth_key Defines the key (or password / or client_secret in case of OAuth2) for the API call to the webservice. _Text
1.0.0
auth_key Defines the key (or password / or client_secret in case of OAuth2) for the API call to the webservice. _Text
1.0.0
solr_core Defines the name of the core to create or to insert data into. _Text

Default: gettingstarted
1.0.0
elastic_index Defines the name of the elastic-index to be created or to be filled. _Text
1.0.0
elastic_index Defines the name of the elastic index (simple string) - or in case of multilanguage - must be a JSON : {"de" :"cs_pim_2", "en": "cs_pim_1"} _Text
1.0.0
elastic_version Defines the main version of elastic search server to connect to (i.e 6 or 7 or 8). Important as there were some breaking changes between version 6 and 7. BUT: Can be left to ist default value. _Selection
  • 6

  • 7 or greater (Default)

1.0.0
recreate_index_first Defines how to proceed with existing elasticsearch-indices. You choose between deleting it first and recreate it during the data transfer (recommended if the number of products is not to high and the updates do not occur too often) - and also if you want ADIB to create the mapping explicitly (which is in general not necessary!). Best choice is the default value. _Selection
  • Do not recreate index (Default)

  • Recreate index before exporting data

  • Recreate index and define mapping.

1.0.0
auth_encoding Defines the encoding for a webservice (API) call. In most cases this will be "Base64". _Selection
  • None

  • Base64 (Default)

1.0.0
auth_type Defines the "authentication type" for the API call to the webservice. In most cases this will be "Basic". _Selection
  • Basic (Default)

  • OAuth2

1.0.0
language_id Contentserv-language-ID that corresponds to the language to be exported.
- Explanation: In general : 1 for english, 2 for german, 3 for french, ... Could also be a list of languages (as a json)
_Text

Default: 1
1.0.0
suppress_folders Defines whether ADIB should export Contentserv-folders (i.e. objects that have children within the product tree) or not. _Checkbox

1.0.0
elastic_log_index Defines the name elastic-search index to write the logs to. _Text
1.0.0
elastic_log_host Defines the elastic search host to write the logs to. _Text
1.0.0
elastic_log_user Defines the user to access the elastic-search server for intense-logging. _Selection_Free
  • elastic (Default)

1.0.0
elastic_log_key Defines the key (or password) of the defined "elastic_log_user" to access the elasticsearch server for intense-logging. _Text
1.0.0
log_file_separator Defines the separator for logs within "intense logging". Should be left at the default value. _Selection_Free
  • ; (Default)

  • ,


elastic_host Defines the elasticsearch host in which the elastic-indices are kept. _Text
1.0.0
elastic_user Defines the user to access the elastic-search server for ADIB-portal. _Selection_Free
  • elastic (Default)

1.0.0
elastic_key Defines the the key (or password) of the defined "elastic_user" to access the elasticsearch server for ADIB-portal. _Text
1.0.0
csv_filename Name of the csv file which contains the attributes at "product-level" (or highest level) that is created by ADIB. _Text

Default: externalData/test.csv
1.0.0
csv_file_separator Defines the separator of the csv file. _Selection_Free
  • ; (Default)

  • ,


create_htmltable_fromsubtable Defines whether a html-table is to be created for all lines of the subtable. Afterwards you can display the list of all those fields in the ADIB-portal. _Checkbox

1.0.0
create_json_fromsubtable Defines whether a json-object is to be created for all existing subtables. _Checkbox

1.0.0
create_facetfields_fromsubtable Defines whether the fields of the subtable are to be inserted into elasticsearch as a new field. If you choose this option you can create a facet-field out of the values of the subtable. You also can search specifically in this subtable field in the search-bar of the ADIB-portal. _Checkbox

1.0.0
create_htmltable_fromreference Defines whether a html-table is to be created for all existing refernces. Afterwards you can display the list of all those fields in the ADIB-portal. _Checkbox

1.0.0
create_json_fromreference Defines whether a json-object is to be created for all existing refernces. _Checkbox

1.0.0
elastic_size Defines the max. number of hits from elastic to be transferred at once. Take care that this number is not too high (otherwise not all data can be transferred) and not too small (otherwise the performance will be reduced). _Selection_Free
  • 10

  • 50

  • 100 (Default)

  • 500

1.0.0
stateid If set then only products of the defined state are exported
_Text
1.0.0
elastic_index Defines the name of the elastic-index to be created or to be filled. _Text
1.0.0
elastic_index Defines the name of the elastic index (simple string) - or in case of multilanguage - must be a JSON : {"de" :"cs_pim_2", "en": "cs_pim_1"} _Text
1.0.0
dest_elastic_host Defines the destination server of elasticsearch server for ADIB-portal. _Text
1.0.0
dest_elastic_index Defines the name of the elasticindex on the destination elasticsearch server for ADIB-portal. _Text
1.0.0
parent_itemid Defines the Contentserv-ID of the item from which the export should start.
- Hint: This parameter will be set as deprecated soon. So better define the value at the step_position by setting the condiition.
_Text
1.0.0
dest_elastic_user Defines the user to access the destination elasticsearch server for ADIB-portal. _Text

Default: elastic
1.0.0
dest_elastic_key Defines the the key (or password) of the defined "dest_elastic_user" to access the destination elasticsearch server for ADIB-portal. _Text
1.0.0
apply_filter_only_on_client If set to true/1 then the export for elasticsearch has no restriction concerning field-values, parentID etc.: This is only done for the client application. Therefore all data are exported and written into the ADIB-elasticindex. _Checkbox

1.0.0
apply_filter_only_on_client If set to true/1 then the export for elasticsearch has no restriction concerning field-values, parentID etc.: This is only done for the client application. Therefore all data are exported and written into the ADIB-elasticindex. _Checkbox

1.0.0
insert_all_subtable_fields If set to true/1 then each selected subtable is exported with ALL fields (and not only with selected fields) . _Selection
  • Use only selected subtable fields (Default)

  • Use all subtable fields

1.0.0
image_base_url Defines the "base-URL" to place where all images reside - in case an image field is used which only contains the image names - but not the URL / the directory where they reside. _Text
1.0.0
image_field Defines the name of the field which contains the name of the image. _Selection

1.0.0
image_suffix Defines the suffix (of image_field name) for pictures (i.e. ".jpg") _Text
1.0.0
reference_linkfields Defines the fields of a referenced product to be shown in the list. _Text

Default: "Label"
1.0.0
reference_sortorder Defines the sort order for the list of referenced elements. _Text
1.0.0
price_field Defines the price field used in the basket to calculate the sum. _Selection

1.0.0
database_CSsrc_migrator Name of the CS-database as source for configuration / migration. _Text
1.0.0
host_CSsrc_migrator Defines the database hosts of the Contentserv databases as source for configuration
- Explanation : It is important that the import database is also installed on this host.
_Text
1.0.0
port_CSsrc_migrator Defines the port to MySQL to CS-database as source for configuration. _Number

1.0.0
user_CSsrc_migrator Defines the name of the user of the Contentserv database (as source for configuration) who has access to the (database) host.
- Hint: This user needs to have access to all tables - and also to the ISA-import database.
_Text
1.0.0
password_CSsrc_migrator Defines the password of the user that connects to the the Contentserv application as source for configuration. _Text
1.0.0
label_field Defines the field to be shown in grid mode beneath the picture of the search portal. _Selection

1.0.0
price_field Defines the price field used in the basket to calculate the sum. _Selection

1.0.0
button_field The field below which the "call-2-action" buttons will be placed within the ADIB-portal. _Selection

1.0.0
ws_simulate Defines whether the webservice calls should be executed (set false/0) - or just simulated (true/1). In case of "ws_simulate=true) the calls are written into files - so they can be analysed before really calling the webservice. _Selection
  • Call webservice via API (no simulate) (Default)

  • Only write API calls into file (simulate)

1.0.0
searchportal_show_basket Defines whether the basket-icon button should be shown. This will allow the user to put the product into the basket. _Checkbox

1.0.0
searchportal_show_compare Defines whether the compare button should be shown. This will allow the user to put the product into the compare list. _Checkbox

1.0.0
searchportal_show_details Defines whether the [i] (to go into the details of the product) button should be shown. _Checkbox

1.0.0
searchportal_show_excel Defines whether the excel button should be shown. This will allow the user to put the product into the download list. _Checkbox

1.0.0
searchportal_show_pdf Defines whether the PDF button should be shown. This will allow the user to create a datasheet on-the-fly based on an existing PDF-template. _Checkbox

1.0.0
searchportal_languages Defines the languages of the ADIB-portal. _Text

Default: ["de","fr","en"]
1.0.0
searchportal_default_language Defines the default language of the ADIB-portal. _Selection
  • de (Default)

  • en

  • fr

1.0.0
searchportal_custom_language This parameter allows you to overwrite the standard translation of the ADIB-portal - and use your own wording.
- Example:
- {
"fr": {
"home": {
"search": "Recherche libre",
"grid" : "Grille",
"table" : "Tableau",
"list" : "Liste",
}
}
}
_Text

Default: { }
1.0.0
searchportal_pdf_config Defines the standard elements of PDF-creation within the ADIB-portal.
- Example:
const default_pdf_config = {
page_margin_top: 80,
page_margin_bottom: 20,
font_size_register: 18,
font_size_section: 12,
font_size_tabletext: 11,
page_margin_header_top : 30,
page_header_height: 50,
fillColor_page_header: "#DDDDDD",
textColor_page_header: "#0A2E39",
textColor_tabletext: "#888888",
textColor_section: "#6666BB",
textColor_register: "#6644DD",
positionLeft_register: 42,
columnWidth_fieldLabel: 180,
logo_width: 150,
logo_height: 20,
logo_right: 100,
headline_left: 350
};
_Text

Default: { }
1.0.0
searchportal_hits_options Defines the selection of number of hits within the portal. _Text

Default: [10, 25, 50, 100]
1.0.0
multiselect_separator_dest Defines the character to separate multiple values within one field of the destination (i.e. the csv file). _Selection_Free
  • Newline (standard for CS)

  • ; (Default)

  • ,


tab_field Defines the field to be shown in the tabs (under the searchbar) in ADIB-portal. _Selection

1.0.0
searchportal_order_by Defines the field which is used as sort order for the hits in the portal. You choose a field out of the defined field list of the "step-positions". _Selection

1.0.0
SMTPUser Defines the SMTP-user to send out the email. _Text
1.0.0
SMTPPassword Defines the password of the SMTP-user to send out the email. _Text
1.0.0
Attachment Defines the attachment to the email. _Text
1.0.0
searchportal_color_config Defines a JSON-configuration to define colors for the search/edit-portal. _ComplexJSON

1.0.0
portal_name Defines the name of the ADIB-portal. This name also appears on the browser. _Text

Default: CONIGON ADIB Search-Portal
1.0.0
label_field_length Defines the number of characters to be shown as identifier for the label (beneath the picture). _Selection
  • 10

  • 15

  • 20 (Default)

1.0.0
tab_field_length Defines the number of characters to be shown as identifier for a tab. _Selection
  • 10

  • 15

  • 20 (Default)

1.0.0
searchportal_field_list_mapping Defines an additional mapping of (foreignkey-)fields - allowing you to add color or icon or change text for defined values of fields.
- Example: [ { dataField: "StateID", mapping: [{ src: ["14"], dest: "50 - Betrieb", color : "#008800", icon : "", show: "2", text: "Betrieb" }, { src: ["1","2","3","5"], dest: "Vorbereitung", color : "#0000FF", icon : "", show: "2", text: "Vorbereitung" }, { src: ["5","7","9","11","12","13","18"], dest: "Bearbeitung", color : "#E2B007",icon : "", show: "2", text: "Bearbeitung" },{ src: ["4","6","8","10","15","16", "17"], dest: "EOL / In Prüfung", color : "#FF0000", icon : "", show: "2", text: "EOL / In Prüfung" }]}, { dataField: "Kunde", mapping: [{ src: ["Bw"], dest: "Bundeswehr", color : "#0000FF", icon : "", show: "0", text: "" }]} ]
_ComplexJSON

1.0.0
elastic_index_foreignkey Defines the name of the elastic index for foreignkeys. Default is same as elastic_index including "_foreignkey". _Text
1.0.0
export_multiselect_separator Defines the separator for the Contentserv-Elastic to csv export in case of multiselect fields (i.e. valueranges that can multiple values). _Selection_Free
  • ; (Default)

  • ,


elastic_index_changes Defines the name of the elastic index for changes. Default is same as elastic_index including "_changes". _Text
1.0.0
id_field Defines the ID field (i.e. for elastic-search) as fallback - if not defined by "isKey" within step_position. _Selection

1.0.0
elastic_incremental_datefield Defines the field within (source-)elastic index that defines last change date of documents within the index. _Text

Default: LastChange
1.0.0
setLastExecutionTime Defines the default date from which the export data are exported from (source)index/table. _Text

Default: "__lastExecutionTime__"
1.0.0
valuelistimport Defines whether valuelists are to be imported into Contentserv. _Selection
  • Do not import valuelists

  • Import valuelists (Default)

1.0.0
configimport Define whether the configuration (i.e. the data-model) should be imported into Contentserv. _Checkbox

1.0.0
truncate_destination_at_start Defines whether the destination table is to be truncated before importing data. _Checkbox

1.0.0
truncate_destination_at_start Defines whether the Contentserv-ISA-import-tables are to be truncated before importing data. _Checkbox

1.0.0
truncate_source_at_end Defines whether the source table is to be truncated after exporting the data (put true/1 in case of an incremental step). _Checkbox

1.0.0
token_url Defines the token_url . This is used to create a new or update an existing token being used for the subsequent API calls to the webservice. Important parameter for OAuth2 based webservices. _Text
1.0.0
grant_type Defines the grant_type for an API call.
Example: For OAuth2: Define grant type (Client Credentials - or - Password Credentials)
_Selection
  • Client Credentials (Default)

  • Password Credentials

1.0.0
auth_mode For OAuth2: Where to put the token (header - or - body)
_Selection
  • header (Default)

  • body

1.0.0
final_dest_sql Defines an SQL statement (i.e. UPDATE) that is to be triggered at the end of the import towards the destination database. _Text
1.0.0
dynamic_classes_addition Defines the behavior of classes defined in the import tables and how they should be sent to Contentserv-ISA.
- Hints: If set to "Choose appropriate class on empty class" then the class containing the attribute with a value (!=Null or empty) is automatically assigend to the product. Set "No dynamic classes" if you want only previously defined classes to be assigned - take care: if there is no class assigned the data will be skipped completely. If you want to just copy the content of the CLASS_ID field in the import table - then choose "Just used defined class of tbl_maindata (empty or filled)".
_Selection
  • No dynamic classes

  • Choose appropriate class on empty class (Default)

  • Just used defined class of tbl_maindata (empty or filled)

1.0.0
denyCSVlog If set to false/0 then no logging will be started. _Checkbox

1.0.0
image_server_url Defines the complete path to the CS-image server incl. URL for a MAM-ID
- Example : https://contentserv.conigon.ovh/admin/rest/file/download/XX_ID_XX
_Text
1.0.0
add_csid2filename If this parameter is set to true/1 then the Contentserv-DAM-ID will be added to the filename as prefix - i.e. 2324_test.pdf.
Explanation
- This is helpful when you need to identify the file in a reference to PIM where you only have the CS-ID of the DAM-element .
_Checkbox

1.0.0
localfilepath_assets Defines where the downloaded files are stored in the file system of ADIB (IntegrationClient). Will be the starting point for copying the files to your website or a CDN.
- Hint: Should always be like externalData/
_Text

Default: externalData/assets/all/
1.0.0
localfilepath_assets_new Defines where the newly downloaded files (which were changed since the last call) are stored in the file system of ADIB.
_Text

Default: externalData/assets/new/
1.0.0
image_server_user Defines the the user to access the image server. _Text

Default: admin
1.0.0
image_server_pwd Defines the password of the user (as defined by the parameter "image_server_user") - who has access to the image server. _Text
1.0.0
image_server_format This parameter is used to define the the image type (or format) when downloading the images.
- Hint: Using this parameter all images in Contentserv will be converted to the defined format (i.e. PSD-files to jpg)
_Selection
  • jpg (Default)

  • png

1.0.0
image_server_dimension This parameter is used to resize / reformat the original images to a new size.
- Hint: Using this parameter all images in Contentserv will be converted to the defined format to these dimensions.
_Selection_Free
  • width=1024 (Default)

  • width=800

  • height=1024

  • height=800

1.0.0
filetype_mapping Can be used to add another paramter to the names of file - for later mapping. This is espacially useful if you want to export referenced assets (i.e. PDF-documents - which are exported from Contentserv-DAM) and need to create the link between those assets and the corresponding products - as the products were exported in a separate export (from Contentserv-PIM). _Text

Default: { }
1.0.0
filetype_id Defines the Contentserv-attribute that holds the information about the mapping
- Example: "15:FormattedValue" (if attribute-id 15 contains this info). Can be used for an OroCommerce-interface.
_Text
1.0.0
image_extensions Defines the file-extensions that count as images! IMPORTANT: only for these types the image conversions is applied.
- Example: ["png", "jpg", "psd", "gif"]
_Text

Default: ["png", "jpg", "psd", "gif"]
1.0.0
csv_filename_subtable Name of the csv file which contains the attributes at "subtable-level" that is created by ADIB. _Text

Default: externalData/test_subtable.csv
1.0.0
file_modification_field Field in Contentserv to identify whether the file is considered as "changed" and needs to be downloaded once again.
- Explanation: Correct values could be "FileModificationDate" or "LastChange" - in this case the file is also downloaded if metainformation (defined in Contentserv) has changed.
_Selection_Free
  • FileModificationDate (Default)

  • LastChange

1.0.0
foreignkey_sql_statement Defines the SQL select-statement to fetch data from a DBMS for an Elastic-ForeignKey-Index. _Text
1.0.0
src_subtables Contains a semicolon-separated list of all the subtables that have to be dry run additionally
_Text
1.0.0
sql_statement STILL USED? Rather not - as those elements are defined for the source-module! _Text
1.0.0
src_connection_parameter STILL USED? Rather not - as those elements are defined for the source-module! _Text
1.0.0
elastic_docker_host Defines the name of the docker container in which the destination elasticsearch host is installed. This is the better alternative to defining the public URL in case the elasticsearch host is installed on the same docker as the source system. _Text
1.0.0
continueAfterFailure Used for clientconfig-steps. If true/1 the step will continue with the next steps even if an error occurs during a clientconfig. _Checkbox

1.0.0
simulate If true then the action (i.e. writing back data to the original database) is not performed - but just simulated.
_Selection
  • Write back data to original source (no simulate) (Default)

  • Do not write back - only simulate

1.0.0
searchportal_bucket_size Defines the max. number of buckets to be shown in ADIB-Portal (i.e. for facets). _Selection
  • 10

  • 50

  • 100 (Default)

  • 200

1.0.0
searchportal_query_size Defines the max. number of hits to be shown, downloaded or multi-edited in ADIB-Portal. _Selection
  • 100

  • 1.000

  • 5.000 (Default)

  • 10.000

1.0.0
src_table_write Defines the (original) source table to which changes are written back.
_Text
1.0.0
timeout Defines the maximal time of a (clientconfig) step (in seconds). After reaching this time the job is killed.
_Selection_Free
  • 1800

  • 3600

  • 7200 (Default)

  • 50.000

1.0.0
subtable_leadingfields Defines the first columns in the csv-export file for subtables. Use this to create the reference to the "main-table" - i.e. the product itself. _Text

Default: "ID", "Field",
1.0.0
strict_mode Defines how ADIB should proceed with the job (i.e. a sequence of steps) in case of problems in one step. _Selection
  • Ignore (not critical) errors and continue (Default)

  • Stop in case of problems and return error log

1.0.0
content_type_header Defines the "Content Type" of the API call. Common value is "application/json". _Selection_Free
  • (Empty)

  • application/pdf

  • application/json

  • application/xml

  • application/x-www-form-urlencoded

1.0.0
accept_header Defines the type of headers that are accepted as a response from the webservice call. In most cases this is "application/json". Can be left blank. _CHECK

1.0.0
viewport_desktop Defines the size of the browser when the ADIB-portal switches to desktop mode.
- Hint: Lower width will set the portal to the partially reduced desktop mode.
_Selection_Free
  • 1000

  • 1250 (Default)

  • 1400

1.0.0
viewport_mobile Defines the size of the browser when the ADIB-portal switches to mobile mode.
- Hint: Lower width will set the portal to the partially reduced mobile mode.
_Selection_Free
  • 600

  • 850 (Default)

  • 1000

1.0.0
log_level Defines the log-level of clientconfig steps (disabled, process, enabled, detail) _Selection
  • 0 - logs disabled

  • 1 - only process logs

  • 2 - standard logs (Default)

  • 3 - detailed logs

1.0.0
elastic_index_reference Defines the name of the elastic-index which contains the documents to which the references are pointing to. Default is same as the value in "elastic_index"
- Explanation: If you have Contentserv-PIM as elastic-index and want to reference i.e. to filename in the DAM, then set the name of the Contentserv-MAM-elastic-index here.
_Text
1.0.0
references_as_array Define how to proceed with references - whether to create an array out of it or keep it as a string. _Selection
  • Store references as string (Default)

  • Store references as array

1.0.0
references_as_array Define how to proceed with references - whether to create an array out of it or keep it as a string. _Selection
  • Store references as string

  • Store references as array (Default)

1.0.0
searchportal_show_version_info Defines whether the ADIB-portal version info and export date of data are shown in the footer of the portal. _Checkbox

1.0.0
searchportal_reference_image_config Defines a conversion of image-files (i.e. eps, psd,..) to a standard export image filetype (i.e. .jpg)
Explanation
- Example: {"fields": ["Photos Produit"], "org_suffix" : ["psd","eps","png"], "suffix": "jpg"}
_Text

Default: { }
1.0.0
csv_file_delimiter Defines the delimiter of the csv file. _Selection_Free
  • Double-quote (\")

  • Single-quote (')

  • Empty

1.0.0
image_extensions_download_original If this parameter is set to true/1 then the original image is also downloaded - and not only the preview picture. Active this if you need the original image file i.e. for download.
- Hint: This is helpful when creating an additional document portal.
_Selection
  • Download only preview (recommended (Default)

  • Download preview and original

1.0.0
file_extensions_create_preview If this parameter is set to true/1 then a preview picture of the file is created (i.e. first page of a PDF document). Active this if you want the user to see this preview picture on the ADIB-portal.
- Explanation: This is helpful when creating an additional document portal.
_Checkbox

1.0.0
timestamp_field Defines the name of the timestamp-field in the elastic-index.
- Hint: By default this should just be timestamp or @timestamp. Please check your elastic index!
_Text

Default: timestamp
1.0.0
connection_parameter Additional MS-SQL connection parameter - ofter the instanceName= is important!
_Text

Default: ;trustServerCertificate=true;CharacterSet=UTF-8
1.0.0
connection_parameter Additional MySQL connection parameter - ofter the "serverTimezone" (i.e. Europe/Paris) is important. _Text

Default: ;trustServerCertificate=true;CharacterSet=UTF-8
1.0.0
connection_parameter Additional Oracle connection parameter. _Text

Default: ;trustServerCertificate=true;CharacterSet=UTF-8
1.0.0
open_all_sections_button Defines wheter the checkbox for "open all sections" is visible. _Selection
  • Hide \"Open all sections\"

  • Show \"Open all sections\" (Default)

1.0.0
fuzziness Defines the search logic in the free search bar on top of the portal.
- Explanation : If you set it to 0 there is no fuzzy: the search engine looks exactly for the word you type in. Otherwise it will also search for parts of the word and accept errors.
_Selection
  • No fuzzy - only correct words (Default)

  • Fuzzy logic for search

1.0.0
searchbar_live_search_OBS Defines whether the search engine should automatically start to search after one second.
Explanation
- If you set it to 0 then the user must click of the "return" button before the search is triggered.
_Selection
  • Automatically trigger search (Default)

  • Trigger search after click on return

1.0.0
searchbar_query_format Defines whether the search engine should search for all words you type in the search bar ("and") or any word ("or").
- Hint: The number of hits might be too small if you choose "and". On the other hand if you select "or" and the user types in too many words there might be too many hits…
_Selection
  • Find any search words (Default)

  • Find all search words

1.0.0
logo Defines the logo for the ADIB-portal (on top left side). _Upload

1.0.0
no_image_found Defines the default picture - if no image was defined or can be found. _Upload

1.0.0
show_advanced_search Defines whether the menu containing the fields beside the searchbar should be visible.
- Hint: This function is comparable to the facets on the left side. If you select a field the user will automatically see the different results for that field.
_Checkbox

1.0.0
show_user_button Defines whether the user / login-icon (as a "user-menu") on the right upper side of the portal should be displayed. It is important to set the value to true - as functions like "download list", "compare list", "language selection" are set within this menu. _Checkbox

1.0.0
file_types_for_download Defines the formats that will be available for download in case of a reference field to media assets.
- Explanation : You can restrict the field-types i.e. to only pdf and jpg - to avoid that a customer can download a word or excel document. If empty - all field types are allowed!
_Text

Default: []
1.0.0
show_button_reference_subtable Defines whether the content is directly displayed or only after click of a button in case of a reference or subtalbe attribute.
- Explanation : Espacially in case of large subtables or a high number of references it could be better to set this value to true/1 - in order to only show this content if the user is really interested in seeing it.
_Checkbox

1.0.0
config_filetypes Defines filetype for "preview" (in general only PDF) or direct download for file-reference attributes.
- Hint: You can leave the download-element empty to allow all filetypes to be available for download.
_Text

Default: {<br/> "preview": ["pdf"],<br/> "download": ["pptx", "docx", "xlsx", "doc", "txt"],<br/> "show_preview": "1",<br/> "show_download": "1"<br/> }
1.0.0
show_pdf_preview Defines whether in case of PDF-download ADIB should try to show the preview - or just the button.
- Explanation: Keep in mind that it is not always possible to generate the preview picture - and that it could slow down the process. In case of Contentserv ADIB will try to get the created image by Contentserv.
_Checkbox

1.0.0
force_cc_execution If set to true/1 all clientconfig processes are executed even if no data transfer between src-module and dest-module took place.
- Explanation : If set to false/0 and a srcmodule is used then the client config is only executed if data got transfered from src to dest…
_Checkbox

1.0.0
protected_values_mapping This parameter is only analysed in case of a "mapping list". If true/1 a circular reference is prohibited.
- Explanation: If 1 ADIB checks if the value created by the DEFAULT definition already exists as a destination field - in this case this dynamic mapping is not created.
_Selection
  • Automatic creation (standard) (Default)

  • Avoid circular reference

1.0.0
searchbar_preview Defines if/how preview results as a list should appear in the "free-text search-bar".
- Hint: You can even define if the attribute in which the search result is found should be displayed to group the results.
_Selection
  • No list preview with results. Click on return to get results

  • List of results will appear under the bar - without result attribute. (Default)

  • List of results will appear under the bar - with result attribute.

  • No list preview - but result will be automatically displayed after 2 seconds.

1.0.0
admin_elastic_index Defines the name of the admin index - in which i.e. the templates are stored. In general this parameter can be left to the default value - so no need to change it. _Text

Default: conigonportal_admin
1.0.0
searchportal_url_like Defines whether a search filter as GET parameter should search exactly the defined value or not.
_Selection
  • Search exactly for the defined value (Default)

  • Search 'LIKE' the defined value.

1.0.0
assetlist_tableview Defines the presentation of image fields in case there are multiple images for one product. _Selection
  • Lists the images one beside the other.

  • Creates a table with 'name of image file' and the image itself. (Default)

1.0.0
cest_path Defines the endpoint of the CentralStation that provides the information.
Hint: If 'Analysis' is selected as cloudstream_procedure, this field has no effect.
_Selection
  • Data Export

  • Data Import

  • Conigon Module

1.0.0
portal_type Defines the general setup of the ADIB portal. You have several options such as showing/hiding the header, showing the facets, showing only one (the first) product - in this case you can profit from filtering within the portal. This type of "portal" is useful when you have an existing (web-) application and want to use ADIB to just show the related documents of the selected product. _Selection
  • Standard (header, facet, results, defined filter can be removed) (Default)

  • Single (show only first result, open detail page) - show header

  • List (show all results in a list - without header, facet)

  • only_results (show all results - but keep header, facets - except selected facets (as defined in GET parameter, and do not show the search filter for the defined GET parameter)

  • Single (show only first result, open detail page) - without header

1.0.0
cest_path Defines the endpoint of the CentralStation that provides the information. _Selection
  • Data Export

  • Data Import

  • Conigon Module

1.0.0
connection_parameter Additional MS-SQL connection parameter - ofter the instanceName= is important!
_Text

Default: ?serverTimezone=Europe/Paris&zeroDateTimeBehavior=convertToNull
1.0.0
connection_parameter Additional MySQL connection parameter - ofter the "serverTimezone" (i.e. Europe/Paris) is important. _Text

Default: ?serverTimezone=Europe/Paris&zeroDateTimeBehavior=convertToNull
1.0.0
connection_parameter Additional Oracle connection parameter. _Text

Default: ?serverTimezone=Europe/Paris&zeroDateTimeBehavior=convertToNull
1.0.0
changes_index_separator Defines the separator to be put in the changes index for multiselect fields
Hint:For Contentserv this should be comma.
_Text
  • Comma (Default)

  • Semicolon

  • Pipe

Default: ,
1.0.0
filename Defines the name of the xml-file to be read or created. _Text
1.0.0
filename_column Defines the column within the source (i.e. database table) that contains the name of (XML-)filename where to write the export. This is more dynamic in case that you need to create several XML-files within one export (as in such a case defining ONE static file will not be sufficient). _Text
1.0.0
row_template Defines the row template for an XML export file. _Text
1.0.0
file_template Defines the template file to be used for the XML-export. Can be left empty if the XML is created i.e. by a flexmapping function. _Text
1.0.0
use_class_mapping Defines whether the (product) class needs to be taken into account when displaying the attributes (fields) selected in the ADIB-portal.
- Explanation: If set to false/0 then selected attributes are shown in the portal independant of the class- or product-structure (and the mapping of the defined attributes of the class and the classes assigned to the product). This is an important parameter in case of an Edit-portal.
_Checkbox

1.0.0
Port Defines the port on the host/server to connect to. _Number

1.0.0
Port Defines the MySQL-port on the host/server to connect to. _Number

1.0.0
Port Defines the SCP-Port (default = 22), rsync (default for unencrypted=873) on the host/server to connect to. _Number

1.0.0
Port Defines the MS-SQL Port (default = 1433) on the host/server to connect to. _Number

1.0.0
Port Defines the Oracle-DB Port (Default=1521) on the host/server to connect to. _Number

1.0.0
connection_parameter Additional MS-SQL connection parameter - ofter the instanceName= is important!
_Text
1.0.0
connection_parameter Additional MySQL connection parameter - ofter the "serverTimezone" (i.e. Europe/Paris) is important. _Text
1.0.0
connection_parameter Additional Oracle connection parameter. _Text
1.0.0
recreate_activescript Defines whether the activescript should be recreated (1) or left unchanged (0)
_Checkbox

1.0.0
searchportal_filter_table_headers Defines whether a filtering should be possible for the table headers (in table view) and for attributes representing (sub)tables) _Selection
  • Include filtering for all table types (Default)

  • Filtering only for main-view

  • Filtering only for (sub)table attributes

  • No filtering on tables

1.0.0
searchportal_show_shares Defines whether the shares button should be shown. This will allow the user to create shares (sub-portals) which contain a subset of the elements shown in the ADIB-portal. Furthermore it can be defined in which period the shares should be active - and how the portal should look like. _Checkbox

1.0.0
truncate_destination_at_start Defines whether the destination table is to be truncated before importing data. _Checkbox

1.0.0
truncate_destination_at_start Defines whether the Contentserv-ISA-import-tables are to be truncated before importing data. _Checkbox

1.0.0
result_handling Defines the logging of the data transfers. You can identify errors and warning based on the return values of additional functions/scripts. _Text

Default: [{"type" : "error", "regex" : "^\\[ERROR\\]"},{"type" : "error", "regex" : "^\\[CRITICAL\\]"},{"type" : "warning", "regex" : "^\\[WARN\\]"}]
1.0.0
use_vpn Defines if the VPN-tunnel should be built up upon start of the step.
_Checkbox

1.0.0
vpn_server Defines the server to which the VPN tunnel is set up. _Text

Default: ````````````
1.0.0
vpn_user Defines the name of the user for the VPN tunnel. _Text

Default: ````````````
1.0.0
vpn_password Defines the password of the user for the VPN tunnel. _Text

Default: ````````````
1.0.0
dest_elastic_user_portal The name of the elastic user for accessing data from the portal (if empty string - dest_elastic_key will be used)
- Hint: It is recommended to define a user with very restricted access (only read data) as it will be integrated in the ADIB-portal.
_Text
1.0.0
dest_elastic_key_portal The name of the key (password) of the elastic user for accessing data from the portal (if empty string - dest_elastic_key will be used)
- Hint: It is recommended to define a user with very restricted access (only read data) as it will be integrated in the ADIB-portal.
_Text
1.0.0
excel_meta_encrypted Defines the format of the "meta" registertab in the excel-export.
Clear-text = The structure and fields to be exported (in meta tab on the excel file) are defined in clear-text for the export to be imported.
Encrypted = Structure and fields to be exported (in meta tab on the excel file) is encrypted - to avoid that someone will change it.
_Text
  • Clear-text (Default)

  • Encrypted

Default: 0
1.0.0
list_items_limit Defines the max. number of elements that can be put into a list (i.e. download, share etc) on ADIB-portal.
- Hint: Please take care to not set this number to high - as the portal could freeze otherwise. Should never be higher than 500.
_Text

Default: 100
1.0.0
result_table_buttons_type Defines whether call-to-action buttons on Table and Flexible view should be displayed - or rather the functions shown in a dropdown burger menu on ADIB-portal. _Selection
  • Show buttons (Default)

  • List of functions in a dropdown

1.0.0
import_default_language_only Defines whether for relation-fields (PIM or DAM) the relation should only be created for the defined (default)language or all languages. _Selection
  • Just take defined (default) language (Default)

  • Create relations for each language separately

1.0.0
customer_specific_functions Configuration of customer-specific functions for ADIB-Portal. More details will be found on separate pages of the manual. _ComplexJSON

1.0.0
environment_variables Configuration of environment variables for customer-specific functions for ADIB-Portal. More details can be found on further manual pages. _ComplexJSON

1.0.0
ws_template_type Defines the template type that should be used to generate the webservice body (default is JSON). _Selection
  • JSON (Default)

  • URL

  • Custom

1.0.0
editportal_workflow_clientconfig Defines the clientconfig script for filling the workflow-index based on Contentserv-setup.
- Hint: Here you can put a script that fills the ADIB-portal workflow-index based on an sql-statement.
- Take care: In the current version of the script this only works for CS on-premise.
_Text

Default: 26
1.0.0
elastic_index_workflow Defines the name of the elastic index for workflow.
- Hint:
Make sure to put a name here if you want to have the workflow-logic in ADIB-Portal!
_Text
1.0.0
write_json_containing_asset_info Defines whether a json file (with the same name as the asset - and ".json" as suffix) should be written which contains the defined fields of the asset.
- Explanation: This will help you to gather information about the asset that come from the (Contentser)elastic-index.
_Checkbox

1.0.0
shell_cmd Arbitrary shell command line that should be executed. Give you all flexibility to launch a command. Must be used with caution! _TextArea

1.0.0
null_placeholder Defines the string which identifies that a value should be deleted on ISA import.
- Explanation: As the ADIB-IntegrationClient skips empty values for the import, we must explicitly mark values to be deleted. By the way, this works on subtables as well.
_Text

Default: ##EMPTY##
1.0.0
changes_index_weekly_rotation Defines the number of weeks in which changes are kept before being archived.

Explanation
- Every week a new data-index is created that keeps all the changes. Those data-indices are archived after a certain period of time. Define the number of weeks using this parameter.
_Checkbox

1.0.0
save_selections_as_string Defines whether selection-values are to be stored as array (0/false) or string (1/true) in the index.
- Hint: In case it is stored as string then the value-id is used (and the defined separator for multi-value) - otherwise the label is stored in an array.
_Checkbox

1.0.0
reference_idfield Defines the ID field of references for ADIB Portal. _Text
1.0.0
editportal_creation_wizard Defines the setup elements of a "New product creation wizard".
- Example : Following example to create a new Contentserv object and assign the correct classes to it: [ { "step": "step1", "question": "What product do you want to create", "options": [ { "option_name": "Printer", "option_defaults": { "ClassMapping": "3,2,4", "205": "Lokaler Drucker" } }, { "option_name": "Server", "option_defaults": { "205": "Hochleistungs-Server" } } ] } ]
_Text

Default: []
1.0.0
searchportal_show_template_designer Defines whether template designer should be accessible via ADIB-portal.
- Hint: The template designer allows the user to create PDF and Docx templates that can be used within the portal. This should only be done by an admin.
_Checkbox

1.0.0
ratelimit Defines the limit of how many request per seconds can be sent to the webservice.
- Hint: This is used for pagination. The waiting time (in ms) is calculated by 1000/ratelimit.
_Text

Default: 0
1.0.0
connection_timeout Defines the duration in seconds of how long a connection to the web service will be kept alive until a timeout error occurs.
- Explanation : The default value is 30 seconds. Values below 10 will be defaulted to 30.
_Text

Default: 30
1.0.0
url_filtering Defines the fields to be received (by a GET request) and used to filter the hits of the ADIB-Portal. Based on this paramter you can give your users access to such a subset of products - just by using parameters on the URL-call to the ADIB-portal. _ComplexJSON

4.5.0
skip_empty_values Defines if NULL values should be skipped (not transferred).
- Hint : Disabling this can be useful if data should be deleted in the destination and having spaces instead is not a suitable way.
_Checkbox

1.0.0
simple_list_view Defines whether the list view should be displayed in simple mode.
- Explanation : This removes the product image from the list view - and reduces the information to a minimum.
_Checkbox

4.6.0
pagination_at Defines the position of the pagination panel within ADIB-portal. _Selection
  • Top (Default)

  • Bottom

  • Both

4.6.0
search_bar_separator Defines the character to separate search terms in the search bar. This function allows the user to search for multiple products (i.e. EAN codes) that simply can be copied into the search bar on the portal. _Selection_Free
  • ;

  • , (Default)


id_field Defines the ID field (i.e. for elastic-search) as fallback - if not defined by "isKey" within step_position. _Text

1.0.0
format The format to use, based on the existing meta templates _Text
1.0.0
metaTemplate The metaTemplate to use, instead of giving the format _Text
1.0.0
template The template to use, instead of giving the metaTemplate or the format. It is what would be given by the metaTemplate, or one of the existing meta templates based on the format. _Text
1.0.0
filedirectory The directory to write the files to _Text
1.0.0
filename Defines the name of the xml-file to be read or created. _Text
1.0.0
filename Name of the file if only one file should be created _Text
1.0.0
filenameField Reads the name for each file from the document. Useful for writing multiple files. _Text
1.0.0
charset The charset to use _Text
1.0.0
mode The mode to group documents together. collect -> all documents into one file, size -> groups the dataset into equally sized batches based on the next parameter, field -> groups the dataset according to the expressions of the given field (sort_by_field) _Text
1.0.0
size Max number of products per file _Text
1.0.0
sort_by_field _Text
1.0.0