Difference between revisions of "Jira Issues Scanner (Aspire 2)"

From wiki.searchtechnologies.com
Jump to: navigation, search

For Information on Aspire 3.1 Click Here

Line 8: Line 8:
 
|factory=aspire-jira-issue-connector
 
|factory=aspire-jira-issue-connector
 
|subtype=default}}
 
|subtype=default}}
 +
{{Aspire 2.0 Premium}}
  
 
The ''Jira Issues Scanner'' component performs full and incremental scans over a Jira instance, extracting all types of issues and maintains a snapshot of the instance. This snapshot can be compared with the current content in future crawls to establish what content has been updated. Updated content is then submitted to the configured pipeline in [[AspireObject (Aspire 2)|AspireObject]]s attached to [[Job Class_Aspire_2|Job]]s. As well as the URL of the changed item, the [[AspireObject (Aspire 2)|AspireObject]] will also contain metadata extracted from the Jira instance. Updated content is split into three types -add, update and delete-. Each type of content is published as a different event so that it may be handled by different Aspire pipelines.
 
The ''Jira Issues Scanner'' component performs full and incremental scans over a Jira instance, extracting all types of issues and maintains a snapshot of the instance. This snapshot can be compared with the current content in future crawls to establish what content has been updated. Updated content is then submitted to the configured pipeline in [[AspireObject (Aspire 2)|AspireObject]]s attached to [[Job Class_Aspire_2|Job]]s. As well as the URL of the changed item, the [[AspireObject (Aspire 2)|AspireObject]] will also contain metadata extracted from the Jira instance. Updated content is split into three types -add, update and delete-. Each type of content is published as a different event so that it may be handled by different Aspire pipelines.

Revision as of 15:58, 9 July 2015

 (2.1 Release)  


Jira Issues Scanner (Aspire 2)
Factory Name  com.searchtechnologies.aspire:aspire-jira-issue-connector
subType  default
Inputs  AspireObject from a content source submitter holding all the information required for a crawl
Outputs  Jobs from the crawl
Feature only available with Aspire Premium

The Jira Issues Scanner component performs full and incremental scans over a Jira instance, extracting all types of issues and maintains a snapshot of the instance. This snapshot can be compared with the current content in future crawls to establish what content has been updated. Updated content is then submitted to the configured pipeline in AspireObjects attached to Jobs. As well as the URL of the changed item, the AspireObject will also contain metadata extracted from the Jira instance. Updated content is split into three types -add, update and delete-. Each type of content is published as a different event so that it may be handled by different Aspire pipelines.

The scanner reacts to an incoming job. This job may instruct the scanner to start, stop, pause or resume. Typically the start job will contain all information required by the job to perform the crawl.When pausing or stopping, the scanner will wait until all the jobs it published have completed before completing itself.


Configuration

This section lists all configuration parameters available to configure the Jira Issues Scanner component.

General Scanner Component Configuration

Basic Scanner Configuration

Element Type Default Description
snapshotDir String snapshots The directory for snapshot files.
numOfSnapshotBackups int 2 The number of snapshots to keep after processing.
waitForSubJobsTimeout long 600000
(=10 mins)
Scanner timeout while waiting for published jobs to complete.
maxOutstandingTimeStatistics long 1m The max about of time to wait before updating the statistics file. Whichever happens first between this property and maxOutstandingUpdatesStatistics will trigger an update to the statistics file.
maxOutstandingUpdatesStatistics long 1000 The max number of files to process before updating the statistics file. Whichever happens first between this property and maxOutstandingTimeStatistics will trigger an update to the statistics file.
usesDomain boolean true Indicates if the group expansion request will use a domain\user format (useful for connectors that does not support domain in the group expander).

Branch Handler Configuration

This component publishes to the onAdd, onDelete and onUpdate, so a branch must be configured for each of these three events.

Element Type Description
branches/branch/@event string The event to configure - onAdd, onDelete or onUpdate.
branches/branch/@pipelineManager string The name of the pipeline manager to publish to. Can be relative.
branches/branch/@pipeline string The name of the pipeline to publish to. If missing, publishes to the default pipeline for the pipeline manager.
branches/branch/@allowRemote boolean Indicates if this pipeline can be found on remote servers (see Distributed Processing for details).
branches/branch/@batching boolean Indicates if the jobs processed by this pipeline should be marked for batch processing (useful for publishers or other components that support batch processing).
branches/branch/@batchSize int The max size of the batches that the branch handler will created.
branches/branch/@batchTimeout long Time to wait before the batch is closed if the batchSize hasn't been reached.
branches/branch/@simultaneousBatches int The max number of simultanous batches that will be handled by the branch handler.


Configuration Example

  <component name="Scanner" subType="default" factoryName="aspire-jira-issue-connector">
    <debug>true</debug>
    <snapshotDir>${aspire.home}/data/snapshots</snapshotDir>
    <fileNamePatterns>
      <include pattern=".*" />
      <exclude pattern=".*tmp$" />
    </fileNamePatterns>
    <branches>
      <branch event="onAdd" pipelineManager="../ProcessPipelineManager" pipeline="addUpdatePipeline" allowRemote="true" batching="true"
        batchSize="50" batchTimeout="60000" simultaneousBatches="2" />
      <branch event="onUpdate" pipelineManager="../ProcessPipelineManager" pipeline="addUpdatePipeline" allowRemote="true" batching="true"
        batchSize="50" batchTimeout="60000" simultaneousBatches="2" />
      <branch event="onDelete" pipelineManager="../ProcessPipelineManager" pipeline="deletePipeline" allowRemote="true" batching="true"
        batchSize="50" batchTimeout="60000" simultaneousBatches="2" />
    </branches>
  </component>


Source Configuration

Scanner Control Configuration

The following table describes the list of attributes that the AspireObject of the incoming scanner job requires to correctly execute and control the flow of a scan process.

Element Type Options Description
@action string start, stop, pause, resume, abort Control command to tell the scanner which operation to perform. Use start option to launch a new crawl.
@actionProperties string full, incremental When a start @action is received, it will tell the scanner to either run a full or an incremental crawl.
@normalizedCSName string Unique identifier name for the content source that will be crawled.
displayName string Display or friendly name for the content source that will be crawled.

Header Example

  <doc action="start" actionProperties="full" actionType="manual" crawlId="0" dbId="0" jobNumber="0" normalizedCSName="FeedOne_Connector"
   scheduleId="0" scheduler="##AspireSystemScheduler##" sourceName="ContentSourceName">
    ...
    <displayName>testSource</displayName>
    ...
  </doc>

All configuration properties described in this section are relative to /doc/connectorSource of the AspireObject of the incoming Job.

Element Type Default Description
url string The url of the Jira Instance to connect to.
https://searchtechnologies.atlassian.net
username string The username to use to connect to Jira
password string The password to use to connect to Jira
pageSize integer 100 The number of issues to retreive from Jira in one batch
fileNamePatterns/include/@pattern regex none Optional. A regular expression pattern to evaluate file urls against; if the file name matches the pattern, the file is included by the scanner. Multiple include nodes can be added.
fileNamePatterns/include/@pattern regex none Optional. A regular expression pattern to evaluate file urls against; if the file name matches the pattern, the file is excluded by the scanner. Multiple exclude nodes can be added.
fileNamePatterns/include/@pattern regex none Optional. A regular expression pattern to evaluate file urls against; if the file name matches the pattern, the file is excluded by the scanner. Multiple exclude nodes can be added.

Scanner Configuration Example

  <doc action="start" actionProperties="full" normalizedCSName="testFile" scheduleId="1">
    <connectorSource>
      <url>https://searchtechnologies.atlassian.net</url>
      <username>sdenny</username>
      <password>encrypted:84EC27D1032179EA7A12F1D43CC92CEF</password>
      <pageSize>100</pageSize>
      <fileNamePatterns/>
    </connectorSource>
    <displayName>Jira Issues</displayName>
  </doc>


Output

<doc>
  <url>https://searchtechnologies.atlassian.net/browse/ANITESUPPORT-1</url>
  <id>https://searchtechnologies.atlassian.net/browse/ANITESUPPORT-1</id>
  <fetchUrl>https://searchtechnologies.atlassian.net/browse/ANITESUPPORT-1</fetchUrl>
  <displayUrl>https://searchtechnologies.atlassian.net/browse/ANITESUPPORT-1</displayUrl>
  <snapshotUrl>001 https://searchtechnologies.atlassian.net/browse/ANITESUPPORT-1</snapshotUrl>
  <docType>item</docType>
  <repItemType>aspire/issue</repItemType>
  <owner>Northgate Support  (formerly Anite)</owner>
  <createdBy>Northgate Support  (formerly Anite)</createdBy>
  <lastModified>2008-10-09T08:05:43Z</lastModified>
  <content>Maynor Alvarado (malvarado@searchtechnologies.com) added a comment on 19/Sep/08 3:39 PM

This is the regular behavior on IMAN. Could you please specify in which order would you like IMAGES to be uploaded? Based on this information Search Technologies will provide an estimate of the effort that is required to implement this functionality. 

=================================================================

Maynor Alvarado (malvarado@searchtechnologies.com) added a comment on 19/Sep/08 9:13 PM

ANITE support call number is 424346

Ian wrote:


Hi 

Is this in relation to an existing Anite call? If so, please supply the reference number so we can add this to that call.

Thanks

Ian

=================================================================

Maynor Alvarado (malvarado@searchtechnologies.com) added a comment on 03/Oct/08 10:32 PM

We need feedback to provide support on this particular issue. Can we assume that SW requires the first uploaded image to be the first displayed?

Thanks

=================================================================

Northgate Support  (formerly Anite) (ncjservicedesk@northgate-is.com) added a comment on 06/Oct/08 9:21 AM

Yes, that is correct.

Regards,
Harpreet

=================================================================

Carlos Torres (ctorres@searchtechnologies.com) added a comment on 07/Oct/08 8:33 PM

The following files were modified to fix this bug: browse.asp, socrates.asp, and functions.asp.

=================================================================

Maynor Alvarado (malvarado@searchtechnologies.com) added a comment on 08/Oct/08 10:21 PM

Please feel free to download the three files from the Anite ftp account under the SouthWales directory. PLEASE BACK UP the current files before deploying and test this fix.

FTP info is:

URL              :  ftp://200.122.188.235
Login            :  anite
Pass             :  an1t3soc


=================================================================

Maynor Alvarado (malvarado@searchtechnologies.com) added a comment on 08/Oct/08 10:22 PM

Fixed sent to Anite. Waiting for feedback

=================================================================

Northgate Support  (formerly Anite) (ncjservicedesk@northgate-is.com) added a comment on 09/Oct/08 9:05 AM

Files have been downloaded from the ftp site. I will contact the customer before sending the files as I've been informed they bounce back if emailed across.

I will update you once I receive feedback from South-Wales.

Harpreet

</content>
  <dataSize>2514</dataSize>
  <modifiedBy>Northgate Support  (formerly Anite)</modifiedBy>
  <connectorSpecific type="jiraissue">
    <field name="issueKey">ANITESUPPORT-1</field>
    <field name="summary">On Upload, last Image is put first in Iman - ANITE support ref 424346</field>
    <field name="description">South Wales Police are having the above problem with Iman.</field>
    <field name="projectName">ANITE Support</field>
    <field name="projectKey">ANITESUPPORT</field>
    <field name="issueTypeName">Bug</field>
    <field name="issueTypeId">1</field>
    <field name="priorityName">Major</field>
    <field name="priorityId">3</field>
    <field name="statusName">Resolved</field>
    <field name="statusId">5</field>
    <field name="createdDate">2008-09-12T12:55:24Z</field>
    <field name="creatorName">support@anite.com</field>
    <field name="creatorDisplayName">Northgate Support  (formerly Anite)</field>
    <field name="creatorEmail">ncjservicedesk@northgate-is.com</field>
    <field name="reporterName">support@anite.com</field>
    <field name="reporterDisplayName">Northgate Support  (formerly Anite)</field>
    <field name="reporterEmail">ncjservicedesk@northgate-is.com</field>
    <field name="assigneeName">ctorres</field>
    <field name="assigneeDisplayName">Carlos Torres</field>
    <field name="assigneeEmail">ctorres@searchtechnologies.com</field>
    <field name="resolutionName">Fixed</field>
    <field name="resolutionId">1</field>
    <field name="resolutionDate">2008-10-08T21:22:14Z</field>
  </connectorSpecific>
  <sourceName>JiraIssues</sourceName>
  <sourceType>jiraissue</sourceType>
  <connectorSource type="jiraissue">
    <url>https://searchtechnologies.atlassian.net</url>
    <username>sdenny</username>
    <password>encrypted:84EC27D1032179EA7A12F1D43CC92CEF</password>
    <pageSize>100</pageSize>
    <fileNamePatterns/>
    <displayName>JiraIssues</displayName>
  </connectorSource>
  <action>add</action>
</doc>