Tag Archives: crm 2013

USD: Remove individual hosted control parameters from memory

In our Unified Service Desk implementation (by the way, we’re live and everyone’s happy–YAY!), we are using a particular technique for showing the same entity type on multiple tabs. The nitty-gritty on how to do that is in this article I wrote a while ago.

The TL;DR on this is that we create more than one hosted control for a particular entity. When the entity record is requested, there’s a set of navigation rules that start looking at the URL parameter of the hosted controls, one by one. So if the first hosted control URL is empty, it loads that one, opening a new tab. Let’s say you call another record of the same entity type. It goes again through the navigation rules, checks the URL of the first hosted control, finds that it’s not blank or null, and then the next rule is fired, checking the URL for the second hosted control. If it finds it empty, then it loads that control in a new tab.

So much for a brief description.

When you close a tab, the hosted control parameters are kept in memory. One of the issues we found is that once you used a hosted control, if you close it, the control cannot be reused because the code looks for an empty or non-existing URL parameter to load up the different hosted controls. This would cause us to sometimes hit our control limit for that particular entity.

So we needed to clear the URL parameter. How?

The solution implemented is based on our USD custom panel, so it’s not handled via configuration. However, let me add before explaining that there’s a way to clear all parameters from a hosted control. You can do this by using the ClearDataParameter action, passing the parameter “name=topLevelTreeName“, where topLevelTreeName would be the hosted control or entity you want to clear. As it implies, it’ll clear all parameters for that entity; something you might want to do.

In our case, however, we only wanted to clear the URL parameter, and this is how we did it:

First, we set an event handler for the RequestApplicationClose event on the AppHost object:

 protected override void SessionCreatedEvent(Session session)
 {
     session.AppHost.RequestApplicationClose += AppHost_RequestApplicationClose;
     base.SessionCreatedEvent(session);
 }

This event handler is wired up when a new session is created by overriding the SessionCreatedEvent method, since you have an AppHost object for every session. Now we need to access the current parameters from the customer record. We do this with the following method:

private Dictionary<string, CRMApplicationData> GetApplicationParameters(string applicationName = "")
{
    var customerRecord =
        (DynamicsCustomerRecord)
            ((AgentDesktopSession) localSessionManager.ActiveSession).Customer.DesktopCustomer;
    if (customerRecord == null) return null;
    if (applicationName != "")
        return customerRecord.CapturedReplacementVariables[applicationName];
    var completeParameterList = new Dictionary<string, CRMApplicationData>();
    foreach (var appName in customerRecord.CapturedReplacementVariables.Keys)
    {
        var appParameterList = customerRecord.CapturedReplacementVariables[appName];
        foreach (var entry in appParameterList)
            completeParameterList.Add(entry.Key, entry.Value);
    }
    return completeParameterList;
}

This method returns all the existing parameters for the current customer record. We kept it generic so that we can reuse it for any future mad ideas we might have. Now we code in the new event handler for RequestApplicationClose:

private void AppHost_RequestApplicationClose(IHostedApplication app)
{
    var applicationParameters = GetApplicationParameters(app.ApplicationName);
    if (applicationParameters.ContainsKey("url"))
        applicationParameters.Remove("url");

}

Now we just look for the parameter, and kill it with fire. That’s it! This executes pretty fast with no noticeable performance hits; remember that this is set to run when the tab is closed, so the user is not left waiting for a process to run. This is a very easy way to remove parameters with pinpoint precision.

Tagged , , , , , , , ,

Using Telerik’s Fiddler to work with Microsoft Dynamics CRM

5-19-2015 1-51-56 PMWhat? You don’t have Fiddler?

My friend, you’re missing out, big time. Okay, let me help. First go here to the Telerik website and download the latest version. It’s free. I’ll wait here until you install it.

Got it? Okay, then let’s talk about it.

You might be wondering what my fuss is all about. You might also be wondering if this is some sort of paid advert, but I can assure you, I’m not related to Telerik in other way than as a customer. Turns out that Fiddler is one of the best tools you’ll find for debugging your CRM customizations.

This is how it works: In simple terms, when it’s active Fiddler intercepts every single web traffic call that is made from or to your computer to any other server, be it in the Internet or inside your company network. Not only does it catch all this traffic, it also presents the traffic in great detail.

This won’t be a full Fiddler tutorial, but I will list some ways you can use Fiddler in your CRM debug work. Also, I won’t show screenshots because I work at a financial institution and there’s a very slight possibility that some information might be decoded from any URLs I show here.

Reload an entity form

You know that with CRM 2013 and 2015, if you press F5 while debugging a page, you’ll go back in your form history to wherever you started. This is pretty bad when you’re using something like the IE Developer Tools script debugger, because you need to navigate all the way into the entity form you’re debugging, and then set up your break points again.

What Fiddler allows you to catch is the actual URL of the form being worked on. You can get this URL by clicking on the appropriate entry on the web traffic list (you’ll know what I’m referring to when you see it), select Inspectors from the upper-right area (the request area), and then select Raw view. Now you can happily copy this address, paste it into the browser, and press F5 to your heart’s content.

Missing web resources

Your form is not working properly and you have no idea why. Maybe you have a web resource that references another JavaScript library and it’s not finding it? Or some images are not loading? What could it be? Well, just by looking at the traffic, we can see any calls that are marked in red. Those calls have failed, and now we can use the inspector view for the request to verify if we have the correct path, although you could also do this in the timeline itself.

Failed service calls

You create your pretty request for the Organization Service to bring in some data and you get nothing. Hmm. Well, looking at in in Fiddler you can find out if the call itself has the correct syntax, and if so, you can look at the response with the JSON formatter and figure out if you actually got something back. Also works in the same manner with your on WCF services. Pretty handy, huh?

Performance evaluation

You can select however many rows from the traffic list and then switch the the Timeline graph showing the time spent on each call. This helped us a lot when fine-tuning the performance of our CRM implementation.

System element addresses

You want to use a certain CRM graphic (like a “Loading” GIF), but don’t know where it is? With a bit of trial and error you can find out the exact location of that resource, and then use it in your own web resources.

Are you still thinking about it?

As you can see, Fiddler is an excellent weapon in the arsenal of the well-prepared CRM developer. It helps us deal with some of the quirks we find when debugging CRM customizations, and even can help us figure out how Microsoft has put together some of the parts in the forms.

It’s solid, it doesn’t bog performance, it’s free, and it’s from a reputable company. Can’t ask for much more! Do you have any other ideas or ways in which Fiddler can help? Let us know here!

Tagged , , , , , , ,

USD: How to handle Save & Close without getting a confirmation dialog

In our implementation of the Unified Service Desk, we show each entity in its own separate hosted control and thus, a separate tab. Everything worked perfectly, except that every time we pressed Save & Close, we would get a dialog asking for confirmation before closing the tab. Very annoying, and something that needed to be fixed. After a lot of investigation and considering different approaches, what I will show here is how we finally dealt with the issue.

For our solution we’re taking care of saving the entity through code, and handling the tab close through the USD, which is equivalent to clicking on the tab’s “X”.

JavaScript code used for managing tab closure

The code to handle this should be located in a common JavaScript repository, so that it’s available to all entities. This is all the code needed, so there’s no need to create any new code every time you want to add the functionality to a new service request.

// Execute Save & Close from custom ribbon button, for USD compatibility.
function USDSaveAndClose (context) {
    // Remove and add event to save.
    Xrm.Page.data.entity.removeOnSave(SSFCU.FireUSDSaveAndCloseEvent);
    Xrm.Page.data.entity.addOnSave(SSFCU.FireUSDSaveAndCloseEvent);
    // Save the current entity.
    Xrm.Page.data.entity.save();
}

This first function removes and attaches a function to the OnSave CRM event. Removing and attaching it makes sure that it’s only there once, and avoids repeated execution. There might be a more elegant way to achieve this, but this works and has no performance impact. Note that the function being attached is the next one we’ll take a look at.

The last thing this function does is to save the entity. Note that we’re doing a regular save, and not using the saveandclose parameter.

function FireUSDSaveAndCloseEvent () {
    window.open('http://event/?eventname=SaveAndClose');
}

The second function, which is the one fires at the end of the save process, fires a USD Hosted Control event. This is a cool way of pushing events via code into the USD, and works as long as you have an event defined for the current active Hosted Control.

Notice that the event we’re firing, SaveAndClose, is not a standard event. We’ll be creating this event later.

Creating the new command bar button and command

To create the new command bar button, we used the fantastic Ribbon Workbench. If you don’t have it, get it now! Click here to download it from the awesome people at Develop 1.

Create a solution that includes the entities you will be modifying, and don’t forget to include the web resource that contains the code shown above. Now, run the Ribbon Workbench, load your solution, and select the entity your wish to modify. Select the Command Bar at the top right click in the Commands tree node to add a new command.

1

Now give the command a significant name, something like “publisher.entity.function.Command” works nicely:

2

Click the lookup button in actions, and add a new JavaScript function. It will have two parameters: the function name (must match the name of the first function shown above), and the web resource it comes from, for which you’ll get a lookup. The end result would be something like this:

4

Now it’s time to create our own Save & Close button! From the Toolbar area, drag a button to the spot where you want it. We placed ours between the default Save and Save & Close buttons. You’ll need to copy a couple of lines from the existing Save & Close button. I’ve enclosed screenshots comparing between the default button and my new one.

Default button

Default button

New Save & Close button

New Save & Close button

As shown here, I copied the image source paths, and the labels (mostly). In our case, we also need to add the Command that will be run, and it will be selected from the dropdown in the Behaviour section. In this screenshot, it shows in the CommandCore are too because I’ve already saved this record.

Now, hide the old Save & Close button by right-clicking on it and selecting the option from the context menu. Your command bar should look like this:

7

After you’re done, click the Publish button to make the changes effective.

Adding the custom event and action call

Go to CRM and create a new event for your hosted control, and name it SaveAndCloseThis is the custom event we’ll be firing, and will take care of closing our tab after saving, avoiding any confirmation dialogs from the IE process.

 8

