ProLitteris
We have summarized the most important parts of the ProLitteris integration for the Purple Experience here. Please refer to the latest version of the original ProLitteris integration guide, which you receive as a member from ProLitteris. An older version of the document can be found on this site.
For any content, a ProLitteris pixel is to be added to the source code of the website. After a grace period for the content to undergo editorial changes (usually 14 days), the content and author information are posted to ProLitteris Systems.
To ensure legacy content is properly tracked, please make sure to import the original tracking information to Purple systems. Purple will render the tracking codes, but any content created from legacy systems must be posted to ProLitteris Systems from the legacy system.
Preconditions
- You'll need to set up and gather some data from ProLitteris to implement this.
- Make sure you have enabled "Verlagsinterne Zählmarken"
- ProLitteris Zähldomäne
- ProLitteris Mitgliedsnummer
- In addition to tracking, you will also need to set up services in the Purple Hub to connect authors to the article tracking system.
Construction of the Pixel
The pixel is created by a script, "ptag.min.js", which must be loaded from ProLitteris. The pixel mostly consists of three parts:
<script src="https://ptag.prolitteris.ch/ptag/ptag.min.js"
onload="ptag('https://domain.owen.prolitteris.ch','na','vzm.12345-79c9e1ac-96f1-
11e5-85a6-000c29f1f6c4');"></script>- “https://domain.owen.prolitteris.ch” the tracking domain. A specific one is issued per each customer by ProLitteris.
- “na” the indicator for publicly available contents. Use “pw” for protected contents.
- “vzm.12345-79c9e1ac-96f1-11e5-85a6-000c29f1f6c4”, the properly formatted Zählmarke for the text in question.
- We generally use "Verlagsinterne Zählmarken".
- It's always built from the prefix „vzm.“ , and the ProLitteris Mitgliedsnummer of the publisher, followed by a "-" and the unique id of the content.
Integration in HTML
- Pixel must be integrated in the body
- Respect special requirements when loading full content lazily and indefinitely
- Respect requirements for meta tags on page
ProLitteris Reporting
As soon as tracking is implemented as stated above, you can enable ProLitteris reporting from the Purple Manager. The data is transferred with a minimum delay of two weeks.
ProLitteris reporting is to be configured per Purple Manager Team. Furthermore, the actual public live domains must be marked at the "Experience" page of the app in the Purple Manager to avoid unnecessarily reporting test contents
Reporting is done every night, starting at 11pm and finishing 5 hours later. During that time, error reports are being sent to email addresses configured in the Purple Manager. Errors may contain hints like "Text is too short (min length 1,000 characters)" or "No participants given." The errors can be ignored. But if articles are changed after such an error code is received, we try to report the changed article to ProLitteris again the following night.
Storing Author fields
For an article to be successfully sent, at least one taxonomy of type author must be present. The values of its properties first_name, last_name and prolitterisauthor are sent to VG Wort. The property prolitterisauthor should contain the ProLitteris Mitgliedsnummer of the author and can be omitted if no such value is known. First name and last name are mandatory.
The prolitterisauthor field for authors must be added as a custom field in the Authors plugin. This can be done via Authors -> Author Fields -> New Author Field, which opens up a new dialog. Here the slug needs to be set to prolitterisauthor and then saved.
Afterward, the data must be added for every author in the Hub. This can be done by opening the Authors overview by selecting "Authors" in the Hub menu and then editing the authors by clicking on "Edit" for the author who is supposed to be edited. There, the fields can be set and saved by clicking on "Update".