Skip to main content

Parameters

Parameters are required at various stages in the process. For example:

  • Azure subscription ID
  • SharePoint site URLs
  • Azure resource names
  • App registration IDs

Some values will be provided by or agreed with the client in advance of the deployment.

Others such as App registration IDs are generated during the deployment and should be captured for use in later stages and providing to the Pro-Sapien team.

Most values are specific to the instance of Pro-Sapien being deployed:

  • UAT (test)
  • Production (live)

Deployment parameters workbook​

Pro-Sapien will provide a Deployment Parameters Excel workbook to capture parameters before and during the deployment.

The Excel workbook defines "tags" for parameters which will be used throughout this documentation to refer to the value. For example, {SharePoint-Site-Url} is used for the SharePoint Site URL.

warning

IMPORTANT: the following parameters are confidential and should be sent by secure transmission only:

  • Pro-Sapien Entra ID App Client Secret {Entra-App-ClientSecret}
  • Pro-Sapien Entra ID App Certificate Private Key {Entra-App-PrivateKey}

Web app domain​

The Web App domain name (FQDN) is required to be known in advance of creating the Entra ID app registration.

If a custom domain is being used, this should be the fully qualified custom domain.

If not, this should be the {Web-App-Name}.azurewebsites.net domain.

The Web App domain will be referred to in documentation with the tag {Web-App-Domain}.

It is critical the correct domain is used when creating the Entra ID app registration.

Azure resources​

To facilitate identification of Azure objects and distinguish environments it is recommended a naming convention is selected and adhered to. Once selected, Pro-Sapien can review and confirm next steps for resource creation.

See the following Microsoft documentation for guidance: