CMS PostNuke
ContentSwitch
français | english
Navigation
• Home
• Sitemap
This wiki
This page
 ContentSwitch implements pipelines, for transferring contents between different modules. It's only usage (for now) is in EPFLNews (newsletter sending), for sending content that was created in other modules.

General considerations
A pipeline is composed of:
  • one content producer
  • zero or more transformers
  • one consumer

When a pipeline is launched, the module retrieves the content from the producer, and applies each transformer succesively on the retrieved data. Usually the consumer is used to inform the system what the final data will look like.

Pipeline fields and their usage
This information applies to the pipelines used for EPFLNews.

Each pipeline has the following fields:
  • name
    This is a generic name, that will be used for identifying the pipeline, as well as in the "content type selection" (step 3) when sending the newsletter.
  • code
    This code should be an identifier (no spaces or special chars) and it is used, during the newsletter sending, as the folder name where templates for the newsletter should be present (i.e. if the pipeline code is "news", the templates for the newsletter should be in "modules/EPFLNews/templates/lang/mails/news/")
  • producer
    This select field allow the selection of the producer. Each module can define it's own producers
  • transformers
    The transformers can be selected here. The order of the transformers is important. Each module can define it's own transformers.
  • consumer
    You should select EPFLNews:mailing as the consumer, in order for the newsletter sending module to recognize and use this pipeline.

EXAMPLE
The following configuration for a pipeline will make the content in the procontent module (news management) available for use in EPFLNews (sending emails).

Nom du pipeline: Une news (1)
Code du pipeline: procontent (2)
Producteur d'information: procontent/procontent_news (3)
Transformateurs: aucun (4)
Consommateurs: EPFLNews: mailing (5)

Quelques explications:
1 - Ce texte sera affiché dans l'interface EPFLNews
2 - Les templates dans le répertoire modules/EPFLNews/mails/lang/procontent seront utilisées pour la création du texte du mail envoyé.
3 - Le contenu utilisé dans le pipeline est produit par le module procontent
4 - Le contenu produit par la fonction du module procontent est déjà utilisable sous EPFLNews, il n'y a plus besoin de le transformer
5 - Le consommateur est le module EPFLNews. Le module d'envoi d'emails prendra ainsi en compte ce pipeline dans ses sources de données
Search
Share