| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <meta name="keywords" content="SMILA/Documentation/JobFile Agent,SMILA/Documentation/Agent,SMILA/Documentation/Feed Agent,SMILA/Documentation/Mock Agent" /> |
| <link rel="shortcut icon" href="http://wiki.eclipse.org/SMILA/Documentation/favicon.ico" /> |
| <link rel="search" type="application/opensearchdescription+xml" href="http://wiki.eclipse.org/opensearch_desc.php" title="Eclipsepedia (English)" /> |
| <link rel="alternate" type="application/rss+xml" title="Eclipsepedia RSS Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&feed=rss" /> |
| <link rel="alternate" type="application/atom+xml" title="Eclipsepedia Atom Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&feed=atom" /> |
| |
| |
| <title>SMILA/Documentation/JobFile Agent - Eclipsepedia</title> |
| |
| <style type="text/css" media="screen,projection">/*<![CDATA[*/ @import "/skins/eclipsenova/novaWide.css?116"; /*]]>*/</style> |
| <link rel="stylesheet" type="text/css" media="print" href="http://wiki.eclipse.org/skins/eclipsenova/eclipsenovaPrint.css?116" /> |
| <link rel="stylesheet" type="text/css" media="handheld" href="http://wiki.eclipse.org/skins/eclipsenova/handheld.css?116" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/header.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/tabs.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/visual.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/layout.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/footer.css" media="screen" /> |
| <!--[if IE]><link rel="stylesheet" type="text/css" href="/skins/eclipsenova/IEpngfix.css" media="screen" /><![endif]--> |
| <!--[if lt IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE50Fixes.css?116";</style> <![endif]--> |
| <!--[if IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE55Fixes.css?116";</style><![endif]--> |
| <!--[if IE 6]><style type="text/css">@import "/skins/eclipsenova/IE60Fixes.css?116";</style><![endif]--> |
| <!--[if IE 7]><style type="text/css">@import "/skins/eclipsenova/IE70Fixes.css?116";</style><![endif]--> |
| <!--[if lt IE 7]><script type="text/javascript" src="/skins/common/IEFixes.js?116"></script> |
| <meta http-equiv="imagetoolbar" content="no" /><![endif]--> |
| <script type= "text/javascript">/*<![CDATA[*/ |
| var skin = "eclipsenova"; |
| var stylepath = "/skins"; |
| var wgArticlePath = "/$1"; |
| var wgScriptPath = ""; |
| var wgScript = "/index.php"; |
| var wgServer = "http://wiki.eclipse.org"; |
| var wgCanonicalNamespace = ""; |
| var wgCanonicalSpecialPageName = false; |
| var wgNamespaceNumber = 0; |
| var wgPageName = "SMILA/Documentation/JobFile_Agent"; |
| var wgTitle = "SMILA/Documentation/JobFile Agent"; |
| var wgAction = "view"; |
| var wgRestrictionEdit = []; |
| var wgRestrictionMove = []; |
| var wgArticleId = "20702"; |
| var wgIsArticle = true; |
| var wgUserName = null; |
| var wgUserGroups = null; |
| var wgUserLanguage = "en"; |
| var wgContentLanguage = "en"; |
| var wgBreakFrames = false; |
| var wgCurRevisionId = "285991"; |
| var wgVersion = "1.12.0"; |
| var wgEnableAPI = true; |
| var wgEnableWriteAPI = false; |
| /*]]>*/</script> |
| |
| <script type="text/javascript" src="http://wiki.eclipse.org/skins/common/wikibits.js?116"><!-- wikibits js --></script> |
| |
| <!-- Performance mods similar to those for bug 166401 --> |
| <script type="text/javascript" src="http://wiki.eclipse.org/index.php?title=-&action=raw&gen=js&useskin=eclipsenova"><!-- site js --></script> |
| |
| <!-- Head Scripts --> |
| <script type="text/javascript" src="http://wiki.eclipse.org/skins/common/ajax.js?116"></script> |
| <style type="text/css">/*<![CDATA[*/ |
| .source-xml {line-height: normal; font-size: medium;} |
| .source-xml li {line-height: normal;} |
| /** |
| * GeSHi Dynamically Generated Stylesheet |
| * -------------------------------------- |
| * Dynamically generated stylesheet for xml |
| * CSS class: source-xml, CSS id: |
| * GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter) |
| */ |
| .source-xml .de1, .source-xml .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;} |
| .source-xml {} |
| .source-xml .head {} |
| .source-xml .foot {} |
| .source-xml .imp {font-weight: bold; color: red;} |
| .source-xml .ln-xtra {color: #cc0; background-color: #ffc;} |
| .source-xml li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;} |
| .source-xml li.li2 {font-weight: bold;} |
| .source-xml .coMULTI {color: #808080; font-style: italic;} |
| .source-xml .es0 {color: #000099; font-weight: bold;} |
| .source-xml .br0 {color: #66cc66;} |
| .source-xml .st0 {color: #ff0000;} |
| .source-xml .nu0 {color: #cc66cc;} |
| .source-xml .sc0 {color: #00bbdd;} |
| .source-xml .sc1 {color: #ddbb00;} |
| .source-xml .sc2 {color: #339933;} |
| .source-xml .sc3 {color: #009900;} |
| .source-xml .re0 {color: #000066;} |
| .source-xml .re1 {font-weight: bold; color: black;} |
| .source-xml .re2 {font-weight: bold; color: black;} |
| |
| /*]]>*/ |
| </style> |
| <style type="text/css">/*<![CDATA[*/ |
| @import "/index.php?title=MediaWiki:Geshi.css&usemsgcache=yes&action=raw&ctype=text/css&smaxage=18000"; |
| /*]]>*/ |
| </style><link rel="stylesheet" type="text/css" href="JobFile_Agent.html" /> </head> |
| <body class="mediawiki ns-0 ltr page-SMILA_Documentation_JobFile_Agent"> |
| <div id="globalWrapper"> |
| |
| |
| <div id="column-one"> |
| <!-- Eclipse Additions for the Top Nav start here M. Ward--> |
| |
| <div id="header"> |
| <div id="header-graphic"> |
| <img src="http://wiki.eclipse.org/skins/eclipsenova/eclipse.png" alt="Eclipse Wiki"> |
| </div> |
| <!-- Pulled 101409 Mward --> |
| |
| <div class="portlet" id="p-personal"> |
| <div class="pBody"> |
| <ul> |
| <li id="pt-login"><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&returnto=SMILA/Documentation/JobFile_Agent">Log in</a></li> |
| </ul> |
| </div> |
| </div> |
| |
| <div id="header-icons"> |
| <div id="sites"> |
| <ul id="sitesUL"> |
| <li><a href="http://www.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/eclipseIcon.png" width="28" height="28" alt="Eclipse Foundation" title="Eclipse Foundation" /><div>Eclipse Foundation</div></a></li> |
| <li><a href="http://marketplace.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/marketplace.png" width="28" height="28" alt="Eclipse Marketplace" title="Eclipse Marketplace" /><div>Eclipse Marketplace</div></a></li> |
| <li><a href="https://bugs.eclipse.org/bugs"><img src="http://dev.eclipse.org/custom_icons/system-search-bw.png" width="28" height="28" alt="Bugzilla" title="Bugzilla" /><div>Bugzilla</div></a></li> |
| <li><a href="http://live.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/audio-input-microphone-bw.png" width="28" height="28" alt="Live" title="Live" /><div>Eclipse Live</div></a></li> |
| <li><a href="http://planeteclipse.org"><img src="http://dev.eclipse.org/large_icons/devices/audio-card.png" width="28" height="28" alt="PlanetEclipse" title="Planet" /><div>Planet Eclipse</div></a></li> |
| <li><a href="http://portal.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/preferences-system-network-proxy-bw.png" width="28" height="28" alt="Portal" title="Portal" /><div>My Foundation Portal</div></a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <!-- NEW HEADER STUFF HERE --> |
| <div id="header-menu"> |
| <div id="header-nav"> |
| <ul> <li><a class="first_one" href="http://wiki.eclipse.org/" target="_self">Home</a></li> <li><a href="http://www.eclipse.org/downloads/" target="_self">Downloads</a></li> |
| <li><a href="http://www.eclipse.org/users/" target="_self">Users</a></li> |
| <li><a href="http://www.eclipse.org/membership/" target="_self">Members</a></li> |
| <li><a href="http://wiki.eclipse.org/index.php/Development_Resources" target="_self">Committers</a></li> |
| <li><a href="http://www.eclipse.org/resources/" target="_self">Resources</a></li> |
| <li><a href="http://www.eclipse.org/projects/" target="_self">Projects</a></li> |
| <li><a href="http://www.eclipse.org/org/" target="_self">About Us</a></li> |
| </ul> |
| </div> |
| <div id="header-utils"> |
| <!-- moved the search window here --> |
| <form action="http://wiki.eclipse.org/Special:Search" > |
| <input class="input" name="search" type="text" accesskey="f" value="" /> |
| <input type='submit' onclick="this.submit();" name="go" id="searchGoButton" class="button" title="Go to a page with this exact name if one exists" value="Go" /> |
| <input type='submit' onclick="this.submit();" name="fulltext" class="button" id="mw-searchButton" title="Search Eclipsepedia for this text" value="Search" /> |
| </form> |
| </div> |
| </div> |
| |
| |
| <!-- Eclipse Additions for the Header stop here --> |
| <!-- Additions and mods for leftside nav Start here --> |
| |
| <!--Started nav rip here--> |
| <!-- these are the nav controls main page, changes etc --> |
| <div id="novaContent" class="faux"> |
| <div id="leftcol"> |
| <ul id="leftnav"> |
| <!-- these are the page controls, edit history etc --> |
| <li class="separator"><a class="separator">Navigation   </li> |
| <li id="n-mainpage"><a href="http://wiki.eclipse.org/Main_Page">Main Page</a></li> |
| <li id="n-portal"><a href="http://wiki.eclipse.org/Eclipsepedia:Community_Portal">Community portal</a></li> |
| <li id="n-currentevents"><a href="http://wiki.eclipse.org/Eclipsepedia:Current_events">Current events</a></li> |
| <li id="n-recentchanges"><a href="http://wiki.eclipse.org/Special:Recentchanges">Recent changes</a></li> |
| <li id="n-randompage"><a href="http://wiki.eclipse.org/Special:Random">Random page</a></li> |
| <li id="n-help"><a href="http://wiki.eclipse.org/Help:Contents">Help</a></li> |
| <li class="separator"><a class="separator">Toolbox   </a></li> |
| |
| <li id="t-whatlinkshere"><a href="http://wiki.eclipse.org/Special:Whatlinkshere/SMILA/Documentation/JobFile_Agent">What links here</a></li> |
| <li id="t-recentchangeslinked"><a href="http://wiki.eclipse.org/Special:Recentchangeslinked/SMILA/Documentation/JobFile_Agent">Related changes</a></li> |
| <!-- This is the toolbox section --> |
| <li id="t-upload"><a href="http://wiki.eclipse.org/Special:Upload">Upload file</a></li> |
| <li id="t-specialpages"><a href="http://wiki.eclipse.org/Special:Specialpages">Special pages</a></li> |
| <li id="t-print"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/JobFile_Agent&printable=yes">Printable version</a></li> <li id="t-permalink"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/JobFile_Agent&oldid=285991">Permanent link</a></li> </ul> |
| </div> |
| |
| |
| <!-- Additions and mods for leftside nav End here --> |
| |
| |
| <div id="column-content"> |
| <div id="content"> |
| <a name="top" id="top"></a> |
| |
| <div id="tabs"> |
| <ul class="primary"> |
| <li class="active"><a href="JobFile_Agent.html"><span class="tab">Page</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=Talk:SMILA/Documentation/JobFile_Agent&action=edit"><span class="tab">Discussion</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/JobFile_Agent&action=edit"><span class="tab">View source</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/JobFile_Agent&action=history"><span class="tab">History</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&returnto=SMILA/Documentation/JobFile%20Agent"><span class="tab">Edit</span></a></li> |
| </ul> |
| </div> |
| |
| |
| <script type="text/javascript"> if (window.isMSIE55) fixalpha(); </script> |
| <h1 class="firstHeading">SMILA/Documentation/JobFile Agent</h1> |
| <div id="bodyContent"> |
| <h3 id="siteSub">From Eclipsepedia</h3> |
| <div id="contentSub"><span class="subpages">< <a href="../../SMILA.html" title="SMILA">SMILA</a> | <a href="../Documentation.1.html" title="SMILA/Documentation">Documentation</a></span></div> |
| <div id="jump-to-nav">Jump to: <a href="JobFile_Agent.html#column-one">navigation</a>, <a href="JobFile_Agent.html#searchInput">search</a></div> <!-- start content --> |
| <div class="messagebox" style="background-color: #def3fe; border: 1px solid #c5d7e0; color: black; padding: 5px; margin: 1ex 0; min-height: 35px; padding-left: 45px;"> |
| <div style="float: left; margin-left: -40px;"><a href="http://wiki.eclipse.org/Image:Note.png" class="image" title="Note.png"><img alt="" src="http://wiki.eclipse.org/images/c/cc/Note.png" width="35" height="35" border="0" /></a></div> |
| <div><b>This is deprecated for SMILA 1.0, the connectivity framework is still functional but planned to be replaced by scalable import based on SMILAs job management.</b><br /></div> |
| </div> |
| <table id="toc" class="toc" summary="Contents"><tr><td><div id="toctitle"><h2>Contents</h2></div> |
| <ul> |
| <li class="toclevel-1"><a href="JobFile_Agent.html#Overview"><span class="tocnumber">1</span> <span class="toctext">Overview</span></a></li> |
| <li class="toclevel-1"><a href="JobFile_Agent.html#Agent_configuration"><span class="tocnumber">2</span> <span class="toctext">Agent configuration</span></a></li> |
| <li class="toclevel-1"><a href="JobFile_Agent.html#Agent_configuration_explanation"><span class="tocnumber">3</span> <span class="toctext">Agent configuration explanation</span></a></li> |
| <li class="toclevel-1"><a href="JobFile_Agent.html#Configuration_example"><span class="tocnumber">4</span> <span class="toctext">Configuration example</span></a></li> |
| <li class="toclevel-1"><a href="JobFile_Agent.html#The_format_of_job_files"><span class="tocnumber">5</span> <span class="toctext">The format of job files</span></a></li> |
| <li class="toclevel-1"><a href="JobFile_Agent.html#Example_of_a_job_file"><span class="tocnumber">6</span> <span class="toctext">Example of a job file</span></a></li> |
| <li class="toclevel-1"><a href="JobFile_Agent.html#See_also"><span class="tocnumber">7</span> <span class="toctext">See also</span></a></li> |
| </ul> |
| </td></tr></table><script type="text/javascript"> if (window.showTocToggle) { var tocShowText = "show"; var tocHideText = "hide"; showTocToggle(); } </script> |
| <a name="Overview"></a><h2> <span class="mw-headline"> Overview </span></h2> |
| <p>The Job File agent offers the functionality to execute <i>ADD</i> and <i>DELETE</i> jobs. A job file is an XML file using the SMILA datamodel XML representation of <tt>Records</tt> and <tt>Ids</tt> to describe the data and special <tt>ADD</tt> and <tt>DELETE</tt> tags to specify the action to take. |
| </p> |
| <a name="Agent_configuration"></a><h2> <span class="mw-headline"> Agent configuration </span></h2> |
| <p>The example configuration file is located at <tt>configuration/org.eclipse.smila.connectivity.framework/jobfile.xml</tt>. |
| </p><p>Defining Schema: <tt>org.eclipse.smila.connectivits.framework.agent.jobfile/schemas/JobFileDataSourceConnectionConfigSchema.xsd</tt>. |
| </p> |
| <a name="Agent_configuration_explanation"></a><h2> <span class="mw-headline"> Agent configuration explanation </span></h2> |
| <p>See <a href="Agent.html#Configuration" title="SMILA/Documentation/Agent">SMILA/Documentation/Agent#Configuration</a> for the generic parts of the configuration file. |
| </p><p>The root element of the configuration is <tt>DataSourceConnectionConfig</tt> and contains the following sub elements: |
| </p> |
| <ul><li> <tt>DataSourceID</tt> – the identification of a data source |
| </li><li> <tt>SchemaID</tt> – specifies the schema for the data source |
| </li><li> <tt>DataConnectionID</tt> – describes which agent or crawler should be used |
| <ul><li> <tt>Crawler</tt> – service ID of a crawler |
| </li><li> <tt>Agent</tt> – service ID of an agent |
| </li></ul> |
| </li><li> <tt>CompoundHandling</tt> – specify if packed data (like a ZIP containing files) should be unpack and files within should be processed (YES or NO). |
| </li><li> <tt>Attributes</tt> – list all attributes provided by the data source |
| <ul><li> <tt>Attribute</tt> |
| <ul><li> <tt>Type</tt> (required) – the data type (String, Integer or Date). |
| </li><li> <tt>Name</tt> (required) – attributes name. |
| </li><li> <tt>HashAttribute</tt> – specify if a hash should be created (true or false). |
| </li><li> <tt>KeyAttribute</tt> – creates a key for this object, for example for record id (true or false). |
| </li><li> <tt>Attachment</tt> – specify if the attribute return the data as attachment of record. |
| </li></ul> |
| </li></ul> |
| </li><li> <tt>Process</tt> – contains parameters for the agent business logic. |
| <ul><li> <tt>UpdateInterval</tt> – the number of seconds to wait before reloading the job files specified by JobFileUrl. |
| </li><li> <tt>JobFileUrl</tt> – the URL of the job file to load. Protocols <tt>file://</tt> and <tt>http://</tt> are supported. You may specify multiple URLs. |
| </li><li><tt>AttachmentSeparator</tt> - the separator used to separate attachment names and attachment URLs |
| </li></ul> |
| </li></ul> |
| <p><br /> |
| The Job File agent offers no attributes by itself, rather it just creates the attributes that are part of each record in the job file. However, you have to specify the names of those attributes that should be used for hash creation (the hash is not part of the record) and optionally for id creation (it is also possible to already provide an Id in the job file for each record.. |
| </p> |
| <a name="Configuration_example"></a><h2> <span class="mw-headline"> Configuration example </span></h2> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><DataSourceConnectionConfig</span> |
| <span class="re0">xmlns:xsi</span>=<span class="st0">"http://www.w3.org/2001/XMLSchema-instance"</span> |
| <span class="re0">xsi:noNamespaceSchemaLocation</span>=<span class="st0">"../org.eclipse.smila.connectivity.framework.agent.jobfile/schemas/FeedDataSourceConnectionConfigSchema.xsd"</span> |
| <span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><DataSourceID<span class="re2">></span></span></span>jobfile<span class="sc3"><span class="re1"></DataSourceID<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SchemaID<span class="re2">></span></span></span>org.eclipse.smila.connectivity.framework.agent.jobfile<span class="sc3"><span class="re1"></SchemaID<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><DataConnectionID<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Agent<span class="re2">></span></span></span>JobFileAgent<span class="sc3"><span class="re1"></Agent<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></DataConnectionID<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><DeltaIndexing<span class="re2">></span></span></span>full<span class="sc3"><span class="re1"></DeltaIndexing<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attributes<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Type</span>=<span class="st0">"Date"</span> <span class="re0">Name</span>=<span class="st0">"LastModifiedDate"</span> <span class="re0">HashAttribute</span>=<span class="st0">"true"</span> <span class="re2">/></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Type</span>=<span class="st0">"String"</span> <span class="re0">Name</span>=<span class="st0">"Path"</span> <span class="re0">KeyAttribute</span>=<span class="st0">"true"</span> <span class="re2">/></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Type</span>=<span class="st0">"String"</span> <span class="re0">Name</span>=<span class="st0">"Url"</span> <span class="re0">KeyAttribute</span>=<span class="st0">"true"</span> <span class="re2">/></span></span> |
| <span class="sc3"><span class="re1"></Attributes<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Process<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><UpdateInterval<span class="re2">></span></span></span>300<span class="sc3"><span class="re1"></UpdateInterval<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><AttachmentSeparator<span class="re2">></span></span></span>####<span class="sc3"><span class="re1"></AttachmentSeparator<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><JobFileUrl<span class="re2">></span></span></span>file://samplejobfile.xml<span class="sc3"><span class="re1"></JobFileUrl<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Process<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></DataSourceConnectionConfig<span class="re2">></span></span></span></pre></div> |
| <a name="The_format_of_job_files"></a><h2> <span class="mw-headline"> The format of job files </span></h2> |
| <p>A example configuration file called "samplejobfile.xml" is located at <tt>configuration/org.eclipse.smila.connectivity.framework</tt>. |
| </p><p>Defining Schema: <tt>org.eclipse.smila.connectivits.framework.agent.jobfile/schemas/jobfile.xsd</tt>. |
| </p><p>In a job file you can have either a <tt>ADD</tt> section, or a <tt>DELETE</tt> section or both. A <tt>ADD</tt> section can contain one or more <tt>Record</tt> sections. A <tt>Record</tt> section need not contain an <tt>Id</tt>. If no <tt>Id</tt> is contained, an Id object is created according to the Job File agent configuration. A <tt>DELETE</tt> section can contain one or more <tt>Id</tt> sections. In all respects the content of <tt>ADD</tt> and <tt>DELETE</tt> sections adhere to the datamodel XML schemes <tt>org.eclipse.smila.datamodel/xml/id.xsd</tt>. and <tt>org.eclipse.smila.datamodel/xml/record.xsd</tt>. |
| </p><p>Attachments are handled slightly different: |
| Normally the XML datamodel contains only the name of an attachment. But during an import we want to fill an attachment with a value. Therefore it is necessary to not only include the attachment name in the XML but also an URL where the actual attachment value is located. Both information are separated by the <tt>AttachmentSeparator</tt> configured in the Job File agent configuration. |
| </p><p>For example the attachment named <tt>Content</tt> should be filled with the document referenced by <tt><a href="http://www.eclipse.org" class="external free" title="http://www.eclipse.org" rel="nofollow">http://www.eclipse.org</a></tt>. As AttachmentSeparator the string <tt>####</tt> is used. Then the XML looks like this: |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml">... |
| <span class="sc3"><span class="re1"><Attachment<span class="re2">></span></span></span>Content####epl-v10.html<span class="sc3"><span class="re1"></Attachment<span class="re2">></span></span></span> |
| ...</pre></div> |
| <p><b>Note</b>: If you set the "_source" attribute for records in the job file, the value must match the <tt>DataSourceID</tt> in the Job File agent configuration! Otherwise the record is skipped. |
| </p> |
| <a name="Example_of_a_job_file"></a><h2> <span class="mw-headline"> Example of a job file </span></h2> |
| <p>Here is an example for a job file with both a <tt>ADD</tt> and <tt>DELETE</tt> section. It shows the different options of |
| </p> |
| <ul><li> creating Id objects from attribute values |
| </li><li> providing Ids within the XML |
| </li><li> loading data into attachments |
| </li><li> providing text or markup data in attributes |
| </li></ul> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><?xml</span> <span class="re0">version</span>=<span class="st0">"1.0"</span> <span class="re0">encoding</span>=<span class="st0">"UTF-8"</span><span class="re2">?></span></span> |
| <span class="sc3"><span class="re1"><JobFile</span> <span class="re0">xmlns:xsi</span>=<span class="st0">"http://www.w3.org/2001/XMLSchema-instance"</span> |
| <span class="re0">xsi:noNamespaceSchemaLocation</span>=<span class="st0">"../org.eclipse.smila.connectivity.framework.agent.jobfile/schemas/jobfile.xsd"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Add<span class="re2">></span></span></span> |
| <span class="sc3"><span class="coMULTI"><!-- sample record where id is created and content is loaded into attachment from file url //--></span></span> |
| <span class="sc3"><span class="re1"><Record</span> <span class="re0">version</span>=<span class="st0">"2.0"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"MimeType"</span><span class="re2">></span></span>text/html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Size"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>16536<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Extension"</span><span class="re2">></span></span>html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"LastModifiedDate"</span> <span class="re0">type</span>=<span class="st0">"datetime"</span><span class="re2">></span></span>2009-03-13T10:42:00+0100<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Filename"</span><span class="re2">></span></span>epl-v10.html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Path"</span><span class="re2">></span></span>epl-v10.html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attachment<span class="re2">></span></span></span>Content####epl-v10.html<span class="sc3"><span class="re1"></Attachment<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Record<span class="re2">></span></span></span> |
| |
| <span class="sc3"><span class="coMULTI"><!-- sample record where id is created and content is loaded inti attachment from http url //--></span></span> |
| <span class="sc3"><span class="re1"><Record</span> <span class="re0">version</span>=<span class="st0">"1.0"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"MimeType"</span><span class="re2">></span></span>text/html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Size"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>11765<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Extension"</span><span class="re2">></span></span>html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"LastModifiedDate"</span> <span class="re0">type</span>=<span class="st0">"date"</span><span class="re2">></span></span>2009-07-09<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Url"</span><span class="re2">></span></span>http://www.eclipse.org/smila/<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attachment<span class="re2">></span></span></span>Content####http://www.eclipse.org/smila/<span class="sc3"><span class="re1"></Attachment<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Record<span class="re2">></span></span></span> |
| |
| <span class="sc3"><span class="coMULTI"><!-- sample record where id is provided and txt content is provided in attribute //--></span></span> |
| <span class="sc3"><span class="re1"><Record</span> <span class="re0">version</span>=<span class="st0">"2.0"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_recordid"</span><span class="re2">></span></span>jobfile:C:/sample folder/sample filename.txt<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_source"</span><span class="re2">></span></span>jobfile<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"MimeType"</span><span class="re2">></span></span>text/plain<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Size"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>16384<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Extension"</span><span class="re2">></span></span>txt<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"LastModifiedDate"</span> <span class="re0">type</span>=<span class="st0">"datetime"</span><span class="re2">></span></span>2009-07-09T14:53:16+0100<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Filename"</span><span class="re2">></span></span>sample filename.txt<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Path"</span><span class="re2">></span></span>C:/sample folder/sample filename.txt<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Content"</span><span class="re2">></span></span>This is just some imaginary text content. Used to show how SMILA JobFileAgent works.<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Record<span class="re2">></span></span></span> |
| |
| <span class="sc3"><span class="coMULTI"><!-- sample record where id is provided and html content is provided in attribute //--></span></span> |
| <span class="sc3"><span class="re1"><Record</span> <span class="re0">version</span>=<span class="st0">"2.0"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_recordid"</span><span class="re2">></span></span>jobfile:C:/sample folder/sample filename.html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_source"</span><span class="re2">></span></span>jobfile<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"MimeType"</span><span class="re2">></span></span>text/html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Size"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>16384<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Extension"</span><span class="re2">></span></span>html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"LastModifiedDate"</span> <span class="re0">type</span>=<span class="st0">"datetime"</span><span class="re2">></span></span>2009-07-09T14:53:16+0100<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Filename"</span><span class="re2">></span></span>sample filename.html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Path"</span><span class="re2">></span></span>C:/sample folder/sample filename.html<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Content"</span><span class="re2">></span></span> |
| <span class="sc2"><![CDATA[</span> |
| <span class="sc2"> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"></span> |
| <span class="sc2"> <HTML></span> |
| <span class="sc2"> <HEAD></span> |
| <span class="sc2"> <TITLE> A sample test document </TITLE></span> |
| <span class="sc2"> <META NAME="Author" CONTENtype="Danieel Stucky"></span> |
| <span class="sc2"> <META NAME="Keywords" CONTENtype="SMILA eclipse"></span> |
| <span class="sc2"> <META NAME="Description" CONTENtype="sample test document"></span> |
| <span class="sc2"> </HEAD></span> |
| <span class="sc2"> <BODY></span> |
| <span class="sc2"> This is just some imaginary text content. Used to show how SMILA's Job File agent works. It even contains a <a href="http://www.eclipse.org">link</a>.</span> |
| <span class="sc2"> </BODY></span> |
| <span class="sc2"> </HTML></span> |
| <span class="sc2"> ]]></span> |
| <span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Record<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Add<span class="re2">></span></span></span> |
| |
| <span class="sc3"><span class="re1"></JobFile<span class="re2">></span></span></span></pre></div> |
| <a name="See_also"></a><h2> <span class="mw-headline"> See also </span></h2> |
| <ul><li> <a href="Agent.html" title="SMILA/Documentation/Agent">Agent</a> |
| </li><li> <a href="Mock_Agent.html" title="SMILA/Documentation/Mock Agent">Mock Agent</a> |
| </li><li> <a href="Feed_Agent.html" title="SMILA/Documentation/Feed Agent">Feed Agent</a> |
| </li></ul> |
| <p><br /> |
| </p> |
| <!-- |
| NewPP limit report |
| Preprocessor node count: 104/1000000 |
| Post-expand include size: 1036/2097152 bytes |
| Template argument size: 506/2097152 bytes |
| #ifexist count: 0/100 |
| --> |
| |
| <!-- Saved in parser cache with key wikidb:pcache:idhash:20702-0!1!0!!en!2!edit=0 and timestamp 20120202212917 --> |
| <div class="printfooter"> |
| Retrieved from "<a href="JobFile_Agent.html">http://wiki.eclipse.org/SMILA/Documentation/JobFile_Agent</a>"</div> |
| <div id="catlinks"><p class='catlinks'><a href="http://wiki.eclipse.org/Special:Categories" title="Special:Categories">Category</a>: <span dir='ltr'><a href="http://wiki.eclipse.org/Category:SMILA" title="Category:SMILA">SMILA</a></span></p></div> <!-- end content --> |
| <div class="visualClear"></div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| <!-- Yoink of toolbox for phoenix moved up --> |
| |
| |
| </div> |
| </div> |
| <div id="clearFooter"/> |
| <div id="footer" > |
| <ul id="footernav"> |
| <li class="first"><a href="http://www.eclipse.org/">Home</a></li> |
| <li><a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li> |
| <li><a href="http://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li> |
| <li><a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li> |
| <li><a href="http://www.eclipse.org/org/foundation/contact.php">Contact</a></li> |
| <li><a href="http://wiki.eclipse.org/Eclipsepedia:About" title="Eclipsepedia:About">About Eclipsepedia</a></li> |
| </ul> |
| <span id="copyright">Copyright © 2012 The Eclipse Foundation. All Rights Reserved</span> |
| <p id="footercredit">This page was last modified 09:44, 24 January 2012 by <a href="http://wiki.eclipse.org/index.php?title=User:Juergen.schumacher.attensity.com&action=edit" class="new" title="User:Juergen.schumacher.attensity.com">Juergen Schumacher</a>. Based on work by <a href="http://wiki.eclipse.org/User:Drazen.cindric.attensity.com" title="User:Drazen.cindric.attensity.com">Drazen Cindric</a>, <a href="http://wiki.eclipse.org/User:Igor.novakovic.empolis.com" title="User:Igor.novakovic.empolis.com">Igor Novakovic</a> and <a href="http://wiki.eclipse.org/User:Daniel.stucky.empolis.com" title="User:Daniel.stucky.empolis.com">Daniel Stucky</a>.</p> |
| <p id="footerviews">This page has been accessed 2,835 times.</p> |
| </div> |
| |
| <script type="text/javascript"> |
| var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); |
| document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); |
| </script> |
| <script type="text/javascript"> |
| var pageTracker = _gat._getTracker("UA-910670-4"); |
| pageTracker._trackPageview(); |
| </script> |
| |
| |
| |
| |
| |
| |
| |
| <!-- <div class="visualClear"></div> --> |
| |
| <script type="text/javascript">if (window.runOnloadHook) runOnloadHook();</script> |
| </div> |
| |
| <!-- Served in 0.060 secs. --></body></html> |
