APSD Deployment Guide

Click Solutions → APSD → ... → Switch to classic

1. Go to the https://admin.powerplatform.microsoft.com/environments.

2. Select the environment you wish to reset.

3. Click on Reset in the top menu bar.

4. Ensure that the Name and URL are correct (this is the time to change it if required).

5. Change the Currency to CAD ($).

6. Click Reset. It will take 15-20 minutes for the refresh to finish.

7. Once complete, click on the environment name to view its details.

8. Click on Edit in the top right corner of the Details section.

9. Ensure that Administration mode is disabled (otherwise, only system admins will have access).

10. Grant system administrator access to other developers as needed (see next section).

1. Go to https://admin.powerplatform.microsoft.com/environments/d4af4054-dad9-431a-8a39-527b4b690886/securityroles/d875496e-3318-ec11-b6e5-000d3a09d85b/members and select the desired environment.

2. In the Access section, click See all under Security roles.

   

3. Scroll down to desired role and click on it.

   

4. Click + Add people, search for the user then click Add.

App Registration

Must be added as an application user in the PowerApps environment in order to access NAPA API (security controls). Also required for pipelines and as a service principal account in APSD (Dataverse connection).

APSD-PAPS-USERS Group

Used as a security group for the Canvas app as well as for the SharePoint translation list.

Key vault

Used for NAPA-SNAPA API secrets and MTOA JWT token.

If a new security role needs to be created, open an existing role and select Copy Role.

1. Clone the APSD-PAPS repository to your local computer.

2. On the left hand menu, navigate to Data → Custom Connectors.

3. Click on + New custom connector → Import an OpenAPI file.

4. In the Connector name field, type “NAPA-SNAPA”.

5. Click Import and go to \repos\APSD-PAPS\Custom Connectors\JSON and select the NAPA-SNAPA.json file.

6. Click Continue.

7. Verify that the Host and Base URL point to the correct location for the environment you are in (refer to chart below).

8. For NAPA API only: Set up OAuth security

9. Click Create connector.

10. Click on the Test tab, then + New connection.

11. Enter the API Key (RDIMS 17999814) and click Create connection.

12. Repeat steps 3-10 to create the rest of the connectors using their json files (SIAPI, SPAPI, MTAPI & TMAPI). *Note: SIAPI doesn’t require an API Key.

13. On the left hand menu, navigate to Data → Connections.

14. For each connection, share them with the organization.

    • Click ... → Share → + Add everyone in my org → Save.

    • This must be done so that any changes to the API Key get shared to all users. The update should be instant, if users are not receiving the updated key, they will need to clear their browser’s cache.

    • Give edit access to TC-CivAv Azure group.

      

This must be done in order for the pipeline & for the flows to work (we are using Service Principal account to connect to Dataverse).

1. Go to the Power Platform admin center.

2. Select the new environment.

3. In the Access section, click on See All under S2S Apps.

   

4. Click + New app user.

5. Click + Add an app and enter in the App ID in the search bar.
   CivAv-APSD-PAPS: 27b29278-594f-484d-a0c0-9c61381bad31

   

6. For the business unit, select the one with the environment name.

7. Edit the security roles and select System Administrator and System Customizer.

8. Click Create.

1. Open the Power Apps Studio and click on Flows in the side menu.

2. Click + New flow > Instant cloud flow.

3. Select Manually trigger a flow, then Create.

4. Click + New step > Microsoft Dataverse > select any action.

5. Click on the … and +Add new connection.

6. Click Connect with service principal.

7. 

   The connection name should be “CivAv APSD Service Principal”. The rest of the info is in RDIMS 17999814.

8. Click Create.

9. Click on Connections in the side menu (don’t save the flow). You can now see the new connection.

   

10. Delete any other connections that were created.

1. Go to https://myaccount.microsoft.com/, click on your profile icon in the top right corner and select Sign in with a different account.

   

2. Click + Use another account.

3. Log in to DoNotReplyAPSD-NePasRepondrePAPS@tc.gc.ca (info in RDIMS 17999814).

4. In the same browser, go to Power Apps Studio.

5. Click on Data/Dataverse > Connections in the side menu.

6. Click on + New connection and select Office 365 Outlook.

7. Click Create and select the Do Not Reply APSD account that you signed into in Step 3.

8. Repeat Steps 6-7 for the Office 365 Groups and Excel Online (Business) connections.