Create a new Action Call for this event, and name it however fits your standards. Reference the standard UII Action Close, which will close the current active tab for this hosted control. It should look like this:

9

Remember to add these two to the appropriate configurations! That’s all we need! Fire up the USD and test it out. Let me know if you have any questions.

Have fun!

Tagged , , , ,

CRM 2013+: Where did my Security menu option go?!

We’ve been working with our migration from CRM 2011 to 2015, and in the process we realized that we lost the Security option from the navigation. It was gone. Lost. Nowhere to be found. How are we going to edit security roles and related items? Hairs were pulled. Questions were asked. And finally, we found the reason why.

If you remember, the Security option is not part of the original CRM 2011 options, since user management was under the Administration area. That was the first clue.

In addition to that, we have been including the Site Map in our master solution since day one into all our environments. That meant that the Site Map is being overwritten with our old navigation! In the process, the Security option was cut out! To fix our new and shiny 2015 organization, we need to manually edit the Site Map. To do so, we need to do the following:

  1. Create a new solution.
  2. Add the Site Map to the solution.
  3. Export.
  4. Unzip the solution and open the customization.xml file.
  5. Include the missing option nodes in the appropriate area.
  6. Save the file.
  7. Zip the solution with the modified file.
  8. Import the solution with the modified customizations.xml file.

In our case, below is the XML line we needed to add (highlighted in white):

sitemap_line

This work was facilitated by the wonderful software known as Araxis Merge. Don’t have Araxis? Go get it now. It’s fantastic.

Maybe an easier way to deal with this is to compare your existing Site Map with the one from the newly-minted organization, and note the differences. If something is missing from the old one, include it. Another way to do it (and maybe the easiest one) would be to exclude the Site Map from your main solution.

Whatever approach you take, now you know why some menu options can disappear from your new organization installation.

Have fun!

Tagged , , , ,

USD: How to use a toolbar for quick in-form navigation

One of the nice features in the UI for CRM 2011 is the left-hand side navigation. It allows you to move quickly through your form, based on the tabs you’ve defined. Unfortunately there is no such thing in CRM 2013. There are a few hacks out there that mess with the page CSS to get pseudo-toolbars working, all unsupported.

If you’re using the Unified Service Desk, there’s a solution for this by using the Toolbar controls.

The first step is to create an Action Call record for every tab you wish to navigate to. You configure the action call in the following manner:

action calls

  • Name – The name for this action call. It’s basically free-format, so try to write in something that’s easy to identify and makes sense.
  • Order – This is optional and can be left blank.
  • Hosted Control – The control that will hold the form we’re working with.
  • Action – This must be set to RunXrmCommand.
  • Data – Here you will write the Xrm code needed for navigating to the tab as follows:
Xrm.Page.ui.tabs.get("YOUR_TAB_NAME").setFocus();
Xrm.Page.ui.tabs.get("YOUR_TAB_NAME").setDisplayState("expanded");

The first line sets the focus onto the tab, and the second line makes sure it’s expanded in case you’ve set it to be collapsed by default.

Now that your action call is set up properly, let’s create the button for the toolbar. You don’t have a toolbar, you say? No problem. Here’s how you create one. Go to Toolbars in the Unified Service Desk settings and create a new one:
new toolbar

  • Name – This can be anything, so make it meaningful!
  • Title – Optional. If typed in, it will show a title for the toolbar on its left-hand side.

Save the record. Now we need to associate the toolbar with the hosted control it will reside in. To do so, click on the menu to the right of the toolbar name, and select Hosted Controls:

hostedcontrols

On the next screen, just add the appropriate hosted control to the sub-grid, and save.

attach_toolbar_to_control

Now we can add our action. Once saved, click on the plus sign above the sub-grid to add an existing record. Search for it, and add a new button record:

toolbar button

  • Name – The name for this button. It can be anything.
  • Image – If you have an image for the button, you put the web resource name here.
  • Button Text – This is the actual text shown on screen. Keep it brief.
  • Tooltip – Any additional description you want on hover, you can input here.
  • Order – The order in which the button will be displayed on the toolbar.
  • Show Tab – The hosted control that will be showing this toolbar.

Once you save the record, you can click the plus sign to either create a new action call, or add an existing action call. In our case, just add the action call we created above and save the toolbar. That’s all you need! Remember that if you’re using a configuration file, you need to add all these elements — the toolbar and the action call — to the configuration, otherwise it won’t run properly.

Hopefully this will make life way easier for your users and will allow them to quickly zero in on the information they need. Have fun!

Tagged , , , ,

USD: More information about handling popups

A quick post to let you know about a couple of new things I found about today while working with popping up tabs inside sessions. First, to get an entity record to pop up in a new tab from a flyout menu, you have to use the Popup option in the Route Type fields when defining the navigation rule, otherwise the new entity will appear in the current tab:

pop-up_pop-up

 

In addition to this, if you’re working with Configuration entities, make sure you add all the related elements needed for the pop-up into the appropriate configuration files. That means you have to include the Entity, Hosted Control, and Navigation Rule entity records. Failing to do this will prevent the pop-up action to execute successfully, again opening the window inside the tab you’re currently in.

Have fun!

Tagged , , , ,