Adding an Archer-to-Archer Transport Only Data Feed

Complete the following tasks to add an Archer-to-Archer Transport Only Data Feed.

Note: If you want to use a data feed that was created in Archer 4.x, you must run an XML Record Search, and select Search XML as the Search Type.

On this page

Example: Archer-to-Archer data feed - XML search for transport only

The following table shows an example of the values of a data feed for the Archer Web Services Transporter using an XML search to retrieve data from the Archer Web Services API. The example shows the settings for each property of the data feed and running the data feed without a schedule.

Tab

Section

Field

Value

Notes

General

General Information

Name

user defined

The unique name of the data feed, for example, AWS Transport ONLY Data Feed.

 

 

Alias

default

By default, the Alias is the same as the Name, for example, AWS_TO_Data Feed. The Alias name designates the name of the folder for this data feed in the home directory.

 

 

Status

Active

The data feed must have an Active status to run.

 

Feed Information

Service Account Name

user defined

The user name under which the data feed will run, for example, AWS_Transport_Only.

 

 

Feed Type

Transport Only

 

 

 

Target Path

user defined

The name and location of the file being transported, for example, AWS.xml.

Source Connection

  

Transport Method

Archer Web Services Transporter

 

 

Logon Properties

URL

[http://yoursiteURL/ws/search.asmx]

For example, http://qa-web10.archerlab.local:8000/ws/search.asmx. Replace yoursiteURL with your actual URL to the Archer instance.

 

 

Credentials

select the option for the current instance

Anonymous or Service Account User: Select if the current instance is set up for anonymous authentication or when the Service Account that runs the Job Engine service can access IIS.

Specific: Select if the current instance is set up for Windows authentication. You will need to provide: User Name and Password for Windows authentication. The Domain is optional.

 

Transport Configuration

Search Type

Search XML

 

 

 

SSL Connection

Transport Only

Select this option to use a secure connection.

 

 

User Name

user defined

The user who has access to the Archer Web Services API and the report.

 

 

Password

user defined

The password for the user in which the data feed will run.

 

 

Instance

user defined

For example, South Beach.

 

 

Records Per File

10,000

Recommendation to ensure fewer files need to be retrieved in the API call.

 

 

Application GUID

system defined

From the Record Search in Archer, for example, C6A312AC-F4F1-4F33-BCFD-CE30232400C5.

 

 

Configuration String

 

For Example:

<Search><ReturnDomain value="1"/><ShowFieldName value="1"/><Display><Field id="35097"/><Field id="35096"/><Field id="35047"/><Field id="35061"/><Field id="35057"/><Field id="35046"/><Field id="35081"/><Field id="35094"/><Field id="34977"/><Field id="34985"/><Field id="34998"/><Field id="34997"/><Field id="34989"/><Field id="34988"/><Field id="34987"/><Field id="34986"/><Field id="34984"/><Field id="34981"/><Field id="34996"/><Field id="34995"/><Field id="34994"/><Field id="34993"/><Field id="34992"/><Field id="34991"/><Field id="34990"/><Field id="34980"/><Field id="35009"/><Field id="35031"/><Field id="35029"/><Field id="35026"/><Field id="35028"/><Field id="35024"/><Field id="35027"/><Field id="35025"/><Field id="35051"/><Field id="35037"/><Field id="34979"/><Field id="35032"/><Field id="34978"/><Field id="35039"/><Field id="35022"/><Field id="35021"/><Field id="35038"/><Field id="35020"/><Field id="35042"/><Field id="35007"/><Field id="35045"/><Field id="35044"/><Field id="35043"/><Field id="35002"/><Field id="34999"/><Field id="35104"/><Field id="35107"/><Field id="35108"/><Field id="35105"/><Field id="35106"/><Field id="35109"/><Field id="35110"/><Field id="35115"/><Field id="35117"/><Field id="35112"/><Field id="35113"/><Field id="35111"/><Field id="35065"/><Field id="35116"/><Field id="35114"/></Display></Search>

 

Proxy

Proxy Option

user defined

Select the applicable option if using a proxy server for running the data feed.

Run Configuration

Schedule

  

Start

Click Run Now to run the data feed.

Task 1: Add a transport data feed

  1. From the menu bar, click Admin menu > Integration > Data Feeds.

  2. Click Add to create a new data feed.
  3. In the General Information section, do the following:
    1.  Enter the name and description of the data feed.

      Note: The alias populates automatically when you set the name of the data feed for the first time and save the data feed. You can modify the alias after you save the data feed. The remaining fields in the General Information section are read-only and populate when the data feed is created, updated, and run.

    2. Select Select to make the data feed active.
  4. In the Feed Information section, do the following:
    1. In the Feed Type field, select Transport Only. See Adding Standard Data Feeds to add a Standard data feed.
    2. In the Target Path field, enter the directory path that the exported source file data is saved to.
    3. In the Service Account Name field, enter the user account associated with the data feed. If the user does not exist, you can create a new user. Enter the username. See Data Feeds Service Account for more information on the Service Account Name.

  5. Do one of the following:

    • To continue configuring the data feed, go to the next task.
    • To finish setting up the feed later, click Save or Save and Close.

Task 2: Set up a report search

  1. Go to the Source Connection tab of the data feed.

  2. From the Source Locale list, select a locale.

  3. From the Transport Method list, select a transport type.

  4. In the Logon Properties section, enter the applicable credentials for logging on to the Archer instance. You can specify whether the Archer instance uses anonymous authentication or Windows Authentication.

  5. In the Transport Configuration section, select a Search Type and do one of the following:

    1. Enter the credentials of the account that runs the report. The report results will be based on the permissions of that account.

      Note: The account could be a content administrator with full access permissions to the content of the applications. Do not use the same account that you used to log on.

    2. Select Use Windows Authentication. Single Sign-On must be configured in the source instance to use this option.

  6. If you selected Statistic Report ID or Report ID as the Search Type, enter the GUID or ID of the report that contains the source data.

    7. Note: If you want to use a data feed that was created in Archer 4.x, you must run an XML Record Search, and select Search XML as the Search Type.

  7. Enter the Domain and Instance names to be searched against.

  8. If you selected Search XML as the Search Type, enter the following information:

    • Records per file: The number of files retrieved from the API call.

    • Application GUID: The application that contains the source data.

    • Configuration String: Parameters passed to the SearchRecords method in the SOAP API to run a search.

  9. (Optional) In the Proxy Option field, select the applicable proxy option. You can specify whether the data feed passes through a proxy to access the source data. Set the configuration for the System Proxy in the Control Panel or configure and provide parameters to access another proxy.

  10. (Optional) Complete the applicable fields if you selected a proxy option. Provide the name, port ID, and domain of the proxy server and the user credentials to log onto the proxy server.

  11. (Optional) The data feed creates a local copy of the source data for further processing. In the Post Processing - Local copy of source file section, select from the following options to specify how the data feed handles the local copy of the source data after processing the source data.

    The following table describes the options for post processing the local copy of the source data.

    Option

    Description

    Delete

    Deletes the processed source file when the data feed successfully completes. The data feed also deletes any local copy of the source information.

    Rename

    Saves the source file under a new name when the data feed successfully completes. In File Path and Name, specify the new name for the file and the location to save the file.

    To save the data, ensure that the account running the Job Engine service can access the path of the destination file.

    If you select this option, use filename tokens for specifying the location or name of the file.

    Filename tokens

    Filename tokens are available for post processing when you want to save the source information and specify a location or name for the file. When you select the Rename option, you can use tokens to generate unique names automatically for the files.

    Here are the usable tokens for renaming data files.

    • Now. Insert a user-defined date format within the new filename. Possible formats include Now(MM/dd/yyyy) or Now(MM-dd-yyyy). See the Microsoft .Net Framework Developer Center for available custom date/time formats.

    • DataFileDirectoryName. Update the filename with the directory name, including the drive, of your file.

    • DataFileName. Insert the original filename, excluding the directory name and extension.

    • DataFileExtension. Insert the file extension, such as .csv, in the new filename.

    • DataFileFullName. Insert the fully qualified filename. This data includes the drive, directory, filename, and extension of the original file.

    For example, if the data file came from the following location, C:\DataFeed\Source\ESL\processed\ThreatData.csv, any files renamed using tokens provide the following output.

    Example 1

    • Input Tokens: {DataFileDirectoryName}\success\{DataFileName}_{Now(MM.dd.yyyy)}.{DataFileExtension}
    • Output: C:\DataFeed\Source\ESL\processed\success\ThreatData_01.31.2008.csv

    Example 2

    • Input Tokens: \\DFSRepository\{Now(yyyy)}\{Now(MM)}\{DataFileName}_success.{DataFileExtension}
    • Output: \\DFSRepository\2008\01\ThreatData_success.csv

  12. If you selected the Rename post-processing option, enter the location and name of the new file you want to save in the File Path and Name field.

  13. Do one of the following:

    • To continue configuring the data feed, go to the next task.
    • To finish setting up the feed later, click Save or Save and Close.

Task 3: Define the data feed schedule

You can set up data feeds to run automatically at regular intervals. This reduces the time and effort required to import data from an external file. You can initiate data feeds at various times and configure them to run in regular increments for an indefinite period of time.

You can also run the data feed immediately.

To prevent excess server load, schedule data feeds on a staggered basis. You can schedule a maximum of 10 data feeds to run at a time. If more than 10 data feeds are scheduled, each remaining data feed run as the previous one completes.

A reference feed allows you to specify another feed. This indicates to the Data Feed Service that this feed will start running as soon as the referenced feed completes successfully. A successful data feed run processes all input data, completes all expected record updates, and does not report any failures in the Run Details Report.

  1. Go to the Run Configuration tab > Schedule section.

  2. Do one of the following to schedule your data feed.

    Run on Schedule

    You can configure your data feed to run on a defined schedule.

    The following table describes the fields in the Run on Schedule option.

    Field

    Description

    Start Date

    Specifies the date on which the data feed schedule begins.

    Start Time

    Specifies the time the data feed starts running.

    Time Zone

    Specifies the time zone in which the data feed schedule begins.

    Recurring

    Specifies the interval in which the data feed runs, for example, Minutely, Hourly, Daily, Weekly, or Monthly.

    • Minutely. Runs the data feed by the interval set.

      • For example, if you specify 45 in the Every list, the data feed runs every 45 minutes.

    • Hourly. Runs the data feed by the interval set, for example, every hour (1), every other hour (2) and so forth.
    • Daily. Runs the data feed by the interval set, for example, every day (1), every other day (2) and, so forth.
    • Weekly. Runs the data feed based on a specified day of the week, for example, every other Monday (2), every third Monday (3), and so forth.
    • Monthly. Runs the data feed based on a specified week of the month, for example, on the first Monday of every month, on the second Tuesday of every third month, and so forth.

    Every

    Specifies the interval of the frequency in which the data feed runs.

    On

    Specifies the frequency of the days of the week on which the data feed runs.

    Weekday

    Specifies the days of the week on which the data feed runs.

    Run After

    Runs a specified data feed before the current one. The Data Feed Service starts the current data feed after the referenced data feed completes successfully.

    For example, you can select to have a Threats data feed run immediately after your Assets data feed finishes. From the Reference Feed dropdown, select the data feed that runs before the current data feed.

    Run Now

    Click the Run Now button in the toolbar on the Manage Data Feed page to run the data feed manually.

  3. To save the data feed, click Save or Save and Close.