You should now have the following connections set up

1. Open the Power Apps Studio and select the ap-dev-tcd365 environment.

2. Click on Solutions in the side menu, then click Publish all customizations in the top menu bar.

3. Select the APSD solution.

4. Click Export → Next.

5. Increase the version number as needed (revision # is automatically increased) and ensure Export as Managed is selected, then click on Export.

6. Repeat steps 3-5 with the APSD-PAPS Admin solution.

7. Repeat steps 3-5 with the APSD-PAPS Env Variables, APSD-PAPS Flows and APSD-PAPS Custom Connectors solutions but export them as Unmanaged.

1. Go to the desired environment.

2. Once the Env Variables solution has been imported

   • Edit the variables to ensure they have the correct values for the environment

3. Once the Custom Connectors solution has been imported

   • Clone the APSD-PAPS repository to your local computer.

   • Go into the APSD-PAPS Custom Connector solution. **Must be done from within the solution to ensure that the same name is generated (ap_5Fnapa-2Dsnapa).**

   • Click on + New > Automation > Custom connector

     

   • Enter in the info as follows:

     • Connector Name: NAPA-SNAPA

     • Host: www

   • Click Create connector.

   • Return to the APSD-PAPS Custom Connector solution and verify the name of the connector is ap_5Fnapa-2Dsnapa.

   • On the left-hand menu, click on Data/Dataverse > Custom connectors.

   • Beside the NAPA-SNAPA connector, click ... > Update from OpenAPI file.

     

   • Click Import and go to \repos\APSD-PAPS\Custom Connectors\JSON and select the NAPA-SNAPA.json file.

     • Use the NAPA-SNAPA [PROD].json for Production environment

   • Click Continue.

   • Toggle the Swagger Editor ON > OFF.

   • Go to the Security tab and enter in the information as per RDIMS 17999814.

   • Click Update connector.

   • Click on the Test tab, then + New connection.

   • Click X Close.

   • For the rest of the connectors, edit them and go to the Test tab, then click + New connection (API key are in RDIMS 17999814).

   • On the left-hand menu, click on Data/Dataverse > Connections.

   • For the MTAPI, SPAPI & TMAPI connections, share them with the organization.

     • Click ... → Share → + Add everyone in my org → Save.

       • This must be done so that any changes to the API Key get shared to all users. The update should be instant, if users are not receiving the updated key, they will need to clear their browser’s cache.

     • Give edit access to TC-CivAv Azure group.

       

4. Import the APSD solution

5. When importing the Flows solution

   • Click Next twice then select the CivAv APSD Service Principal connection for Dataverse and the shared connections for the APIs.

   • For the Office 365 and Excel Online connections, select the Do Not Reply APSD / Ne Pas Répondre PAPS connection created earlier.

     

6. Click Import and wait for the process to finish.

7. Click on Publish all customizations.

8. Verify that all the required flows are turned on. If any are off, follow the steps at the end of this section.

9. Share the APSD-PAPS Canvas App with Everyone in TC. Uncheck the box at the bottom “Send an email invitation to new users”.

   

10. Share the Canvas apps with the other developers individually, checking off the co-owner box.

11. PROD ONLY: Edit the APSD-PAPS Canvas App. Go into the App.OnStart() and edit the MTOA JWT token to the Production one.

12. Assign a security role to yourself in order to test the application.

    • Can be done through Advanced Settings or the Admin center (see Granting security roles to users section).

      

If any of the flows are off:

If ‘Modify Users’ flow is off, turn on ‘Remove User’ and ‘Update User’ flows first (if not already on).

1. Select the flow and click Turn on.

2. If there is an error, select the flow and click Edit.

3. If you are brough to a screen asking to confirm the flow connections, ensure all are using the connection references inside the solution then click Continue.

   

4. Once you are brought to the flow screen, click Save.

5. Steps 6 - 9 are only for certain flows (e.g. those with a manual trigger).

6. Go back to the solution and click on the flow name to view its details.

7. Click on Edit in the Run only users section.

   

8. Ensure that all the connections are using the generic account connections and NOT “Provided by run only user”.

   

9. Click Save.

10. Click Turn on.

11. Repeat steps 1-10 for any other flows that are not on.

1. Open the Power Apps Studio and select the ap-dev-tcd365 environment.

2. Select the solution you need to migrate.

3. Click Export → Publish → Next.

4. Increase the version number as needed (revision # is automatically increased).

5. Select corresponding export as type, then click on Export.

   • Managed: APSD, APSD-PAPS Admin, DataVerse-Security Role

   • Unmanaged: APSD-PAPS Flows, APSD-PAPS Custom Connectors, APSD-PAPS Env Variables

6. Download the exported file.

7. Repeat steps 2-6 for any other solutions required.

1. Go to the desired environment.

2. Click on Solutions on the left-hand menu and then Import in the top menu bar.

3. Select Browse and point to the zip file, e.g. APSD_PAPS_EnvVariables_1_0_0_X.zip, created in the export solution steps.

4. Click Import and wait for the process to finish.

5. Import the rest of the solutions as needed.

6. Click on Publish all customizations.

7. Verify that all the required flows are turned on.

If any of the flows are off:

1. Select the flow and click Turn on.

2. If there is an error, select the flow and click Edit.

3. If you are brough to a screen asking to confirm the flow connections, ensure all are using the connection references inside the solution then click Continue.

   

4. Once you are brought to the flow screen, click Save.

5. Steps 6 - 9 are only for certain flows (e.g. those with a manual trigger).

6. Go back to the solution and click on the flow name to view its details.

7. Click on Edit in the Run only users section.

   

8. Ensure that all the connections are using the generic account connections and NOT “Provided by run only user”.

   

9. Click Save.

10. Click Turn on.

11. Repeat steps 1-10 for any other flows that are not on.

If importing the APSD Custom Connectors solution:
Even if there are no edits to make, you must still go in to edit it and click on Update Connector for it to connect properly.

1. Go to the environment that has the master set of data for the SCRAM tasks. Currently, this is QA.

2. On the left menu, go to Data → Tables, then open the Scram Tasks table.

3. On the top menu, click on Data → Export data. Once the export has been successfully completed, click on Download exported data.

4. Unzip the csv file.

5. Switch to the environment you are deploying to.

6. On the left menu, go to Data → Tables, then open the Scram Tasks table.

7. On the top menu, click on Data → > beside Get data → Get data from Excel.

   

8. Upload the csv file from step 4. If there are any mapping issues, fix them.

   

9. Click Import. Wait for the process to complete, then verify that the data was imported.

Follow the same steps using the AP Task table instead.

1. Open the details screen of the flow you wish to copy.

2. Click the Save As button.

3. Give it a new name, and click Save.

4. Go to your My Flows section, and the new flow should be there in a disabled state.​

5. Go into the details page, and click Edit.

6. Delete the Manually Trigger a Flow trigger.

   • Note: This will delete any variables which this trigger contained

7. ​Select the Power Virtual Agents > When Power Virtual Agents calls a flow trigger.

   • We use this as it requires no inputs to be defined.

8. ​Save the flow.

9. Go back to the Solutions section and select the solution into which you want to import the copied flow.

10. Click Add Existing > Flow > Outside Solutions.

11. Select your flow and click Add.​

12. Edit the flow and swap out the trigger with the Manually Trigger a Flow trigger.

13. Fix any trigger variables which were wiped out during the copy operation.

https://powerusers.microsoft.com/t5/General-Power-Automate/Add-existing-flows-to-Solutions/td-p/258103/page/2

Name: Timesheet rejected - Send email notification

Description: This Power Automate Flow triggers when the “ap_timesheetstatus” field is modified to “Rejected”. The flow sends an email to the submitter.

Name: Expense rejected - Send email notification

Description: This Power Automate Flow triggers when the “ap_expensestatus” field is modified to “Rejected”. The flow sends an email to the submitter.

Name: Invoice rejected - Send email notification

Description: This Power Automate Flow triggers when the “ap_invoicestatus” field is modified to “Rejected”. The flow sends an email to the submitter.

Name: Push Approved Time Entries To CRSM (TMAPI)

Description: This Power Automate Flow triggers when the “ap_timsheetstatus” field is modified to “Approved”. The flow uses the “TMAPI” custom connector, specifically the following end points: 

1. Add a time entry

   1. To add a time entry, the flow gets all the rows where the current timesheet is approved from the “Time Entries” table filtered via a FetchXML query to only get the rows where “Added to CRSM” is false and hours are not empty or null. Here’s the query:
      

      <fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
        <entity name="ap_timeentry">
          <attribute name="ap_timeentryid" />
          <attribute name="ap_timeid" />
          <attribute name="createdon" />
          <order attribute="ap_timeid" descending="false" />
          <filter type="and">
            <condition attribute="ap_addedtocrsm" operator="eq" value="0" />
            <condition attribute="ap_timesheet" operator="eq" uitype="ap_timesheet" value="{@{triggerOutputs()?['body/ap_timesheetid']}}" />
            <condition attribute="ap_employeelogin" operator="eq" value="@{triggerOutputs()?['body/ap_employeelogin']}" />
            <condition attribute="ap_timecard" operator="eq" value="@{triggerOutputs()?['body/ap_reportingperiod']}" />
            <condition attribute="ap_timeentryhours" operator="not-null" />
          </filter>
        </entity>
      </fetch>

   2. Create a time entry record in the CRSM database.
      

      

2. Add hours to time entry

   1. This endpoint is used to create a record for adding hours for the time entry that was created in the previous step. Depending upon the “ap_timeentrytype” i.e. “Regular”, “Travel” or “Other”, corresponding action is called. 

      

3. At the end of the flow, the flag “Added to CRSM” is set to true in the Time Entries table. 

Push Time Entry to CRSM Step inside flow

TypeCode: Regular (REG), Travel (TH), Other (DH)

[
  {
    "ServiceRequestId": @{int(variables('ServiceRequestID'))},
    "ServiceId": @{outputs('Get_a_row_by_ID')?['body/ap_serviceid']},
    "ApproverNetworkId": @{triggerOutputs()?['body/ap_approvedby']},
    "Comment": @{items('Apply_to_each_-_Push_to_CRSM')?['ap_comments']},
    "SubmitterNetworkId": @{items('Apply_to_each_-_Push_to_CRSM')?['ap_employeelogin']},
    "DateTime": @{items('Apply_to_each_-_Push_to_CRSM')?['ap_timeentrydate']},
    "Hours": [
      {
        "Quantity": @{items('Apply_to_each_-_Push_to_CRSM')?['ap_timeentryhours']},
        "TypeCode": "REG",
        "IsBillable": @{items('Apply_to_each_-_Push_to_CRSM')?['ap_billable']},
        "StatusCode": 2
      }
    ]
  }
]

Name: Import User's Role & Manager (from Excel file)

Description: This Power Automate Flow can be manually triggered to import users from an Excel file (see screenshot below) into the Dynamics 365 “Users” table in the target environment. The Flow also associates users with their managers as listed in the Excel file and assigns them the roles as per the Excel file. This Excel file can be stored on the executing user’s OneDrive.  

1. Edit the APSD-PAPS Canvas app.

2. When prompted, select Don't Allow.

3. 

   Remove all connections that are showing as not connected - 5 connections (APSR, MTAPI, SIAPI, SPAPI, TMAPI), Office365Users and APSD_Translations.

   

4. Add all of them back.

   

5. SharePoint data connector: for APSD_Translation file. In the box enter the following URL: https://034gc.sharepoint.com/sites/DSD-CivilAviation/Lists/APSD_Translations/AllItems.aspx

   

6. Check off the APSD_Translations list & click Connect.

   

7. Run the App Checker and ensure no errors are reported.

   

8. Turn on “Allow searching” in the properties for the following elements:

   • New Service Request Step One Screen - cboNapaProject element

     

   • New Service Request Step Three Contact Info Screen - cboFindOrganizationAlt element

     

   • Service Request Review Screen - ddSRRChangeReAssignment element

     

   • New Invoice Step One Screen - cboInvoiceCustomer and cboCustomerAddress elements

     

   • Weekly Time Entry Normalized Screen - cmbProject

     

9. Save and Publish the app.

There is a bug with D365 that doesn’t allow sharing of custom connectors if they are included in a solution. This means that other developers cannot edit the custom connector.

Workaround: https://youtu.be/ROKO589RBnQ

1. Go to Data → Tables → Connector table → Data tab.

2. Select the connector and click on Edit Record.

3. Click SHARE → Add User/Team → Select Team in the Look for dropdown.

4. Check off the team that is named after the environment.

5. Click Select → Add.

6. Ensure that they only have Read access (for other users, refer to chart below).

   

7. Click Share.