Register a Custom Extractor

This topic describes the steps to register a custom extractor in FactoryTalk DataMosaix. You can create a custom extractor if your source type cannot be used with any of the available extractors.
Prerequisites
  • A project is created using FactoryTalk DataMosaix.
Register a custom Extractor
  1. On the Management Console, select the
    Extractor Info
     tab.
    The Extractor list is displayed.
    Extractor Info Tab
  2. Click the Add [+] icon.
    The
    Extractor Info Detail
    page is displayed.
  3. Provide a unique name for your Extractor. The Source Name works as the identifier for your extractor. You can search for an extractor with the Source Name. By default, DataMosaix populates a source name.
    Source Name example: EXT_1406230728_createproject_v1.
    Here, EXT stands for 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. Provide the location details for which you are creating the extractor. This information can help you to 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
    .
    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.
    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.
    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. From the pipeline drop-down, 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.
  7. Provide the following Pipeline information to create a new pipeline:
    • Pipeline Name
    • Pipeline External ID
    • Pipeline Description
  8. When you create a pipeline, you can either select an existing dataset or create a new dataset. Select a Dataset from the drop-down if you want to use an existing Dataset.
    If you choose to create a new Dataset, the Dataset related fields are 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 generated or created and displayed on the Extractor Info Detail page.
  10. Select the source type of extractor as Add Custom / Other.
    NOTE:
    The
    Save and Apply
     button enables after you provide all the required details.
  11. Provide the custom extractor name.
  12. Click Save and Apply.
  13. The
    Credentials and other info
     dialog box displays extractor registration details.
    NOTE:
    It is important to copy and save the credentials in a file immediately for future use. Once you close the
    Credentials and other info
     dialog box, this information cannot be viewed later. If you fail to save the information, you will have to regenerate the client secret.
  14. Click
    Close
     to close the dialog box.
    The new extractor is displayed under Extractor Listing.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.