Page History

When developing a new publisher, follow these steps:

1. Become familiar with the Publisher Framework. 
   • It helps you to understand the concepts. 
   • The projects are here in BitBucket.
2. There is one particular project in the Publisher Framework called aspire-simplefile-publisher. 
   • It publishes all coming documents to the single operating system file. 
   • This project serves only for demonstration purpose. 
   • Become familiar with the project and try to build the artifact.
3. Add aspire-simplefile-publisher to your connector workflow and configure it.
4. Run the full crawl for your connector and check that the file publisher has created the file with crawled documents.
5. Create a new project for your publisher with the same structure as in the aspire-simplefile-publisher.
6. Implement your code. 
   • Make sure you understand the concepts of batching, transformers and other parts of the Publisher Framework.
7. If your target repository supports REST API, always consider using PF component HttpClient for http communication. 
   • The best way how to get familiar with HttpClient is to run JUnit tests in the project aspire-publisher-framework.
8. Create your publisher's configuration files in the resources folder like aspire.properties, dxf/publisher.xml, ... 
   • Make sure you understand the concept of generic properties provided by the Publisher Framework and properties specific to your publisher.
9. Create JUnit tests in your publisher.
10. Build the publisher.
11. Test the publisher by running a full crawl