Date: Fri, 29 Mar 2024 00:17:20 -0500 (CDT) Message-ID: <285911467.30232.1711689440766@PUBEDFIPRDWEB5.public.local> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_30231_455505132.1711689440764" ------=_Part_30231_455505132.1711689440764 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
This section provides general information you should review before insta= lling the Ed-Fi ODS / API Admin App for Suite 3 v2.4.
This version ODS / API Admin App has been tested and can be installed fo= r use with the Ed-Fi ODS / API v3.4 through v5.3. See the Ed-Fi Technology Version Index&= nbsp;for more details.
Admin App supports two deployment modes: Docker Deployment and On-= Premise Installation, as documented below. Please choose the deployme= nt mode that fits your environment.
Docker image for Admin App 2.4 is = available at: https://hub.docker.com/r/= edfialliance/ods-admin-app
Please refer Docker Deployment - Ed-F= i Tools - Ed-Fi Tech Docs for more details.
The following are required to install the Admin App:
Below are links to Nuget packages containing the Admin App Installer or =
App Binaries. Download from the link and rename the file extension to=
.zip,
or use the PowerShell command from Step 1 below.
Admin App for Suite 3 v2.4 (for automated installations):<= /strong>
EdFi.Suite3.Installer.AdminApp.2.4.12.nupkg
Admin App v2.4 Binaries (for manual installations):
The following link contains pub= lished image:
Admin App does not today support in-place upgrades from prior versions.&= nbsp; Please install a fresh copy of Admin App to upgrade from prior versio= ns.
Required Information
You will need the following information to complete this installation:= p>
This section provides step-by-step instructions for installation. The sp= ecific steps are different depending on the deployment model and version of= your Ed-Fi ODS / API.
Each step is outlined in detail below for the PowerShell deplo= yment. Ensure that you have permission to execute PowerShell scripts.&= nbsp;For more information, see http://go.microsoft.com/fwlink/?LinkID=3D135170.
Download , rename the file extension from to .zip
and=
unzip the package
Alternatively, run the below PowerShell command to download the package = as a zip file directly:
#= Installer Invoke-WebRequest "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance= -OSS/_apis/packaging/feeds/EdFi/nuget/packages/EdFi.Suite3.Installer.AdminA= pp/versions/2.4.12/content?api-version=3D6.0-preview.1" -OutFile .\EdFi.Sui= te3.Installer.AdminApp.2.4.12.zip # Web App Binaries Invoke-WebRequest "https://pkgs.dev.azure.com/ed-fi-alliance/Ed-Fi-Alliance= -OSS/_apis/packaging/feeds/EdFi/nuget/packages/EdFi.Suite3.ODS.AdminApp.Web= /versions/2.4.48/content?api-version=3D6.0-preview.1" -OutFile .\EdFi.Suite= 3.ODS.AdminApp.Web-2.4.48.zip
Open the "install.ps1" file in a text editor. You will need to edit this= file with your configuration details. If a value is not present for any of= the parameters, it will use its default value.
Note: Editing Item 3b below is mandatory for ODS / API URL and m= ust be done for installation to complete.
$dbConnectionInfo
. These value=
s are used to construct the connection strings.=20
Server
. The name of the database server. For a loc=
al server, we can use "(local)" for SQL and "localhost" for PostgreSQL.
Engine.
Admin App supports SQL and PostgreSQL database eng=
ines. So setting up the Engine
will decide which database engi=
ne to be used. Valid values are "SQLServer" and "PostgreSQL".UseIntegratedSecurity.
Will either be "$true" or "$fa=
lse".=20
Password
must be provided.
Username
. Optional. The username to connect to the databas=
e. If UseIntegratedSecurity
is set to $true, this en=
try is not neededPassword
. Optional. The password to connect to the databas=
e. If UseIntegratedSecurity
is set to $true, th=
is entry is not neededPort.
Optional. Used to specify the database server p=
ort, presuming the server is configured to use the specific port.$adminAppFeatures
. These values are used to=
set Optional overrides for features and settings in the web.config.=20
ApiMode.
Possible values: sharedinstance
=
, districtspecific
and yearspecific
. Defaults to =
sharedinstance
SecurityMetadataCacheTimeoutMinutes
. Optional. Defaults to=
10 minute security metadata cache timeout.$p
. This is the variable used to send all the in=
formation to the installation process.=20
ToolsPath
. Path for storing installation tools, e.g.,=
nuget.exe. Defaults to "C:/temp/tools"OdsApiUrl
. Base URL for the ODS / API. Mandatory.<=
/strong>AdminDatabaseName
. , OdsDatabaseName
, S=
ecurityDatabaseName
. Optional. Specify only if ODS / A=
PI was set with a custom database name.=20
OdsDatabaseName
, the val=
ue here will be the name of the ODS database, whereas the AdminDataba=
seName
and SecurityDatabaseName
will be the name o=
f the Admin and Security databases, respectively.WebApplicationName.
Optional. Defaults to "AdminApp".WebSitePort
. Optional. Defaults to 443.WebsiteName
. Optional. Defaults to "Ed-Fi".PackageVersion
. Optional. If not set, will retrieve t=
he latest full release package.Configuration samples for the "= install.ps1" file:
<= /a>SQL Server Shared Instance
$= dbConnectionInfo =3D @{ =09Server =3D "(local)" =09Engine =3D "SqlServer" =09UseIntegratedSecurity =3D $true } $p =3D @{ =09DbConnectionInfo =3D $dbConnectionInfo =09OdsApiUrl =3D "https://localhost:54746" }
PostgreSQL District Specific
$= dbConnectionInfo =3D @{ =09Server =3D "localhost" =09Engine =3D "PostgreSQL" =09Username =3D "exampleAdmin" =09Password =3D "examplePassword" } $adminAppFeatures =3D @{ =09ApiMode =3D "districtspecific" } $parameters =3D @{ =09DbConnectionInfo =3D $dbConnectionInfo OdsApiUrl =3D "https://localhost:54746" AdminAppFeatures =3D $adminAppFeatures }
SQL Server Year Specific
$= dbConnectionInfo =3D @{ =09Server =3D "(local)" =09Engine =3D "SqlServer" =09UseIntegratedSecurity =3D $true } $adminAppFeatures =3D @{ =09ApiMode =3D "yearspecific" } $p =3D @{ =09DbConnectionInfo =3D $dbConnectionInfo =09OdsApiUrl =3D "https://localhost:54746" AdminAppFeatures =3D $adminAppFeatures }
Method 1: Open [Windows Key]-R which will open a Run dialog for tasks ne= eding administrative privileges. Type "PowerShell" to open a PowerShell pro= mpt in Administrator mode.
Method 2: Click on the Windows icon in the lower-left corner. Type "Powe= rShell" and right-click the "Windows PowerShell" option when provided. Sele= ct "Run as Administrator" to open a PowerShell prompt in Administrator= mode.
Change the directory to the unzipped directory for the Admin App Install= er.
Run "install.ps1" script.
During the installation process, you will be prompted to choose database= login details. Entering "Y" will continue with default option( Installatio= n process will create IIS APPPOOL\AdminApp database login on the server).= p>
Choosing 'n' will prompt you to enter windows username. The installation= process will validate and create database login using entered username, if= the login does not exist on the database server already.
Please refer Steps 5 and 6 for mor= e details on verifying the database login and setting up the application po= ol identity.
The PowerShell output will look something like the following:
This step only needs to be completed if you set useIntegrated=
Security
to true on the "install.ps1" script in Step 2, above. If yo=
u did not, we can skip ahead to Step 5.
The installation process sets up a= n appropriate SQL Login for use with the dedicated AdminApp Application Poo= l in IIS. You can verify this in SQL Server Management Studio:
On the Server Roles page, make sur= e that "public" and "sysadmin" checkboxes are checked. Once you have = confirmed a proper SQL Server login exists, continue to the next step. = ;
=
As mentioned on Step 5, installation process sets up an appropriate SQL = Login for use with the dedicated AdminApp Application Pool in IIS. If you w= ould like to use the default "ApplicationPoolIdentity", then you can skip t= his bit.
Else in the same Advanced Settings window, click on the browse icon unde= r Process Model > Identity. We'll choose the custom account option and c= lick "Set...". When setting the credentials, you can just use the username = and password that you use to log in to Windows. If you need to include the = app pool domain in the username, then the username can look something like = this: "localhost\username", where "localhost" is the app pool domain. Once = we have entered the correct credentials, we'll click OK on all screens unti= l we're back to the main Application Pools page.
Folders to verify:
For checking permissions:
If the AdminApp not available on the list, add with Full control.
Note: If you choose custom login over default Application Pool Identity = ( Refer Step 6 for more details), then make sure the custom login has full = control on the above mentioned folders.
Upon first launch of the Admin App, you will have to create the initial = administrative user for the application. This consists of creating a u= sername and password for the initial user. Additional users can be add= ed at a later time. Please see Securing the Admin App (v2.x) for more informat= ion.
Upon first launch of the Admin App, you will have the option to opt-out = of the Product Improvement feature for the application (th= e user is opted-in by default). Opting-in to this feature allows the applic= ation to collect useful telemetric data, page views and usage data of the p= roduct, as we do with Ed-Fi.org and other Ed-Fi web sites. Admin App also pr= ovides an option to opt-in/out at a later time using the Configuration scre= en in the application. Please see _Product Improvement for more information.
Admin App 2.4 Deep Disable of Product = Improvement
Starting with Admin App 2.4, Product Improvement can be disabled at=
the AppSettings level, by setting the EnableProductImprovementSettin=
gs
setting to false
. Doing so=
will disable Product Improvement, skip the above screen at startu=
p, and remove the "Configuration" screen to prevent future changes to the s=
etting. If Product Improvement was previously enabled before this flag was =
set to false
, it will become disabled. To restore the ability to set the Product Improvement configuration, change=
`EnableProductImprovementSettings
back to true
.=
Note: This step is only for ODS / API versions is 3= .4 through 5.2. ODS / API versions 5.3 and higher do not require a se= rvice restart.
To finish the Admin App on-premises setup, the ODS / API should be resta= rted, which Admin App will advise.
Steps for restarting the ODS / API:
The installation will default to "https://<machinename>/AdminApp".=
To verify and launch the Admin App, open "Internet Information Services = (IIS) Manager". Open the server name, open the Sites folder and open the Ed= -Fi branch. Observe three web applications have been installed for the Ed-F= i Tech Suite. Clicking on "AdminApp", use Manage Application to view the co= nfigured URL. Click on "Browse <servername>" to launch Admin App.
The Admin App is now configured for use with your Ed-Fi ODS / API instan= ce. Please visit the following articles to help with next actions in using = Admin App:
Admin App also has a User Gui= de for an in-depth look at each of the features contained within.<= /p>