Register an Asset Framework (PI-AF) Extractor

Perform the following steps to register an Asset Framework (PI-AF) extractor:
  1. Select the
    Extractor Info
     tab from the left pane.
    The
    Extractor Listing
     page is displayed.
  2. Click the [+] icon from the top-left corner of the page.
    Extractor Info Tab
    The
    Extractor Info Detail
     page is displayed.
    Extractor Info Detail Page
  3. In the
    General Info
     section, provide the following details:
    • Source Name
      : By default,
      FactoryTalk DataMosaix SaaS
       generates a source name. The user can also provide a unique name for the extractor.
      NOTE:
      The Source Name works as the identifier for your extractor. You can search for an extractor with the Source Name. For example: EXT_140623100541786_createproject_v1. Here, EXT stands for extractor, 140623 is the date in ddmmyy format, 100541786 is the timestamp in hhmmssSSS format (SSS represents milliseconds), and createproject_v1 is the project in which you are currently working. You can use the default source name or create your own.
    • Location
       (Optional): Provide the location details for which you are creating the extractor.
      NOTE: This information can help you to identify an extractor when you have many extractors for different plants/sites/locations.
    • Associated Roles
      : By Default, the
      Extractors
       role is selected. You must choose at least one role from the
      Associated Roles
       drop-down list. You can also select multiple roles from the drop-down list. Use the search bar to find a specific role. If you want to apply all roles to the application, select the
      Select All
       checkbox.
      NOTE:
      Click
      Role Reference
       to view various roles and capabilities. 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.
      General Info Section
      In the
      Pipeline
       section, the user can create a new pipeline or use an existing pipeline.
  4. To use an existing pipeline, select the required option from the
    Pipeline Name
     drop-down list. The
    Pipeline External ID
     and
    Dataset Name
     fields are auto populated.
  5. To create a new pipeline, perform the following steps:
    1. Click
      + Create Pipeline
      .
      The
      Create Pipeline
       dialog box is displayed.
      Create Pipeline Dialog
    2. Provide the following Pipeline information:
      • Pipeline Name
        : By default,
        FactoryTalk DataMosaix SaaS
         generates a pipeline name. The user can also provide a unique name for the pipeline.
      • Pipeline External ID
        : By default,
        FactoryTalk DataMosaix SaaS
         generates a pipeline external ID. The user can also provide a unique external ID for the pipeline.
      • Pipeline Description
         (Optional): Provide the description for the pipeline.
    3. When you create a pipeline, you can either use an existing dataset from the
      Dataset Name
       drop-down list or create a new dataset.
      If you want to create a new dataset, click
      Create Dataset
       and provide the following information:
      • Dataset Name
        : By default,
        FactoryTalk DataMosaix SaaS
         generates a dataset name. The user can also provide a unique name for the dataset.
      • Dataset Description
        : Provide the description for the dataset.
    4. 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.
      Create Dataset
  6. In the
    Source Info
     section, perform the following steps:
    1. Select the
      Asset Framework (PI-AF)
       source from the drop-down list.
    2. Provide the Asset Framework Host in the
      Host
       box.
      • Host
        : Name of the server hosting OSIPIAF (this will be localhost or the local machine name if it is on the same machine as the extractor)
  7. Click
    Save and Apply
    .
    Source Info
    NOTE:
    The
    Save and Apply
     button enable only after you provide all the required details.
    The
    Generated info Saved
     dialog box is displayed, and it contains the configuration information. Click
    View generated configuration file
     to view the configuration file details. Click
    Copy All
     to copy and save the information for future.
  8. Click
    Download
    .
    The
    config.yml
     file is downloaded in the Downloads folder of your local machine. It contains all the configuration information needed to run the extractor.
  9. Click
    Close
     to close the dialog box.
    Generated Info Saved Dialog
    The new extractor is displayed in the
    Extractor Listing
     page.
  10. Under the
    Type
     column, click the
    Asset Framework (PI-AF)
     of the newly created extractor, it will be navigated to the Cognite page.
    Select Asset Framework (PI-AF)
    Cognite Page
  11. Download the extractor to your local machine.
  12. Copy the downloaded .yml file to the
    config
     folder where the extractor is installed.
  13. Navigate to the
    PiAFExtractor
    folder and open the command prompt from this folder. Execute the extractor using the command:
    bin\PiAfExtractor.exe
    .
  14. Once the extractor has been configured and executed successfully, navigate to your project in CDF and open the pipeline by selecting
    Integrate
     >
    Extraction Pipelines
    .
  15. Click the pipeline name for which you want to view the details, and then click
    Run History
    .
    You should be able to view the information mentioning that the extractor has run successfully.
    Extractor Success Info
  16. Click on the
    Dataset
     link under basic information section to open the Dataset details.
  17. Click on the
    Data
     tab.
    Click Data Set Link
    You should be able to view the asset data.
  18. To view the time series data ingested using the extractor, click
    Data explorer
    and select
    Time series
    . You will be able to see all the time series data points that were pushed using the extractor.
    Cognite Data Fusion - Time Series
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal