Hi All, According to the discussion we had during last week, I have implemented the recipe executor as a carbon component. Currently it will use the Task interface and once we integrate the Task Server with the ESB, we will use that for the implementation. Now we have a CAR file which contains the recipe.
Recipe CAR ----------------------- 1. Recipe template (ESB template) as a registry artifact 2. Data mapping (xslt transformation) as a local entry 3. Task description with required parameters (Dish) Note: There will not be any new synapse artifact. Once you deploy the CAR file, it will execute periodically as a scheduled task. Given below are the sample artifacts contains in the CAR file. template ------------------ <template name="TestRecipe" xmlns="http://ws.apache.org/ns/synapse";> <parameter name="googlespreadsheet.username"/> <parameter name="googlespreadsheet.password"/> <parameter name="googlespreadsheet.spreadsheetName"/> <parameter name="googlespreadsheet.worksheetName"/> <parameter name="googlespreadsheet.batchEnable"/> <parameter name="googlespreadsheet.batchSize"/> <parameter name="salesforce.username"/> <parameter name="salesforce.password"/> <parameter name="salesforce.batchSize"/> <sequence> <salesforce.init> <username>{get-property('func','salesforce.username')}</username> <password>{get-property('func','salesforce.password')}</password> <loginUrl>https://login.salesforce.com/services/Soap/u/27.0 </loginUrl> </salesforce.init> <salesforce.query> <batchSize>{get-property('func','salesforce.batchSize')}</batchSize> <queryString>select id,name from Account</queryString> </salesforce.query> <xslt key="csvConverter2.xslt"/> <googlespreadsheet.usernameLogin> <username>{get-property('func','googlespreadsheet.username')}</username> <password>{get-property('func','googlespreadsheet.password')}</password> </googlespreadsheet.usernameLogin> <googlespreadsheet.importCSV> <spreadsheetName>{get-property('func','googlespreadsheet.spreadsheetName')}</spreadsheetName> <worksheetName>{get-property('func','googlespreadsheet.worksheetName')}</worksheetName> <batchEnable>{get-property('func','googlespreadsheet.batchEnable')}</batchEnable> <batchSize>{get-property('func','googlespreadsheet.batchSize')}</batchSize> </googlespreadsheet.importCSV> </sequence> </template> Data mapping transformation ----------------------------------------------- <?xml version="1.0" encoding="UTF-8"?> <localEntry xmlns="http://ws.apache.org/ns/synapse"; key="csvConverter2.xslt"> <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; xmlns:sfdc="urn:partner.soap.sforce.com" xmlns:sf="urn: sobject.partner.soap.sforce.com" version="1.0"> <xsl:output method="text" indent="no" encoding="UTF-8"/> <xsl:template match="/"> Id,Name <xsl:for-each select="//sfdc:records"> <xsl:value-of select="sf:Id"/> <xsl:text>,</xsl:text> <xsl:value-of select="sf:Name"/> <xsl:text>, </xsl:text> </xsl:for-each> </xsl:template> </xsl:stylesheet> </localEntry> Task description (Dish) ----------------------------------------------- <?xml version="1.0" encoding="UTF-8"?> <task xmlns="http://ws.apache.org/ns/synapse"; name="CarbonTask" class="org.wso2.carbon.recipeexecutor.RecipeMessageExecutor" group="synapse.simple.quartz"> <trigger count="1" interval="100"/> <property xmlns:task="http://www.wso2.org/products/wso2commons/tasks"; name="recipeParams"> <salesforceGooglespreadsheet.syncContacts xmlns=""> <salesforce.username>xxxxxxxx</salesforce.username> <salesforce.password>xxxxxx</salesforce.password> <salesforce.batchSize>200</salesforce.batchSize> <googlespreadsheet.username>xxxx</googlespreadsheet.username> <googlespreadsheet.password>xxxxx</googlespreadsheet.password> <googlespreadsheet.spreadsheetName>RecipeDemo</googlespreadsheet.spreadsheetName> <googlespreadsheet.worksheetName>Recipe1</googlespreadsheet.worksheetName> <googlespreadsheet.batchEnable>true</googlespreadsheet.batchEnable> <googlespreadsheet.batchSize>10</googlespreadsheet.batchSize> </salesforceGooglespreadsheet.syncContacts> </property> <property xmlns:task="http://www.wso2.org/products/wso2commons/tasks"; name="regKey" value="gov:/recipes/TestRecipe.xml"/> </task> Thanks, Chanaka On Tue, Mar 4, 2014 at 11:10 AM, Kasun Indrasiri <ka...@wso2.com> wrote: > AFAIU, these are main steps of the recipe use case : > - Recipes will be stored in a recipe store. > - User can download and install the required recipes in to Dev Studio ( > same as connectors) > - Once a user import a recipe in to DevS, he can start creating recipe > executors/triggers. We can populate a graphical representation (with icons > and all) in the developer studio. > - Then the recipe executor can be deployed in to an ESB (as a .car). > > > On Tue, Mar 4, 2014 at 10:58 AM, Afkham Azeez <az...@wso2.com> wrote: > >> What would user experience be like? Surely, users will not be editing XML >> files, I presume. >> >> Azeez >> >> >> On Tue, Mar 4, 2014 at 10:55 AM, Kasun Indrasiri <ka...@wso2.com> wrote: >> >>> Hi all, >>> >>> We had a detailed discussion on the architecture and the design of the >>> new 'Recipe' concepts for ESB. This is a summary of what we have discussed. >>> >>> *Recipe* : The concept behind Recipe is about providing high level >>> abstraction for connectors interactions. The well known and commonly used >>> integration scenarios between any publicly available services/cloud apis >>> such as Salesforce->Google Spreadsheet will be provide as recipes. >>> >>> The deliverable of a Recipe is a Recipe archive (residing in a Recipe >>> store) which comprises of some descriptor files and available recipes as >>> templates. >>> >>> For instance, the recipe for integrating Salesforce->Google Spread Sheet >>> will have the following structure. There can be multiple operations >>> associated with that recipe such as syncContacts, syncLeads etc. >>> >>> Recipe Archive (SalesforceToGoogleSpreadSheet.zip) >>> >>> - recipe.xml (contains recipe name, available operations etc) >>> >>> - components >>> >>> - component.xml >>> >>> - syncContacts.xml [Templates] >>> >>> - syncLeads.xml [Templates] >>> >>> ... >>> >>> - repository >>> >>> - salesforce-connector-1.0.0.zip >>> >>> - googlespreadsheet-connector-1.0.0.zip >>> >>> - icon >>> >>> eg: *syncContacts.xml* will have the following structure. All the >>> required parameters are externalized so that the Recipe invocation can pass >>> them dynamically. >>> >>> >>> <salesforce.init> >>> >>> <username>{sfdc:username}</username> >>> >>> <password>{sfdc:password}</password> >>> >>> </salesforce.init> >>> >>> <salesforce.query>... >>> >>> <datamapper/> | <xslt/> | <payloadfactory/>... >>> >>> <googlespreadsheet.init> >>> >>> <oauth2Credentials>{googlespreadsheet:oauth_key}</oauth2Credentials> >>> >>> </googlespreadsheet.init> >>> >>> <googlespreadsheet.importCSV> >>> >>> <spreadsheetName>{googlespreadsheet:spreadsheetName}</spreadsheetName> >>> >>> <worksheetName>{googlespreadsheet:worksheetName}</worksheetName> >>> >>> </googlespreadsheet.importCSV> >>> >>> >>> >>> Recipe Executor >>> >>> A given Recipe can be executed with the use of a recipe executor(might >>> need better naming). This is a deployable archive which is similar to a >>> sequence, proxy service or rest api. The recipe executor can be triggered >>> from an external agent such as Task Server. (When we deploy a Recipe >>> executor, it will create a task in the task server. >>> >>> Recipe executor is the artifact where a given user will get directly >>> interact with. For instance when a user wants to periodically sync his >>> Salesforce contacts with a Google Spread Sheet, he should be able to create >>> the following recipe executor from the developer studio and deploy that in >>> to ESB. >>> >>> <recipe name="SalesforceToGoogleSpreadSheet" operation="syncContacts"> >>> >>> <interval>10</interval> | <cron>0 0 12 * * ?</cron> >>> >>> <sfdc:username>user123</sfdc:username> >>> >>> <sfdc:password>vault-lookup('kasun_sfdc')</sfdc:password> >>> >>> <googlespreadsheet:oauth_key>DF9d99dFD</googlespreadsheet:oauth_key> >>> >>> >>> >>> <googlespreadsheet:spreadsheetName>SFDC</googlespreadsheet:spreadsheetName> >>> >>> >>> >>> <googlespreadsheet:worksheetName>My_Contacts</googlespreadsheet:worksheetName> >>> >>> </recipe> >>> >>> As we did with the connectors, we will concentrate on end to end story >>> for recipes (ie: implementation, deployment, storing and tooling aspects). >>> >>> We are planning to do a poc around the above mentioned design and then >>> we can do a review. >>> >>> Please correct me if I miss any thing related to this topic and please >>> share your thoughts on this too. >>> >>> -- >>> Kasun Indrasiri >>> Software Architect >>> WSO2, Inc.; http://wso2.com >>> lean.enterprise.middleware >>> >>> cell: +94 77 556 5206 >>> Blog : http://kasunpanorama.blogspot.com/ >>> >> >> >> >> -- >> *Afkham Azeez* >> Director of Architecture; WSO2, Inc.; http://wso2.com >> Member; Apache Software Foundation; http://www.apache.org/ >> * <http://www.apache.org/>* >> *email: **az...@wso2.com* <az...@wso2.com> >> * cell: +94 77 3320919 <%2B94%2077%203320919> blog: * >> *http://blog.afkham.org* <http://blog.afkham.org> >> *twitter: **http://twitter.com/afkham_azeez*<http://twitter.com/afkham_azeez> >> * linked-in: **http://lk.linkedin.com/in/afkhamazeez >> <http://lk.linkedin.com/in/afkhamazeez>* >> >> *Lean . Enterprise . Middleware* >> > > > > -- > Kasun Indrasiri > Software Architect > WSO2, Inc.; http://wso2.com > lean.enterprise.middleware > > cell: +94 77 556 5206 > Blog : http://kasunpanorama.blogspot.com/ > -- -- Chanaka Fernando Technical Lead WSO2, Inc.; http://wso2.com lean.enterprise.middleware mobile: +94 773337238 Blog : http://soatutorials.blogspot.com LinkedIn:http://www.linkedin.com/pub/chanaka-fernando/19/a20/5b0 Twitter:https://twitter.com/chanakaudaya Wordpress:http://chanakaudaya.wordpress.com
_______________________________________________ Architecture mailing list Architecture@wso2.org https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
