Skip to content

Provider command

The provider command is used post installation, to manage the data Providers that Sidra will process for ingestion.

Usage Options

The usage options are create, import and registerimportsource: 

    .\sidra.exe provider create [parameters]
    .\sidra.exe provider import [parameters]
    .\sidra.exe provider registerimportsource [parameters]
    .\sidra.exe provider [create|import|registerimportsource] --help

1. Create option

Creates a new Provider to be added in a concrete database to the DSU.

Parameters

    --name
Required parameter: the user-friendly reference name of the Provider. The maximum length allowed is 30 characters. 
    --databaseName
Determines the name of the database to be added to the DSU. This is an optional parameter; if missing, the default value will be the same as Provider's --name. The maximum length allowed is 30 characters. 
    --description
An optional description of the Provider. 
    --dsuId
Optional parameter, determining the DSU where the Provider will be created. If a DSU ID is not specified, the default DSU will be used.

Usage example

    .\sidra.exe provider create `
        --name="Sales"

2. Import option

Imports a collection of Providers in an existing Sidra installation.

Parameters

    --destinationTenantId
The GUID identifying the Azure Active Directory tenant of the destination Azure subscription. Required. 
    --sourceInstallationId
The identifier of the source installation. Required. 
    --datafactoryId
The identifier of the Azure Data Factory. Required. 
    --providerItemsId
Determines the IDs of the Provider items. Required.

Usage example

    .\sidra.exe provider import `
        --destinationTenantId="GUIDGUID-GUID-GUID-GUID-GUIDGUIDGUID" `
        --sourceInstallationId="<SOURCE-SIDRA-INSTALLATION-ID>" `
        --datafactoryId="<AZURE-DATA-FACTORY-IDENTIFIER>" `
        --providerItemsId="<PROVIDER-ITEM-IDs>"

3. RegisterImportSource option

Registers a new set of KeyVault secrets to import Providers in an existing Sidra source installation.

Parameters

    --destinationTenantId
The GUID identifying the Azure Active Directory tenant of the destination Azure subscription. Required. 
    --sourceInstallationId
The identifier of the source installation. Required. 
    --sourceSidraCoreApiUrl
Required. The base URL of source Sidra Core API, following the standard Sidra naming convention:
<INSTALLATION_NAME>-core-<ENVIRONMENT>-wst-api.azurewebsites.net

We could have:

  • pcsi: arbitrary string, maximum 4 characters, chosen at Sidra installation (resourceNamePrefix); here, we chose the acronym for PlainConcept Sidra Installation.
  • core: arbitrary string, maximum 4 characters, chosen at Sidra installation (resourceNameMiddle); here, we chose it indicating this is for Sidra Core.
  • dev is the environment name, shortening from development.
  • wst is a hardcoded particle, a fixed string, added automatically at Sidra's deployment, for Sidra's Azure App Services.
  • api is a hardcoded particle, a fixed string, added automatically at Sidra's deployment, signifying API.
  • azurewebsites.net is the common domain name for Azure App Services.

Example: https://pcsi-core-dev-wst-api.azurewebsites.net 

    --sourceIdentityServerUrl
Required. The base URL of source Identity Server, following the standard Sidra naming convention:
<INSTALLATION_NAME>-core-<ENVIRONMENT>-wst-is.azurewebsites.net

We could have:

  • pcsi: arbitrary string, maximum 4 characters, chosen at Sidra installation (resourceNamePrefix); here, we chose the acronym for PlainConcept Sidra Installation.
  • core: arbitrary string, maximum 4 characters, chosen at Sidra installation (resourceNameMiddle); here, we chose it indicating this is for Sidra Core.
  • dev is the environment name, shortening from development.
  • wst is a hardcoded particle, a fixed string, added automatically at Sidra's deployment, for Sidra's Azure App Services.
  • is is a hardcoded particle, a fixed string, added automatically at Sidra's deployment, signifying Identity Server.
  • azurewebsites.net is the common domain name for Azure App Services.

Example: https://pcsi-core-dev-wst-is.azurewebsites.net 

    --sourceTransferClientSecret
The transfer client secret, associated with the source Sidra installation license. This parameter value should be provided by Plain Concepts. Required. 
    --sourceTransferClientId
The transfer client ID, associated with the source Sidra installation license. This parameter value should be provided by Plain Concepts. Required.

Usage example

    .\sidra.exe provider registerimportsource `
        --destinationTenantId="GUIDGUID-GUID-GUID-GUID-GUIDGUIDGUID" `
        --sourceInstallationId="<SOURCE-SIDRA-INSTALLATION-ID>" `
        --sourceSidraCoreApiUrl="https://pcsi-core-dev-wst-api.azurewebsites.net" `
        --sourceIdentityServerUrl="https://pcsi-core-dev-wst-is.azurewebsites.net" `
        --sourceTransferClientId="GUIDGUID-GUID-GUID-GUID-GUIDGUIDGUID" `
        --sourceTransferClientSecret="j6zqsNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNtquda"


Sidra Ideas Portal

Last update: 2022-07-20
Back to top