Register a FactoryTalk Alarms and Events Extractor

Perform the following steps to register a FactoryTalk Alarms and Events extractor:
  1. On the Management Console, select the
    Extractor Configurations
     tab.
    The
    Extractor File Configurations
     page will open, displaying a list of all available extractors.
    Extractor Configurations
  2. Click the Add [] icon.
    The
    Generate New Extractor
     page is displayed.
    Generate New Extractor
  3. In the
    General Info
     section, provide a unique name for your extractor in the
    Source Name
     field. The source name works as the identifier for your extractor. You can search for an extractor using the source name. By default,
    FactoryTalk DataMosaix SaaS
     populates a source name.
    Source Name example: EXT_1406230728_createproject_v1.
    Here, EXT stands for the extractor, 140623 is the date in ddmmyy format, 0728 is the timestamp in hhmm format, and createproject_v1 is the project in which you are currently working. You can use the default source name or create your own.
  4. (Optional) Provide the location details. It can help you identify an extractor when you have many extractors for different plants/sites/locations.
  5. From the
    Associated Roles
     drop-down list, select at least one role. You can refer to various roles and capabilities by clicking
    Role Reference
    .
    NOTE:
    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.
    You can select multiple roles from the Associated Roles drop-down list. In the search bar, you can search for any specific role from the list. If you want to apply all the roles to the application, select the
    Select All
     checkbox.
    Next, you can select a pipeline or create a new pipeline. When you create a new pipeline, you have the option of selecting from an existing dataset or creating a new dataset.
  6. In the
    Pipeline Name
     field, search for a specific pipeline by entering the first characters and select a pipeline. On selecting a pipeline, the
    Pipeline External ID
     and
    Dataset Name
     fields are generated.
    To create a new pipeline, select the
    + Create Pipeline
     option.
    The
    Create Pipeline
     dialog box is displayed.
    Create Pipeline
  7. Provide the following Pipeline information to create a new pipeline:
    • Pipeline Name
    • Pipeline External ID
    • Pipeline Description (Optional)
  8. When you create a pipeline, you can either select an existing dataset or create a new dataset. Select a Dataset from the
    Dataset Name
     search field, if you want to use an existing Dataset.
    If you choose to create a new Dataset, the Dataset-related fields will be displayed. Provide the following dataset information:
    • Dataset Name
    • Dataset Description
  9. Click
    Add
    . Based on the options you choose (select or create), the Pipeline and Dataset information is either populated or created and displayed on the
    Extractor Info Detail
     page.
  10. In the
    Source Info
     section, select
    FT Alarms & Events
     as the extractor source type. After selection, the system will display fields such as
    Server Name
    ,
    Database Name
    ,
    Username
    ,
    Password
    , and other required parameters for you to provide the necessary details.
    Generate New Extractor - Source Info
  11. Provide the following information to connect with source.
    1. Select source
      FT Alarms & Events
       from dropdown.
    2. Enter
      Server Name
      .
    3. Enter
      Database Name
      .
    4. Provide the
      username
       and
      password
      .
    5. Specify the
      Start date
      and
      time
      from which data should be fetched. If not provided, the default is the
      current date
       and
      current time minus 2 hours
      NOTE:
      Set the start date and time for the FT Alarms & Events extractor. Once it is set up, it will not change later because the data will be pushed using incremental refresh. So, make sure you choose the correct point from where you want to start pushing data.
    6. Choose
      Run Options
       to run the extractor either manually from the console or automatically as a Windows service.
      1. Manual-Console
        : Select this option to run the extractor manually from the console. To install and run the extractor in this mode, refer to the documentation page
        Install and Run FactoryTalk Alarms and Events - FactoryTalk DataMosaix Connector (Manual‑Console)
        .
      2. Automatic-Service
        : Select this option to run the extractor automatically as a background Windows service. To install and run the extractor in this mode, refer to the documentation page
        Install and Run FactoryTalk Alarms and Events - FactoryTalk DataMosaix Connector (Automatic‑Service)
        .
    7. Mode is
      Continuous
       or
      Single
      .
      1. Continuous
        : Fetch data at regular intervals. Enter the
        interval
         in hours.
      2. Single
        : Fetch data once. Do
        not
         provide an interval.
    8. (Optional) Provide the
      Port No
      .
  12. Click
    Save and Apply
    .
    The
    Generated info Saved
     dialog box is displayed, and it contains the configuration information. To view the configuration file, click
    View Generated Configuration File
    . Alternatively, copy and save the information for future use by clicking
    Copy All
    . To download the configuration file, click
    Download
    . This will download a
    config.yml
     file containing all the configuration details required to run the extractor.
    Extractor Configuration File Download
  13. Click
    Close
     to close the pop-up window.
    The new extractor is displayed under
    Extractor File Configurations
    .
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal