Skip to content
Snippets Groups Projects
Commit 55a86a6d authored by Johannes Goderbauer's avatar Johannes Goderbauer
Browse files

Address_lib: added small documentation with FAQ-section.

parent 0f0a1719
No related branches found
No related tags found
No related merge requests found
......@@ -2,6 +2,7 @@
<process xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.2.1" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/process/1.2.1">
<name>Address_lib</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
<documentation>%aditoprj%/process/Address_lib/documentation.adoc</documentation>
<process>%aditoprj%/process/Address_lib/process.js</process>
<variants>
<element>LIBRARY</element>
......
= Address_lib
This is a library for working with big amounts of the combination of the following data:
* addresses
* person-contacts
* organisation-contacts
as well as related data like the standard communication data.
This is mainly done via the `AddressObject` which uses database access for loading the data and
placeholder-definitions for preparing and formatting the data.
== FAQ
[qanda]
How to get the correct formatted standard address for a single contact, depending on the country?::
This can be easily done via the following code-snippet where the variable `contactId` is
the `CONTACT.CONTACTID` of the address where you want to load the data:
new AddressObject(contactId).getFormattedAddress();
How to get the correct formatted standard address for several contacts, depending on their country?::
This can be easily done via the following code-snippet where the variable `contactIds` is
an array of `CONTACT.CONTACTID` where you want to load the address data from and `config` the
placeholder configuration:
getAddressesData([contactIds], config);
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment