cancel
Showing results for 
Search instead for 
Did you mean: 
Reply
shadowfox
Frequent Visitor

Change in PCF Controls load null data on initial load

Recently a control I have had published for quiet some time started to break (in July). This code base has not changed and has been working fine for some time. Trying to determine what update is causing this change in behavior. The issue is on initial load the field mapped to the control shows null data. But if you do a post back again (F5) it will work on the second load and if you exit the record and re-open it will work fine. Trying to understand why all of a sudden it's displaying null on initial load. As I have said - the code hasn't changed since Mar 18, 2020.  This is a modified version of the PeoplePicker control -

 

import { IInputs, IOutputs } from "./generated/ManifestTypes";
import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { PeoplePickerTypes, IPeopleProps, IPeoplePersona } from './Peoplepicker';

export class OfficeUIFabricReactPeoplePicker implements ComponentFramework.StandardControl<IInputs, IOutputs> {
	private theContainer: HTMLDivElement;
	private notifyOutputChanged: () => void;
	private _context: ComponentFramework.Context<IInputs>;
	private props: IPeopleProps = {
		//tableValue: this.numberFacesChanged.bind(this),
		peopleList: this.peopleList.bind(this),
	}

	/**
	 * Empty constructor.
	 */
	constructor() {

	}

	/**
	 * Used to initialize the control instance. Controls can kick off remote server calls and other initialization actions here.
	 * Data-set values are not initialized here, use updateView.
	 * @Param context The entire property bag available to control via Context Object; It contains values as set up by the customizer mapped to property names defined in the manifest, as well as utility functions.
	 * @Param notifyOutputChanged A callback method to alert the framework that the control has new outputs ready to be retrieved asynchronously.
	 * @Param state A piece of data that persists in one session for a single user. Can be set at any point in a controls life cycle by calling 'setControlState' in the Mode interface.
	 * @Param container If a control is marked control-type='standard', it will receive an empty div element within which it can render its content.
	 */
	public init(context: ComponentFramework.Context<IInputs>, notifyOutputChanged: () => void, state: ComponentFramework.Dictionary, container: HTMLDivElement) {
		// Add control initialization code
		this.notifyOutputChanged = notifyOutputChanged;
		this._context = context;
		this.theContainer = container;
	}


	/**
	 * Called when any value in the property bag has changed. This includes field values, data-sets, global values such as container height and width, offline status, control metadata values such as label, visible, etc.
	 * @Param context The entire property bag available to control via Context Object; It contains values as set up by the customizer mapped to names defined in the manifest, as well as utility functions
	 */
	public async updateView(context: ComponentFramework.Context<IInputs>) {
		// Add code to update control view
		this.props.context = context;
		if (context.parameters.peoplePicker.raw !== null) {
			if (context.parameters.peoplePicker.raw!.indexOf("text") > 1) {
				this.props.preselectedpeople = JSON.parse(context.parameters.peoplePicker.raw!);
			}
		}

		ReactDOM.render(
			React.createElement(
				PeoplePickerTypes,
				this.props
			),
			this.theContainer
		);

	}

	/** 
	 * It is called by the framework prior to a control receiving new data. 
	 * @returns an object based on nomenclature defined in manifest, expecting object[s] for property marked as “bound” or “output”
	 */
	public getOutputs(): IOutputs {
		return {
			peoplePicker: JSON.stringify(this.props.people)
		};
	}

	private peopleList(newValue: IPeoplePersona[]) {
		if (this.props.people !== newValue) {
			if (newValue.length === 0) {
				this.props.people = undefined;
			}
			else {
				this.props.people = newValue;
			}

			this.notifyOutputChanged();
		}
	}

	/** 
	 * Called when the control is to be removed from the DOM tree. Controls should use this call for cleanup.
	 * i.e. cancelling any pending remote calls, removing listeners, etc.
	 */
	public destroy(): void {
		// Add code to cleanup control if necessary
		ReactDOM.unmountComponentAtNode(this.theContainer);
	}
}

 

1 ACCEPTED SOLUTION

Accepted Solutions

No, the "null first, value second" thing is something I've seen before, that's why I knew to guess it. I am not sure how to reliably reproduce (or avoid) it, which is why I just take approaches that circumvent it. So again, make sure your nullcheck is safe (you already have a !== null, so that should safely avoid any exceptions) then add in a line right before your reactdom.render, basically the same thing you are doing in Dispose:

 

ReactDOM.unmountComponentAtNode(this.theContainer);

 

This will let your component run once, with a null string, which will render nothing in the picker. But then when updateView gets called again and has a value, it will unload that empty version of the control and reload with an actual value.

View solution in original post

18 REPLIES 18
cchannon
Multi Super User
Multi Super User

Nothing is jumping out at me as problematic in this code. What do you see when you debug the control using browser developer tools?

DianaBirkelbach
Super User
Super User

Hi @shadowfox 

 

 I don't know if that has something to do with it, but what's the reason of searching the "text" inside the peoplePicker parameter?

context.parameters.peoplePicker.raw!.indexOf("text")

 

If after the reload it works, maybe the first render triggers the "peopleList" witch changes the value.


Otherweise, I agree with @cchannon  , it depends on which values are passed to updateView when it's triggered. 

 

Kind regards,

Diana

 

Kind regards,
Diana
----------
Please click "Accept as Solution" if my post answered your question so that others may find it more quickly. If you found this post helpful consider giving it a "Thumbs Up."

@cchannon When using the debug tool - on the initial load when it first hits the updateview this is what I see (image below which shows the field being null) -

shadowfox_0-1628085445069.png

But then on the second call of the updateview is shows the data but at this point it's not rendering.

shadowfox_1-1628085522565.png

If I close the page and re-open the initial load this time has a value - 

shadowfox_2-1628085618220.png

This is the part that makes no sense to me. The fact on a cold load - the initial is null but then after closing and re-opening it's fine. As I said - this has been working wonderfully for over a year with no issues but this behavior just started. I did also try to update my npm packages and see if that fixed it but no luck.

 

Thanks.

 

@DianaBirkelbach thanks for the reply! The indexOf("text") is verifying the JSON has the label text in it to get the label for the control. Otherwise if text is missing, then the JSON main part is malformed and won't work. Hope that helps better explain that. Sadly - with the issue I'm having - I'm not hitting this part since the field is passing null on the initial cold load.

 

Thanks!

Hi @shadowfox , 

 

Now I'm making some wild guessing.
Maybe the "this.props" makes some trouble because the props is reserved in react, and the PCFs are based on react. Thinking of it, you actually don't need the private "props" in your class, which you also pass as a reference to the component PeoplePickerTypes as props. I also suppose that the changing of the content inside the props won't be reflected, since you render the PeoplePickerTypes with the same reference of the props, but you change the content (props should be immutable).

In your class, you only need the value (in your case the people).
So I suggest, not to define a private "props" in your class. The props you pass to your PeoplePickerTypes can be defined just where you call the render function. All you need to keep in the class is the value for people, and the function itself (peopleList).

 

I've also saw that the updateView is declared "async". Not so sure if it's supposed to work that way, but I also don't see where you have the await. I suggest to delete the async.

 

It the explanation is not clear enough, please let me know.

Hope it helps.

 

Kind regards,

Diana

Kind regards,
Diana
----------
Please click "Accept as Solution" if my post answered your question so that others may find it more quickly. If you found this post helpful consider giving it a "Thumbs Up."

@shadowfox When you say, "the field is passing null" do you mean

context.parameters.peoplePicker.raw

is coming through as null even though the attrib does contain a JSON value?

@cchannon Yes - that was on the debugger image I grabbed. The context.parameters.peoplePicker.raw is null on initial cold load. Very crazy - this is something new I'm experiencing. 

@DianaBirkelbach thanks for the reply. You did catch something I was trying just to see if it made a difference but it didn't. Here is the original code for that part. I was initially just using context.parameters.peoplePicker.raw but wanted to see if the this.props.context made any difference (mostly because I'm stuck and nothing else I tried worked so figured I'd try it just to rule it out). As for the async - this was initially developed as part of the PCF Gallery control - People Picker | PCF Gallery. I have modified the React code quiet a bit to handle any entity and fixed an issue with the async promise. But the index.ts page has been left untouched since I pulled it down. What's blogging my head its been working for over a year now just fine. This makes me think something with how controls are being rendered on cold load and binding has been changed. Thanks for the help!

public async updateView(context: ComponentFramework.Context<IInputs>) {
		// Add code to update control view
		this.props.context = context;
		if (context.parameters.peoplePicker.raw !== null) {
			if (context.parameters.peoplePicker.raw!.indexOf("text") > 1) {
				this.props.preselectedpeople = JSON.parse(context.parameters.peoplePicker.raw!);
			}
		}

		ReactDOM.render(
			React.createElement(
				PeoplePickerTypes,
				this.props
			),
			this.theContainer
		);

	}

 

Well, updateView gets called multiple times onLoad (at least two, could be more depending on what's happening on your form) and you can even force it to fire with Client Script by using the fireOnChange() function.

 

So try debugging again and just put your breakpoint at the top of updateView. Is contex.parameters.peoplePicker null every time updateView gets called, or maybe just the first time?

Helpful resources

Announcements

Microsoft Power Up program unveils new curriculum and more

  New engaging and cohesive Power Up curriculum The Microsoft Power Up Program – a self-paced upskilling program, launched in 2022 to help non-technical professionals gain marketable skills using the Microsoft Power Platform – takes learning to the next level with a cohesive video-based curriculum that spans only seven weeks. Recognizing the demand for multimedia content, we partnered with Microsoft MVPs Rory Neary and Charlie Phipps to create engaging videos that not only simplify complex concepts, but also make the learner experience more dynamic and immersive. Each course follows the same business through real-world scenarios with demos and hands-on exercises for learners to gain skills and build solutions using Power Apps, Power Automate and Power BI. This structured approach not only enhances comprehension but also equips learners with tangible skills that can be applied immediately in their professional endeavors. By focusing on key areas, the program has been shortened from 12 weeks to seven, saving valuable time without sacrificing quality. Special thanks go to Microsoft Power Platform advocates, April Dunnam and Renee Noble who shared their expertise and to Power Up Program champs who contributed with feedback and reviews over the last 1+ year to make this significant improvement.   Easy access to a comprehensive Development Environment In addition, the program now offers simplified and instant access to a comprehensive development environment for Power Up Program learners to explore and experiment with the Power Platform in a sandbox environment, fostering creativity and innovation.     Introducing App-In-A-Day (AIAD) workshops for Power Up learners As an added incentive, participants of the Microsoft Power Up Program can now sign up for partner-led “App in a Day” virtual workshops. These workshops, conducted by industry experts and Microsoft partners, provide invaluable insights and practical guidance to supplement the core curriculum. By attending these workshops, learners can gain deeper insights into application development and further enhance their skills in leveraging the Power Platform for business solutions. A big shout to our partners that are supporting the Power Up Program and delivering these AIAD workshops: Advaiya, Almato AG, Braintree, Kaispe, Koenig Solutions, PowerApps 911, Pragmatic Works, Smart Consulting.   These enhancements introduced to the Microsoft Power Up Program mark a significant milestone in the ongoing quest to empower individuals with the skills needed to thrive in today’s digital economy. By embracing video-based learning, streamlining the curriculum, and offering personalized experiences, the program continues to set new standards of excellence in virtual education. Sign up today to start your Power Up learning journey (https://aka.ms/PowerUp/)   by Dimpi Gandhi, Principal PM Lead, Power Up ProgramRepost from Microsoft Power Platform Product Blog

Announcing Power Apps Copilot Cookbook Gallery

We are excited to share that the all-new Copilot Cookbook Gallery for Power Apps is now available in the Power Apps Community, full of tips and tricks on how to best use Microsoft Copilot as you develop and create in Power Apps. The new Copilot Cookbook is your go-to resource when you need inspiration--or when you're stuck--and aren't sure how to best partner with Copilot while creating apps.   Whether you're looking for the best prompts or just want to know about responsible AI use, visit Copilot Cookbook for regular updates you can rely on--while also serving up some of your greatest tips and tricks for the Community. Our team will be reviewing posts using the new "Copilot" label to ensure we highlight and amplify the most relevant and recent content, so you're assured of high-quality content every time you visit. If you share a post that gets featured in the curated gallery, you'll get a PM in the Community to let you know!The curated gallery is ready for you to experience now, so visit the new Copilot Cookbook for Power Apps today: Copilot Cookbook - Power Platform Community. We can't wait to see what you "cook" up!      

Tuesday Tips: Getting Started in the Community

TUESDAY TIPS is back!   This weekly series of posts is our way of sharing helpful things we've learned or shared that have helped members of the Community. Whether you're just getting started or you're a seasoned pro, Tuesday Tips will help you know where to go, what to look for, and navigate your way through the ever-growing--and ever-changing--world of the Power Platform Community! The original run of Tuesday Tips was a highlight of last year, and these all-new Tips will hopefully prove to be just as informative as helpful. We will cover some basics about the Community, a few "insider tips" to make your experience even better, and sharing best practices gleaned from our most active community members and Super Users. Make sure to watch the News & Announcements each week for the latest and greatest Tuesday Tips!   THIS WEEK: I'm Brand New! What Do I Do? The number of new community members we have each week is pretty amazing, and we are so glad to welcome all of you to the Community! You may be wondering. "What do I do? Where do I get started? Will anyone be willing to help me? What I have a question? Help!"   Let's start with this: Welcome to the low-code revolution, and more importantly, welcome to the Power Platform Community! This is a great place to start. Whether you're busy with Power Apps, getting familiar with Power Automate, engaging Copilot Studio, or building in Power Pages, there are a few key places you should check out as you begin your journey: FORUMS: The forums are THE place to ask questions, look at questions asked by other Community members—and see answers and solutions from our Super Users and other helpful people in the Community. Power Apps ForumsPower Automate ForumsCopilot Studio ForumsPower Pages Forums   NEWS & ANNOUNCEMENTS: Our News & Announcements section highlights the newest and greatest updates in the Community, news from the product team, and so much more. It’s updated a few times each week and will also help you find ways to connect with what’s going on in the ever-growing world of Power Platform. Power Apps News & AnnouncementsPower Automate News & AnnouncementsCopilot Studio News & AnnouncementsPower Pages News & Announcements   GALLERIES: The Galleries section of the Community features tons of tips and tricks, features and benefits, and more—through videos created by our Super Users, product teams, and other helpful members of the Community. Power Apps GalleriesPower Automate Galleries Copilot Studio GalleriesPower Pages Galleries BLOGS: The community blogs section is full of handy step-by-step tips from members of the Community—and some of them include detailed answers to some of the questions most frequently asked questions, as well as how they solved a problem they faced. Power Apps Community BlogPower Automate Community BlogCopilot Studio Community BlogPower Pages Community Blog POWER UP PROGRAM: If you’d like to really take a huge step forward in your journey, we recommend checking out the Power Up Program, a Microsoft-sponsored initiative that trains new Power Platform users and has been a huge success since it launched a little over a year ago. There’s a waiting list, so definitely apply soon if you’re interested! Find out more here: Microsoft Power Up Program for career switchers.   There's so much more you'll discover in your Power Platform experience, and this Community is here for YOU! We are glad you've discovered us and can't wait to see where you grow! If you're new to the Community and just getting started, make sure to give this post a kudo and introduce yourself so we can welcome you!

Super User of the Month | Drew Poggemann

As part of a new monthly feature in the Community, we are excited to share that Drew Poggemann is our featured Super User for the month of February 2024. If you've been in the Community for a while, we're sure Drew's name is familiar to you, as he is one of our most active contributors--he's been a Super User for five consecutive seasons!   Since authoring his first reply 5 years ago to his 514th solution authored, Drew has helped countless Community members with his insights and expertise. In addition to being a Super User, Drew is also a User Group leader and a Microsoft MVP. His contributions to our Super User sessions and to the new SUIT program are always welcome--as well as his sense of humor and fun-loving way of sharing what he knows with others.   When Drew is not solving problems and authoring solutions, he's busy overseeing the Solution Architecture team at HBS, specializing in application architecture and business solution strategy--something he's been doing for over 30 years. We are grateful for Drew and the amazing way he has used his talent and skills to help so many others in the Community. If you are part of the SUIT program, you got to hear some great tips from Drew at the first SUIT session--and we know he still has much more to share!You can find him in the Community and on LinkedIn. Thank you for all you do, Drew!

February 2024 User Group Update: Welcoming New Groups and Highlighting Upcoming Events

It's a new month and a brand-new year, which means another opportunity to celebrate our amazing User Groups!Each month, we highlight the new User Groups that have joined the community. It's been a busy season for new groups, because we are thrilled to welcome 15 New User Groups! Take a look at the list below, shared by the different community categories. If your group is listed here, give this post a kudo so we can celebrate with you!   We love our User Groups and the difference they make in the lives of our Community! Thank you to all the new User Groups, new User Group leaders--we look forward to hearing about your successes and the impact you will leave!   In addition to our monthly New User Group spotlight, it's a great time to share some of the latest events happening in our User Group community! Take a look at the list below to find one that fits your schedule and need! There's a great combination of in-person and virtual events to choose from. It's a great time of year to connect and engage with User Groups both locally and online. Please Welcome Our NEW User Groups   Power Platform: Heathcare Power Platform User Group Power Platform Connect Hub Power Platform Usergroup Denmark Mexico Norte- Power Platform User Group Pune Power User Group Sudbury Power Platform User GroupMicrosoft User Group GhanaMPPBLR - Microsoft Power Platform Bengaluru User Group Power Apps:   Myrtle Beach Power Platform User GroupAnanseTechWB PowerApps Copilot Studio: Pathfinders Power Platform Community Dynamics365: Cairo, Egypt MSD 365 Business Central/NAV/F&O User GruopMS Dynamics 365 Business Central LatamCincinnati OH D365 F&O User Group February User Group Events February 2024 Cleveland Power Platform User GroupPortallunsj - Februar 2024Indiana D365/AX February User Group MeetingQ1 2024 KC Power Platform and Dynamics 365 CRM Users Group 

Super Users 2024 Season One is Here!

   We are excited to announce the first season of our 2024 Super Users is here! Our kickoff to the new year welcomes many returning Super Users and several new faces, and it's always exciting to see the impact these incredible individuals will have on the Community in 2024! We are so grateful for the daily difference they make in the Community already and know they will keep staying engaged and excited for all that will happen this year.   How to Spot a Super User in the Community:Have you ever written a post or asked for help in the Community and had it answered by a user with the Super User icon next to their name? It means you have found the actual, real-life superheroes of the Power Platform Community! Super Users are our heroes because of the way they consistently make a difference in the Community. Our amazing Super Users help keep the Community a safe place by flagging spam and letting the Community Managers know about issues. They also make the Community a great place to find answers, because they are often the first to offer solutions and get clarity on questions. Finally, Super Users share valuable insights on ways to keep the Community growing, engaging, and looking ahead!We are honored to reveal the new badges for this season of Super Users! Congratulations to all the new and returning Super Users!     To better answer the question "What is a Super User?" please check out this article: Power Apps: What is A Super User? - Power Platform CommunityPower Automate: What is A Super User? - Power Platform Community Copilot Studio: What is A Super User? - Power Platform Community Power Pages: What is A Super User? - Power Platform Community

Users online (3,480)