Server Integration

The DataPrep Export element in Automator’s Visual Process Designer allows data to be exported in various formats. Before exporting, the server settings need to be modified. Use the Server Integration page to configure the settings for the following:

SERVER

REQUIRED FIELDS

HTTP Credentials

  • Username
  • Password

FTP Credentials

  • Username
  • Password

Microsoft Azure

  • Account Name
  • Account Key

NOTE: Objects can also be imported from and exported to Azure Data Lake Storage Gen2 and Azure Blob Storage via Azure Active Directory authorization.

Additional Steps:

  1. Click the Set Active Directory Credentials button.
    A new tab displaying Microsoft’s sign in portal is opened.
  2. Sign in using your credentials.
    Back in the Server Integration page, either of the following messages are displayed:
  • Successful authorization: Login data have been successfully updated.

  • Failed authorization: Timeout for updating Login Data. Please try again.

  1. Click the Update Active Directory Credentials button to modify the cached credentials or the Clear Active Directory Credentials button to remove the cached credentials.

Amazon S3

  • Access Key
  • Secret Key

Oracle Cloud Infrastructure

  • Access Key
  • Secret Key
  • Endpoint URL

Google Cloud Storage

  • Access Key
  • Secret Key

Microsoft Power BI API

  • Client ID
  • Client Secret Key
  • Host Name
  • Port
  • Redirect URL

For further details, click here.

Microsoft Azure Storage API

  • Client ID
  • Client Secret Key
  • Host Name
  • Port
  • Redirect URL

To modify the server settings

To modify the server settings

  1. On the Navigation Tree, click System Settings, and then select System Preferences.

  2. At the top of the page under Automator Settings, select the Server Integration tab.

  3. Modify the required server settings.

  4. Click Save to apply the settings or Clear to start over.

 

Microsoft Power BI API Settings

For the settings of Power BI, the following details should be provided:

NOTE: To get the Client ID for Power BI, click here.

NOTE: To get the Client Secret Key for Power BI, click here.

Power BI API Keys and Application Registration

NOTE: The following steps were documented on May 16, 2022, using Power BI Service 13.0.18218.51.

 

The integration with Power BI is divided into two phases:

The registration of the application will allow also allow you to generate a Client ID, which is required in the integration with Power BI.

The related steps for Phase 1 and Phase 2 are presented below.

PHASE 1

To register the Automator application using the Power BI Embedding Tool

  1. Access https://app.powerbi.com/embedsetup. From the choices of embedding solution, select Embed for your customers.

NOTE: The registration process in Power BI requires an Azure Active directory, an organizational user, and a Power BI service account. To sign up for an Azure subscription or to log in using an account with such subscription, click here.

To learn how set up your Azure Active Directory and organizational user, click here.

 

  1. Sign in using your Power BI account in Step 1 of the  Embedding Setup tool, and then click Next.

 

  1. In Step 2: Register your application, provide the following details:

    1. Application Name – The name of your app, i.e., Automator.

    2. API access – Select the APIs you need as well as the level of access required. For details about permissions in Power BI, click here.

 

Click Register. You may opt to skip Steps 3 and 4 of the Embedding Setup tool at this point.

  1. In Step 5 of the Embedding Setup tool, click Grant permissions. This shows the permissions requested for the application.

  2. Click Accept.

 

To register the Automator application using Azure Active Directory

  1. Open the Azure Portal at https://portal.azure.com.

  2. In the list of Azure Services, click Azure Active Directory.

 

  1. Navigate to App registrations and click the New Registration button. Proceed with the registration of your application.

 

  1. Navigate to page of the registered application by clicking its corresponding name from the list of App registrations.

  2. Configure the application’s API permissions. In the application’s page, click API permissions from the left panel, and then click the Add a permission button.

  3. Navigate to the Power BI Service, and click Delegated permissions to request API permissions.

PHASE 2

To get a Client Secret key for Power BI

  1. Access Microsoft Azure to view your app registrations by clicking here.

  2. In the Owned applications tab, click the display name of your registered app (e.g., Automator2021) to view its properties, including the Application ID generated previously.

 

  1. In the Overview pane of the app page, click Add a certificate or secret.

 

  1. In the Certificates & secrets pane, open the Client secrets tab and create a new secret key by clicking +New client secret.

 

  1. In Add a client secret, provide a description for the secret key, and set its expiration.

The Client secrets tab should now show the newly created client secret. The text combination under the Value column serves as the client secret key.

NOTE: The following steps should be performed to complete the integration:

  1. After generating the client ID and secret key, input them in the corresponding fields in the Server Integration pane of Automator settings under System Settings. Then, enter the host name and port. The Redirect URL field should now be populated with the redirect link.

  2. In Microsoft Azure, access the Authentication pane of the app page, and click Add URI to input the redirect URL generated in Monarch Server.

  3. Click Save.