Register an FT Optix Connector

Perform the following steps to register an FT Optix extractor:
  1. On the Management Console, select the
    Extractor Info
    tab.
    The Extractor Listing page is displayed.
  2. Click the Add [] icon.
    The
    Extractor Info Detail
    page is displayed.
    Extractor Info Detail
  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, DataMosaix 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 the source type of extractor as
    FT OPTIX
    .
    Extractor Info Detail - FT OPTIX Connector
    NOTE:
    • Click
      Get FactoryTalk Optix
      link to download or open the release build of FactoryTalk Optix.
    • Click
      Get FactoryTalk Optix DataMosaix Connector
      to view the PCDC portal and download the installer file.
    • Click
      For detailed instructions to download the connector
      to view the
      Download the FactoryTalk Optix from PCDC
      section in the online help documentation.
    • Click
      What else should be done in FactoryTalk Optix to connect to DataMosaix?
      to view the
      Register an FT Optix Connector
      section in the online help documentation.
  11. Click
    Save and Apply
    .
    The
    Generated info Saved
    dialog box is displayed and it contains the configuration information. You can view the configuration file details by clicking
    View generated configuration file
    . Alternatively, you can also copy and save the information for future use by clicking
    Copy All
    . Click
    Download
    to download the config.yml file that includes all the configuration information that you can use to run the extractor.
    Extractor Configuration File Download
  12. Click
    Download
    .
    The
    config.yml
    file is downloaded in the Downloads folder of your local machine.
    NOTE:
    The user can view the
    Application Id
    ,
    Client secret
    ,
    pipeline-id
    , and
    datasetid
    in the
    config.yml
    file.
  13. Click
    Close
    to close the pop-up window.
    The new extractor is displayed under Extractor Listing.
  14. Perform the following steps to add
    Environment Variable
    in the
    config.yml
    file:
    IMPORTANT: For security reasons, it is recommended to move the client secret from the
    config.yml
    file to the User Environment Variable.
    NOTE:
    The
    Environment Variable
    is only accessible in Windows environment, not in Optix Panel. For Optix panel, use the default
    config.yml
    file generated by FactoryTalk DataMosaix.
    1. Go to Windows search and search for
      Environment Variable
      .
    2. Click
      Edit the system environment variables
      .
      The
      System Properties
      window is displayed.
    3. Navigate to
      Advanced
      >
      Environment Variables...
      .
      The
      Environment Variables
      dialog box is displayed.
    4. Click
      New
      .
      The
      New User Variable
      dialog box is displayed.
    5. Provide the following details:
      • Variable name: Provide variable name as
        optix-connector-secret
        .
      • Variable value: Refer to the client secret from the
        config.yml
        file.
    6. Click
      OK
      .
      Environment Variable Details
      Add Environment Variable
    7. Delete the client secret from the
      config.yml
      file.
    8. Uncomment the
      secret: ${optix-connector-secret}
      line and save the file.
      Uncomment Environment Variable
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal