Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HDS fabric git integration sample #257

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

EvanJMiller
Copy link

Adding a git integration migration sample for Healthcare data solutions for Fabric.

README.md Outdated
@@ -86,6 +86,12 @@ This project provides samples outlining example implementations of various use c
|------|-----------|
|[MedTech service mappings](/samples/medtech-service-mappings/)|The [MedTech service](https://learn.microsoft.com/azure/healthcare-apis/iot/overview) scenario-based samples provide conforming and valid [device](https://learn.microsoft.com/azure/healthcare-apis/iot/overview-of-device-mapping) and [FHIR destination](https://learn.microsoft.com/azure/healthcare-apis/iot/overview-of-fhir-destination-mapping) mappings and test device messages to assist with authoring and troubleshooting mappings.|

### Healthcare data solutions on Fabric

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Healthcare data solutions in Microsoft Fabric

@@ -0,0 +1,21 @@
# Microsoft Fabric Healthcare Data Solutions Git Integration Helper

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Healthcare data solutions in Microsoft Fabric ALM Helper"

Since it's not just for git it's also deployment pipelines.

README.md Outdated

|Sample|Description|
|------|-----------|
|[Git integration helper](/samples/fabric-healthcare-data-solutions/sample-notebooks/git_integration_helper.ipynb)|[Healthcare Data Solutions (HDS)](https://learn.microsoft.com/en-us/industry/healthcare/healthcare-data-solutions/overview) in [Microsoft Fabric](https://learn.microsoft.com/en-us/fabric/get-started/microsoft-fabric-overview) supports version control through [Application Lifecycle Management (ALM)](https://learn.microsoft.com/en-us/fabric/cicd/git-integration/intro-to-git-integration?tabs=azure-devops). This sample notebook allows for seemless migration of a Healthcare data solution item that is checked into version control to be migrated into another Fabric workspace.|

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"ALM helper" instead of "Git integration helper"

It's also not doing anything with version control right? It's pulling from a "source workspace" so could say "This sample notebook allows for seamless migration of the Healthcare data solution item dependencies from a source workspace." ?


## Overview

Healthcare data solutions in Microsoft Fabric help you accelerate time to value by addressing the critical need to efficiently transform healthcare data into a suitable format for analysis. With these solutions, you can conduct exploratory analysis, run large-scale analytics, and power generative AI with your healthcare data. More information about Healthcare data solutions on Fabric can be found [here](https://learn.microsoft.com/en-us/industry/healthcare/healthcare-data-solutions/overview).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Healthcare data solutions in Microsoft Fabric"


This sample provides a notebook for customers who have already deployed their Healthcare data solutions item in Fabric and want to take advantage of Application Lifecycle Management (ALM). ALM allows developers who are developing in Fabric to apply the capabilities of familiar source control tools to manage Fabric items.

There are some additional, manual steps to be able to run Helathcare data solutions capabilities after syncing a workspace with ALM. The `git_integration_helper` attempts to streamline these manual steps.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Call it "hds_alm_helper"?


## Prerequisites

For this sample, it is assumed that you have already deployed an instance of Healthcare data solutions and one or more capabilities following [these steps](https://learn.microsoft.com/en-us/industry/healthcare/healthcare-data-solutions/deploy?toc=%2Findustry%2Fhealthcare%2Ftoc.json&bc=%2Findustry%2Fbreadcrumb%2Ftoc.json). It is also assumed that you have connected your Workspace to Git and commited those changes to a branch following [these steps](https://learn.microsoft.com/en-us/fabric/cicd/git-integration/git-get-started?tabs=azure-devops%2CAzure%2Ccommit-to-git). Now, you want to create a new workspace and synchronize your Healthcare data solutions item. After creating the workspace, connecting to the branch (following the same steps detailed above), and waiting for your Fabric items to sync (see branch steps above), you are ready to run the sample notebook.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't actually require git integration correct? If a customer uses deployment pipelines on their own there is no git dependency. So we could say "It is also assumed that you have connected your Workspace to Git and/or are using deployment pipelines to move the Healthcare data solution item to down stream workspaces. Now, you want to create a new workspace and synchronize your Healthcare data solution item dependencies. After creating the target workspace and connecting to the git repo or using a deployment pipeline, you are ready to run the sample notebook."

Copy link

@mdearing06 mdearing06 Nov 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On second thought, I don't think it's a bad idea to say you expect they've connected to git as I'd think that's the preferred approach vs. someone only using deployment pipelines, but it should be worded in a way where git isn't required for downstream/target workspaces. So we could say "It is also assumed that you have connected your Workspace to Git and committed those changes to a branch following 'these steps'. Now, you want to create a new workspace and synchronize your Healthcare data solution item dependencies. After creating the target workspace and connecting to the git repo or using a deployment pipeline (see here https://learn.microsoft.com/en-us/fabric/cicd/manage-deployment), you are ready to run the sample notebook."


## What does the sample notebook do?

The `git_integration_helper` notebook helps copy important system configuration files, creates folders and tables, and updates metadata of other Fabric items in your workspace. This saves an immense amount of time and allows you to quickly start managing your healthcare data.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"hds_alm_helper"


## How do I get started?

If you meet the criteria defined in the scenario overview above, all you need to do to run the `git_integration_helper` notebook is import it into the **_source_** Fabric workspace, open the notebook, and run through the cells.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"hds_alm_helper"


## How do I get started?

If you meet the criteria defined in the scenario overview above, all you need to do to run the `git_integration_helper` notebook is import it into the **_source_** Fabric workspace, open the notebook, and run through the cells.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"target" workspace not "source" correct?

@@ -0,0 +1,586 @@
{

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the latest notebook? It's different than what was used in the bugbash.

@EvanJMiller
Copy link
Author

@EvanJMiller please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree company="Microsoft"

" source_table_path = f\"{source_tables_path}/{table_name}\"\n",
" dest_table_path = f\"{dest_tables_path}/{table_name}\"\n",
" \n",
" spark.sql(f'CREATE TABLE delta.`{dest_table_path}` SHALLOW CLONE delta.`{source_table_path}`')\n",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we do CREATE TABLE IF NOT EXISTS to avoid errors if the table was already copied?

"\n",
" return updated_global_parameters, replacements\n",
"\n",
"def get_updated_activties_configuration(source_workspace_id: str, source_admin_lakehouse_id: str, dest_workspace_id: str, dest_admin_lakehouse_id: str) -> Any:\n",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo get_updated_activities_configuration

"id": "f5e8672d",
"metadata": {},
"source": [
"#### Copy System Data\n",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we wrap these function calls in flags and set the flags at the top of the notebook all to true? Make it easy for the customer to run a subset or skip certain steps on subsequent runs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants