Register a Fiix Extractor

Perform the following steps to register a
Fiix
 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
    SaaS
     as the source type and
    Fiix
     as the extractor source. After making your selections, the system displays the required configuration fields, such as
    Tenant URL
    ,
    Application ID
    ,
    Integration Access Key
    ,
    Integration Secret Key
    , and other relevant parameters. Provide the necessary information to complete the configuration.
    Generate New Extractor - Source Info
  11. Provide the following information to connect with source.
    1. Select
      SaaS
       type from dropdown.
    2. Select source
      Fiix
       from dropdown.
    3. Enter
      Tenant URL
      .
    4. Enter
      Application ID
      .
    5. Provide the
      Integration Access Key
       and
      Secret Key
      .
    6. 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 Fiix extractor carefully. Once configured, it cannot be changed, as data ingestion uses incremental refresh. Ensure you select the correct starting point from which you want data to begin being pushed.
    7. Enter the
      Interval
       in hours.
    8. Select an
      object
       or multiple
      objects
       from the list of available objects.
    9. Click
      Save and Apply
      .
      The configuration is saved, and the
      Run Extractor
       dialog box is displayed with the following options:
      1. Run Now
        : Saves the configuration and starts the extractor immediately.
      2. Run Later
        : Saves the configuration without starting the extractor. You can start the extractor at a later time when needed.
      Run Extractor
  12. Click
    Run Now
     or
    Run Later
     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