Register an FactroyTalk Batch Extractor

Perform the following steps to register an
FactoryTalk
 Batch extractor:
  1. Click the
    Extractor Info
     tab from the left pane.
    The
    Extractor Listing
     page is displayed.
  2. Click the [+] icon from the top-left corner of the page.
    Extractor Info Tab
    The
    Extractor Info Detail
     page is displayed.
    Extractor Info Detail Page
  3. In the
    General Info
     section, provide the following details:
    • Source Name
      : By default, DataMosaix generates a source name. The user can also provide a unique name for the extractor.
      NOTE:
      The source name serves as the identifier for your extractor. Users can search for an extractor using the source name. For example: EXT_140623100541786_createproject_v1. Here, EXT stands for extractor, 140623 is the date in ddmmyy format, 100541786 is the timestamp in hhmmssSSS format (SSS represents milliseconds), and createproject_v1 is the project the user is currently working on. The user can use the default source name or create their own."
    • Location
       (Optional): Provide the location details for which the user is creating the extractor.
      NOTE:
      This information can help the user identify an extractor when there are many extractors for different plants/sites/locations.
    • Associated Roles
      : By default, the
      Extractors
       role is selected. Users must choose at least one role from the
      Associated Roles
       drop-down list. The user can also select multiple roles from the drop-down list. Use the search bar to find a specific role. If the user wants to apply all roles to the application, select the
      Select All
       checkbox.
      NOTE:
      Click
      Role Reference
       to view various roles and capabilities. The
      Associated Roles
       drop-down is visible and available only for Project Admin users or users within the organization with a Project Admin role assigned.
      General Info Section
      In the
      Pipeline
       section, the user can create a new pipeline or use an existing pipeline.
  4. To use an existing pipeline, select the required option from the
    Pipeline Name
     drop-down list. The
    Pipeline External ID
     box and
    Dataset Name
     box are auto populated.
  5. To create a new pipeline, perform the following steps:
    1. Click
      + Create Pipeline
      .
      The
      Create Pipeline
       dialog box is displayed.
      Create Pipeline Dialog
    2. Provide the following Pipeline information:
      • Pipeline Name
        : By default, DataMosaix generates a pipeline name. The user can also provide a unique name for the pipeline.
      • Pipeline External ID
        : By default, DataMosaix generates a pipeline external ID. The user can also provide a unique external ID for the pipeline.
      • Pipeline Description
         (Optional): Provide the description for the pipeline.
    3. When creating a pipeline, either select an existing dataset from the
      Dataset Name
       drop-down list or create a new dataset.
      If the user wants to create a new dataset, click
      Create Dataset
       and provide the following information:
      • Dataset Name
        : By default, DataMosaix generates a dataset name. The user can also provide a unique name for the dataset.
      • Dataset Description
        : Provide the description for the dataset.
    4. Click
      Add
      .
      The Pipeline and Dataset information is displayed on the
      Extractor Info Detail
       page.
      Create Dataset
  6. In the
    Source Info
     section, perform the following steps:
    1. Choose Source
      : Select the
      FT Batch (Beta)
       source from the drop-down list.
    2. Mode
      :Select
      Single
      if data is to be pushed into CDF once and
      Continuous
      otherwise.
    3. Interval
      : Provide the interval value in hours.
    4. Connection-string
      : Provide the connection string to establish the connection.
  7. Click
    Save and Apply
    .
    Source Info - FactoryTalk Batch Extractor
    NOTE:
    The
    Save and Apply
     button is enabled after the user provides all the required details.
    The
    Generated info Saved
     dialog box is displayed, and it contains the configuration information. Click
    View generated configuration file
     to view the configuration file details. Click
    Copy All
     to copy and save the information to local machine.
  8. Click
    Download
    .
    The
    config.yml
     file is downloaded in the
    Downloads
     folder of your local machine. It contains all the configuration information needed to run the extractor.
  9. Click
    Close
     to close the dialog box.
    Generated Info Saved Dialog
    The new extractor is displayed in the
    Extractor Listing
     page.
  10. Under the
    Type
     column, click the
    FT Batch (Beta)
    of the newly created extractor, it will be navigated to the
    Cognite
     page.
    Extractor Type - FactroyTalk Batch Extractor
  11. Click
    Download extractor
     to download the
    FactoryTalk
     Batch extractor.
    Cognite Page
  12. Navigate to your project in CDF by clicking
    Main DataMosaix
     and select
    Integrate
     >
    Staging
    .
    Cognite Data Fusion - Staging
  13. Click
    Create Database
    .
  14. Click
    Create table
    . Provide a unique name for the table. The table name cannot be changed later.
  15. Select
    Create empty table
     and click
    Create
    .
  16. Download the extractor to your local machine.
  17. Copy the downloaded .yml file to the
    config
     folder where the extractor is installed.
  18. Navigate to the
    DBExtractor
    folder and open the command prompt from this folder. Execute the extractor using the command:
    dbextractor-standalone-v3.1.4-win32.exe ./config.yml
    .
  19. Once the extractor has been configured and executed successfully, navigate to your project in CDF and open the pipeline by selecting
    Integrate
     >
    Extraction Pipelines
    .
  20. Click the pipeline name for which you want to view the details, and then click
    Run History
    .
    You should be able to view the information mentioning that the extractor has run successfully.
    Extractor Success Info
  21. Select
    Integrate
     >
    Staging
     to verify if the data is inserted into the table.
    Cognite Data Fusion - Staging
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal