WhanauTahi.Xpm.Tooling.Cli assessmentprep
Create a new Navigator assessment
This command will generate a new Navigator assessment tool with the required fields for integration into the Navigator plan and a default form layout.
A new table (entity) with required fields, a default form, an assessment tool record, and an autonumber record are created.
The resulting tool is ready to use within a Navigator plan, but has no actual assessment data fields; Makers can then add additional columns (fields) to the assessment table and the form to complete the configuration.
NOTE: You must navigate to where the CLI .exe file is, or add it to your PATH. If you add the .exe file to your path, you do NOT need to include the .exe at the beginning of your command.
Example from EXE
.\WhanauTahi.Xpm.Tooling.CLI.exe assessmentprep -e https://mycrm.crm.dynamics.com -s MySolution -n "My New Assessment" -p "My New Assessments" -d "A description of my new assessment"
Example when added to PATH
assessmentprep -e https://mycrm.crm.dynamics.com -s MySolution -n "My New Assessment" -p "My New Assessments" -d "A description of my new assessment"
Required parameters
--EnvironmentUrl
(-e)
The url of the target Dynamics 365 or Power Platform environment that the new assessment will be created in.
--SolutionName
(-s)
The unique name of the solution that will contain the new assessment. You must create the solution before running this tool. The solution must also have a named publisher (we strongly recommend that you do not use the system default publisher). The unique name of the solution is the name without spaces that is listed in the "Name" column of the Power Platform Makers portal (https://make.powerapps.com).
--DisplayName
(-n)
The name of your new assessment. If the name of your assessment contains spaces, place quote marks around the name, e.g. "Transport Questionnaire".
--PluralDisplayName
(-p)
The plural form of your assessment name. E.g. if your assessment display name is "Transport Questionnaire" then the plural display name would be "Transport Questionnaires".
--Description
(-d)
Text to describe your assessment and its purpose. Enclose the description in quote marks. E.g. "Gathers information about the families current transport situation".
Optional Parameters
--ClientId
The client id (a Guid) of the Service Principle Name used to access the Environment Url. If the Whanau Tahi Pipeline Deployment service principal has been set up as an application user in the target environment, this parameter is not required.
--Secret
The secret associated with the ClientId. If the Whanau Tahi Pipeline Deployment service principal has been set up as an application user in the target environment, this parameter is not required. If some other service principal has been used, this must be provided.
Remarks
Considerations and limitations:
The target environment should have the Whanau Tahi Pipeline Deployment service principal configured as an Application User with the System Administrator role. If some other service principal is used, then you must use the
--ClientId
and--Secret
parameters to specify the client id and secret for that service principal.Never specify the Navigator Core solution for the
--SolutionName
parameter.If an assessment is to be added to the core product by Whānau Tahi, create it in a custom solution created with the Whānau Tahi publisher. Whānau Tahi can then incorporate the assessment into the core platform.
Do not run the assessmentprep tool simultaneously to create tools in the same target environment and the same solution name.
The assessment prep tool will take several minutes to run. Do not interrupt the process once it has started. If, for any reason, the process is interrupted, you must manually delete any components created in the target environment and solution.
After a new assessment is successfully created, you would normally do the following:
- Add additional columns to the assessment table.
- Add the columns to the Information form in the assessment table.
- Add or modify views to display relevant information for the assessment table.
- Create or modify a security role to give access to the assessment table. The recommend privileges are: Create (User), Read (Parent-child business unit), Update (Parent-child business unit), Delete (none), Append (Parent-child business unit), Append-to (Parent-child business unit), Assign (User), Share (User). Consider including the security role in the assessment solution so that it can be deployed to other environments along with the assessment.
- You can use the same solution to deploy the assessment to other environments using the Power Apps solution export/import process. Note that when you do this, the assessment tool record and autonumber record are not transferred, and should e manually recreated in the environments you are deploying the assessment to.