Available for: Template Engine from version 6.7.2
Task: Custom procedure for processing the import journal. In the course of processing the journal, other actions, such as tagging CMS files for export, can be taken (see the
obj touch command).
Additional information: see Import and Export.
importJournal: The path of the import journal file. The function must not modify the file.
Return value if successful: none
The import journal is created during the import phase. It is a record of all actions relevant to CMS files. Each line in the file represents one journal entry. All lines have the following form:
Code is a single character that specifies the kind of change made to a CMS file.
FilePath is the CMS path of the file concerned. Lines that start with a hash mark (
#) are comments.
The following changes are recorded in the import journal and are tagged with the codes specified:
c: The file with the specified path was created.
u: A file field (such as
suppressExport) has been modified. This type is not recorded if the name of the file or of its parent file is changed. For these actions, the types
M are recorded.
r: The file was deleted.
m: The file was moved (its path changed). The specified path is the previous path of the file. This entry type is always followed by an
M: The file was moved (its path changed). The specified path is the new path of the file. This entry type is always preceded by an
U: The contents of the file has changed (the file was released).
R: The contents of the file has been deleted (the file was unreleased).
The import journal is emptied after the
importCB phase has been finished successfully. If the import callback returns an error all journal entries are preserved. New entries will be appended to the journal.
Example of an import journal:
# This file is generated automatically. # Only the TE is allowed to modify it. u / c /internet c /internet/playland c /internet/playland/de c /internet/playland/de/wirueberuns c /internet/playland/de/wirueberuns/faq c /internet/playland/de/wirueberuns/faq/probiermodus c /internet/playland/de/wirueberuns/faq/schadstofffreiheit c /internet/playland/de/wirueberuns/faq/bestellung c /internet/playland/de/wirueberuns/faq/verfuegbarkeit U / U /internet U /internet/playland U /internet/playland/de U /internet/playland/de/wirueberuns U /internet/playland/de/wirueberuns/faq U /internet/playland/de/wirueberuns/faq/probiermodus U /internet/playland/de/wirueberuns/faq/schadstofffreiheit U /internet/playland/de/wirueberuns/faq/bestellung U /internet/playland/de/wirueberuns/faq/verfuegbarkeit