Register an FT Optix Connector

This topic describes the steps to register and configure an FT Optix connector for FT Optix data to egress to FactoryTalk DataMosaix.
Prerequisites
  • A project is created using FactoryTalk DataMosaix.
  • FactoryTalk Optix Studio and FactoryTalk Optix DataMosaix Connector (FT DataMosaix_Optix_Connector.msi file) are installed on your system.
NOTE:
Make sure that the
FTDM-FTOptix FTDataMosaix Connector
 feature is enabled in the Manage Access > Features tab. For more information, refer to Enable or Disable Features.
Register an FT Optix Connector
  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
      What else should be done in FactoryTalk Optix to connect to DataMosaix?
       to view the
      Register an FT Optix Extractor
       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
Configuring FT Optix to Connect to DataMosaix
Make sure that you have installed the FactoryTalk Optix Studio application on your system. Once you select the source type as FT Optix in the Source Info section, a link to download the application will appear (Get FactoryTalk Optix). You can also download the FactoryTalk Optix Studio from FactoryTalk Hub. For more information on installation, refer to Install FactoryTalk Optix Studio.
  1. Launch the FactoryTalk Optix Studio application.
  2. If the user wants to open an existing FT Optix project, click any project from the
    Recent projects
     section. Or
    Open Existing Project
  3. If the user wants to open a new FT Optix project, Click
    New
     [+].
  4. Provide the
    Name
     and
    Location
     details.
    New FT Optix Project
  5. Click
    Create
    .
Install FT Optix - DataMosaix Connector
On the Extractor Info Detail page, once you select the source type as FT Optix in the Source Info field, a link to download the Optix connector (Get FactoryTalk Optix DataMosaix Connector) is displayed, which you can use to download the Optix-DataMosaix connector installer file.
  1. Download the Optix DataMosaix connector installer file (FTDataMosaix_Optix_Connector.msi) from the Product Compatibility and Download Center (PCDC). Also, you can use this link to download the connector.
  2. Right-click on the FTDataMosaix_Optix_Connector.msi file and choose
    Run as Administrator
     to begin the installation.
    The
    SOFTWARE AND CLOUD SERVICES AGREEMENT
     dialog box is displayed.
  3. Read the license agreement and select the
    I accept the terms in the License Agreement
     checkbox and then click
    Install
    .
    Installer Setup
    By default, the installation takes place in the following location: C:\Program Files\Rockwell Automation\FTDataMosaix_Optix_Connector
  4. Once the installation is complete, the ‘Completed the FTOptix_DataMosaix_Connector Setup Wizard’ screen is displayed. Click
    Finish
     to close the installation window.
    After the installation is completed successfully, a shortcut to the ‘FactoryTalk Optix - DataMosaix Connector Setup’ will be created on your desktop.
    Connector Setup Shortcut
  5. Double-click on the
    FactoryTalk Optix - DataMosaix Connector Setup
     to open it.
    The 'FactoryTalk Optix - DataMosaix Connector Setup' window is displayed.
    Optix - DataMosaix Connector Setup
    NOTE:
    If you see a message about needing .NET to run the setup, download and install the latest version.
  6. Specify the exact location of the Optix project by clicking
    Browse
     and provide the project folder path.
  7. Click
    Deploy Connector
    .
    Upon successful completion, you will see a dialog box stating
    'Configuration Completed. Click on Browse Another if you want to configure the connector for another project'.
  8. (Optional) Click
    Browse Another
     to configure the connector for another Optix project.
NOTE:
After setting up the FT Optix - DataMosaix connector, you must restart the FT Optix application for changes to take effect.
Configuring FT Optix to Connect to DataMosaix – Continuation
  1. Restart the FT Optix Studio and open the project.
  2. If you have installed the connector file in the exact location of your Optix project, an FT DataMosaix Store will be created in the FT Optix DataStore. To view it, navigate to the
    Project view
     >
    DataStores
     and click on it to view all the stores created within.
    FT Optix DataStores
  3. Select the
    FTDataMosaixStore
     to view the Properties pane.
  4. In the
    Properties
     pane, provide the following information:
    • PushInstance
      - Provide the instance which needs to be pushed to the Cognite.
      Push Instance
    • ConfigFolderPath
       - Provide the exact path to the downloaded config.yml file.
      NOTE:
      Ensure that the file name 'config.yml' remains unchanged, as altering it may result in failure.
  5. To run the emulator, in the main toolbar, click Run on Emulator []
    The NetLogic security warning dialog box is displayed.
  6. Click
    Proceed
    .
    The project will get saved, and the application will initiate deployment and run the project. The following actions will take place automatically:
    • Asset creation.
    • Subscribe to tags.
    • Creation of flexible data model.
    Tip: In the bottom left corner, navigate to
    Emulator Output
     >
    Messages
     to view the status of actions with the timestamp details.
To Run the Optix Project in Optix Panel Runtime
To run the Optix project in the Optix Panel runtime, the user needs to configure the Optix Panel in FT Optix. Perform the following steps to configure the Optix Panel in FT Optix:
  1. Click the
    Emulator
     drop-down list and click
    Local
    .
    Drop-down Selection
  2. Click the [+] icon to add new target device.
    Add New Target Device
  3. Provide the following details:
    • Name: Provide name of the target device.
    • IP Address: Provide the IP Address of Optix panel
    • Username: Provide the username of Optix Panel.
    • (Optional) Destination Path: Provide the target device deploying destination path.
  4. Select the
    Encrypt project
    ,
    Transfer source project
    ,
    Transfer application files
    , and
    Transfer optimized project
     checkboxes.
  5. Click
    Select
    .
    FTOptixStudio Window
  6. Follow the steps from the above section (
    Configuring FT Optix to Connect to DataMosaix – Continuation
    ).
  7. Place the
    config.yml
     file in the
    project directory > ProjectFiles
     path.
    Copy Config File
  8. Provide the config file path as
    %PROJECTDIR%
ConfigFolderPath
To View Newly Created Assets
  • FactoryTalk Datamosaix: On the Management Console, click the
    Modeling
     tab to view the newly created assets.
    Model Listing
    Tip: If you can’t see the newly created assets on the Model Listing page, click the Refresh [ ] icon to update the page.
  • Cognite Data Fusion: Navigate to
    Data Explorer
     >
    Assets
    .
    Assets
  • When you run the connector, you will see the Flexible Data Models
NOTE:
When the user runs the connector using the extractor config file, the extraction pipeline is updated with the associated dataset to track the extractor's run history and the current status of the pipeline.
Extractor Run History
View Flexible Data Models
Perform the following steps to view the flexible data models:
  1. Click
    Data Models
     from the left pane.
  2. Click any Data Model in the
    Data Models
     section.
    Click Data Models
    The
    Data model
     page is displayed.
    Data Model Page
  3. Click the [] icon to view the expanded view of Flexible Data Model.
    Expanded View
  4. Click the [] icon to view the instances of types.
    View Instances
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.