I would recommend to read Apps in SharePoint 2013 post before going through this one.
I want to create a SharePoint-Hosted App in 2013 using Visual Studio.
I have created a SharePoint 2013 machine with all required software.
Just as a best practice, even if you are creating a standalone server, enable Active Directory Domain Services.
SharePoint 2013 works better when the system is in a Domain, rather than in a workgroup.
So, I have installed Windows server 2012, enabled all required features. Installed Office 2013, SharePoint 2013, Visual Studio 2012 and Developer tools for SharePoint 2013.
We will create an "App for SharePoint" and try to understand the scaffold code and try to deploy it and see what can happen.
Step 1: Open Visual studio and select "App for SharePoint".
Provide required data. While selecting the hosting option, remember to select the hosting option as "SharePoint-Hosted". You can select Auto-Hosted if you want to deploy your App to Windows Azure. Provider-Hosted if you want to deploy the App to any other hosting Providers.
Step 2: Default "App" code is created and lets have a look at its content.
Project is created with a Default.aspx page and few script files and configuration files. First thing we need to know is about "Default.aspx" page. We already read that every SP-Hosted App we Install/Deploy will be created as a Subweb under SP Web application. That Subweb will be defaulted to this specific page. When user click on the App, he will be navigated to this page first. If you want to rename the page, or set different page as start page, modify Manifest.XML to achieve it.
Lets see the content of the file now.
Step 3: I have attached the snapshot of the "Default.aspx" file and see what is the significance of each part.
The first highlighted box refers to the Framework provided JavaScript libraries. As we will be using Client Side Object Model(CSOM), these Jscript libraries will provide the necessary support while execution of our custom code.
Second highlighted box refers to the local script file pertaining to this specific app. We will see in detail about this in next step.
Third one is the sample code I added. We will not be doing extensive coding right now. The objective is to see if there are any hurdles in deploying an App.
Step 4: Open App.js file under scripts. This file content is responsible for Loading the Context and Web information in which the App is running. Look at the code and its almost self explanatory.
Step 5: Now I tried to deploy the App. First things to ensure are that App Management service and Site Subscription Services are enabled in Service Applications section on Central Admin. Now Deploy. . .
Oops, got an error.
" Error occurred in deployment step 'Install app for SharePoint': Failed to install app for SharePoint. Please see the output window for details."
Ok, looked at Output window found another reason.
" ErrorDetail: Apps are disabled on this site. "
Now we need to remember what we learned in prior post. Any SharePoint-Hosted App will try to create a Subweb which will be executed in a separate AppDomain apart from SharePoint Farm.
Currently SharePoint dint have any clue on where to Host this app code and what to do with it.
Step 6: We need to create a new App Domain, and register it with SharePoint. So next time when you deploy an App, it know where to host it.
I created my machine on a Domain "Sharepoint13.com". So I would like to create an App Domain "Sharepoint13Apps.com" for hosting purpose. For that go to
Administrative Tools > DNS > following window will b opened showing the Machine Name and the current App Domain in which SharePoint farm is executing.
Right click on Forward Lookup Zone and Click on
"New Zone" > "Next" > "Next" > "Next" > following window will open.
Now the new AppDomain is created, Now we will create a wildcard Alias (CNAME) record to allow apps to create unique domain names within our app domain, Sharepoint13Apps.com. Right-click Sharepoint13Apps.com and select Refresh. Then right-click Sharepoint13Apps.com and select New Alias (CNAME)…
Give the values as I have shown and Click OK.
Now App Domain is created, lets test it now. Open CMD window and try pinging to "abc.Sharepoint13Apps.com". . . Successfully done.
Step 7: We need to register this newly created app domain with SharePoint. Go to Central admin, click on Apps on right menu.
it will give you a message saying
"The Subscription Settings service and corresponding application and proxy needs to be running in order to make changes to these settings. "
This means a new service application running in its own app pool needs to be created and up and running.
Lets create a Managed account with Machine admin credentials. Mine is
"Sharepoint13\Administrator".
Open the PowerShell window and execute below script.
It may prompt you once, say Yes.
Some times the above script may give error
"Access denied. Only machine administrators are allowed to create administration service job definitions"
Go to "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\15\CONFIG\POWERSHELL\Registration" and execute SharePoint.ps1 as Administrator.
Issue will be resolved.
Once this script is successfully executed. We have created a new service Application, and its proxy which will run under its own Service App Pool. To verify this go to
Central Admin > Service Applications > Manage Service Applications > you can see below Svc application created , up and running.
Step 8: Now go to Central Admin > Apps > Configure App URLs
You can see that the new App Domain we created automatically populated here, just mention app prefix as "Apps" and say OK.
We are all set to deploy our SharePoint-Hosted App. Right click on Solution and say "Deploy"
Once App is deployed successfully, go to SharePoint Application and click on "Site Actions" the little gear symbol on top right and click on Site Content. You can see your App there.
Lastly we have to observe one more thing before closing this topic. Observe the url of site and the url of the App after loading.
We can see SharePoint-Hosted App loaded in different App Domain thus causing no harm to Actual SharePoint Farm in any circumstances.
Objective Achieved.
Is it helpful for you? Kindly let me know your comments / Questions.
I want to create a SharePoint-Hosted App in 2013 using Visual Studio.
Just as a best practice, even if you are creating a standalone server, enable Active Directory Domain Services.
SharePoint 2013 works better when the system is in a Domain, rather than in a workgroup.
So, I have installed Windows server 2012, enabled all required features. Installed Office 2013, SharePoint 2013, Visual Studio 2012 and Developer tools for SharePoint 2013.
We will create an "App for SharePoint" and try to understand the scaffold code and try to deploy it and see what can happen.
Step 1: Open Visual studio and select "App for SharePoint".
Provide required data. While selecting the hosting option, remember to select the hosting option as "SharePoint-Hosted". You can select Auto-Hosted if you want to deploy your App to Windows Azure. Provider-Hosted if you want to deploy the App to any other hosting Providers.
Step 2: Default "App" code is created and lets have a look at its content.
Lets see the content of the file now.
Step 3: I have attached the snapshot of the "Default.aspx" file and see what is the significance of each part.
The first highlighted box refers to the Framework provided JavaScript libraries. As we will be using Client Side Object Model(CSOM), these Jscript libraries will provide the necessary support while execution of our custom code.
Second highlighted box refers to the local script file pertaining to this specific app. We will see in detail about this in next step.
Third one is the sample code I added. We will not be doing extensive coding right now. The objective is to see if there are any hurdles in deploying an App.
Step 4: Open App.js file under scripts. This file content is responsible for Loading the Context and Web information in which the App is running. Look at the code and its almost self explanatory.
Step 5: Now I tried to deploy the App. First things to ensure are that App Management service and Site Subscription Services are enabled in Service Applications section on Central Admin. Now Deploy. . .
Oops, got an error.
" Error occurred in deployment step 'Install app for SharePoint': Failed to install app for SharePoint. Please see the output window for details."
Ok, looked at Output window found another reason.
" ErrorDetail: Apps are disabled on this site. "
Now we need to remember what we learned in prior post. Any SharePoint-Hosted App will try to create a Subweb which will be executed in a separate AppDomain apart from SharePoint Farm.
Currently SharePoint dint have any clue on where to Host this app code and what to do with it.
Step 6: We need to create a new App Domain, and register it with SharePoint. So next time when you deploy an App, it know where to host it.
I created my machine on a Domain "Sharepoint13.com". So I would like to create an App Domain "Sharepoint13Apps.com" for hosting purpose. For that go to
Administrative Tools > DNS > following window will b opened showing the Machine Name and the current App Domain in which SharePoint farm is executing.
Right click on Forward Lookup Zone and Click on
"New Zone" > "Next" > "Next" > "Next" > following window will open.
Give the values as I have shown and Click OK.
Now App Domain is created, lets test it now. Open CMD window and try pinging to "abc.Sharepoint13Apps.com". . . Successfully done.
Step 7: We need to register this newly created app domain with SharePoint. Go to Central admin, click on Apps on right menu.
"The Subscription Settings service and corresponding application and proxy needs to be running in order to make changes to these settings. "
This means a new service application running in its own app pool needs to be created and up and running.
Lets create a Managed account with Machine admin credentials. Mine is
"Sharepoint13\Administrator".
Open the PowerShell window and execute below script.
add-pssnapin "Microsoft.Sharepoint.Powershell" $account = Get-SPManagedAccount sharepoint13\administratorRemove-SPServiceApplicationPool -Identity SettingsServiceAppPool $appPoolSubSvc = New-SPServiceApplicationPool -Name SettingsServiceAppPool -Account $account$appSubSvc = New-SPSubscriptionSettingsServiceApplication -ApplicationPool $appPoolSubSvc -Name SettingsServiceApp -DatabaseName SettingsServiceDB $proxySubSvc = New-SPSubscriptionSettingsServiceApplicationProxy -ServiceApplication $appSubSvc
It may prompt you once, say Yes.
Some times the above script may give error
"Access denied. Only machine administrators are allowed to create administration service job definitions"
Go to "C:\Program Files\Common Files\microsoft shared\Web Server Extensions\15\CONFIG\POWERSHELL\Registration" and execute SharePoint.ps1 as Administrator.
Issue will be resolved.
Once this script is successfully executed. We have created a new service Application, and its proxy which will run under its own Service App Pool. To verify this go to
Central Admin > Service Applications > Manage Service Applications > you can see below Svc application created , up and running.
You can see that the new App Domain we created automatically populated here, just mention app prefix as "Apps" and say OK.
We are all set to deploy our SharePoint-Hosted App. Right click on Solution and say "Deploy"
Once App is deployed successfully, go to SharePoint Application and click on "Site Actions" the little gear symbol on top right and click on Site Content. You can see your App there.
Lastly we have to observe one more thing before closing this topic. Observe the url of site and the url of the App after loading.
Objective Achieved.
Is it helpful for you? Kindly let me know your comments / Questions.
Thanks for sharing this Article
ReplyDeleteawesome.
ReplyDeletethanx pratap u explained clearly....
ReplyDeleteVery good article
ReplyDelete