Getting Started

Overview of the FileGateway

This service consists of a gateway in Predix Cloud, and an agent on the customer premise. Together, they transport files to or from Predix.

It is designed to provide a common transport for batch data that needs to be ingested into APM applications or dispatched to customer systems on the edge. The FileAgent is intended to support a broad spectrum of customer environments, so we offer 4 choices to run it:

  • A Predix Edge Application.
  • A docker image for use on a customer-managed docker environment.
  • A cross platform dotnet core console application.
  • An MSI that will install a windows service.

The tenant in which the user resides should have the FileGateway enabled, and the requesting component should have the credentials to access the service.

The Relationship Between, Data Sources, the FileAgent, the FileGateway, and Cloud Applications.

While specific data sources are shown in the following image, any data source can place files in the folders configured to a FileAgent so that data can be processed by an application in the cloud.



Set Up the Tenant for FileGateway

This topic describes how to set up FileGateway in your GE Digital APM tenant and define a user with the correct permissions that enable the file agents to use the service.

Before You Begin

  • Make sure the FileGateway feature is turned on in your tenant.
  • Make sure the tenant has the Eventhub Service.
  • Make sure the tenant has a dedicated BLOB Store Service.
  • Review the information about Tenant Setup and Users and Permissions.
  • In your tenant, in the Setup page, note the values of the following:
    • Token Request URL
    • Client ID
    • Tenant UUID
    • Ingestor ID

Procedure

  • Set up with Edge Manager.

    Collect information to configure the Agent from your GE Digital APM Setup App.

    Note: For Unified and Essentials tenants, select Admin and select Setup. For legacy APM tenants, it is a top-level item.
    WhatFrom WhereWhy
    GatewayUrlFileGateway URLAppconfig.json, to point the FileAgent at the correct FileGateway
    TenantTenant UUID

    Appconfig.json, to point the FileAgent at the correct tenant

    StufInstanceIdThe Client ID is in the form ingestor.<StufInstanceId>.<another guid>. Capture the GUID in the middleEdge Manager Service configuration, to allow the Edge client to make FileGateway requests

    In your Edge Manager tenant, you will configure a Service and assign it to your devices so Edge Manager can control rights to read/write to FileGateway.

    1. Add a service to Edge Manager with stuf.stufInstanceid.zone scope.
    2. Add either of the following scopes:
      • filegateway.tenantid.read
      • filegateway.tenantid.write
    3. Assign the service you added in step 1 to each Edge device.
  • Set up without Edge Manager.

    Collect information to configure the Agent from your APM Setup App.

    Note:

    In Unified and Essentials tenants, this can be found under Admin->Setup; in legacy APM tenants, it is a top-level item.

    WhatFrom WhereWhy
    GatewayUrlFile gateway URLAppconfig.json, to point the FileAgent at the correct FileGateway
    UAA_URLToken Request URL, not including /oauth/tokenAppconfig.json, to point the FileAgent at the correct UAA
    TenantTenant UUIDAppconfig.json to point the FileAgent at the correct tenant
    OauthClientIDClient IDcredentials.json, part of the UAA Password grant request
    OauthUserNameName of the functional user you will create belowcredentials.json part of the UAA Password grant request
    OauthUserPasswordPassword of the functional user you will create belowcredentials.json part of the UAA Password grant request
    1. Create a Permission set with FileGateway: Read Files or FileGateway: Write Files.
    2. Create a functional user and assign that permission set to it and capture the name and password as above.
      These permissions are not partitioned by asset, but are granted for all resources in the tenant.
      Note: These permissions are not partitioned by asset, they are granted for all resources in the tenant.

What To Do Next

Configure the file agents.