Export (0) Print
Expand All

Deploy and configure the user profile-based list solution (Duet Enterprise)

Duet 1.0

Published: September 13, 2011

This section shows how to deploy and configure the user profile-based list solution.

In this section:

Before you begin

The user profile-based list solution is built on Duet Enterprise. You must deploy this solution on a SharePoint farm on which Duet Enterprise has been deployed and role synchronization has been completed. For information about deploying Duet Enterprise, see Deployment (Duet Enterprise). For more information about the optional role synchronization capability of Duet Enterprise, see Synchronize profiles and roles (Duet Enterprise).

Deploy the OBAExtensionsSDK solution package

Feature Pack 1 for Duet Enterprise 1.0 provides a solution package named OBAExtensionsSDK.wsp that comprises the Sample profile based form feature. Before you deploy this solution in a production environment, a developer must first customize the solution. For more information, see the How To: Customize Sample Profile Based Form Feature article on MSDN (http://go.microsoft.com/fwlink/p/?LinkId=228572).

After you have the customized .wsp file from the developer, proceed to the next section.

note Note:

For the purpose of this article, we assume that while customizing the solution, the developer has not changed any of the names associated with this solution, such as property names or the name of the .wsp file.

In this section:

Add the solution package for the user profile-based forms solution

This section shows how to add the solution package (.wsp) file that comprises the user profile-based forms solution. Note that no language-specific .wsp files are provided for this solution. This solution is provided in the English language only.

Before you can deploy a solution package, you must add it to the solution database of a SharePoint Server farm.

note Note:

You cannot use the Solution Management page in Central Administration to add a solution to the solution store. Instead, you must use Windows PowerShell.

To add the OBAExtensionsSDK.wsp file by using Windows PowerShell

  1. Log on to a server in the SharePoint Server farm as a member of the Administrators group. Verify that you meet the following minimum requirements: See Add-SPShellAdmin.

  2. Open the SharePoint 2010 Management Shell.

    1. On the Start menu, click All Programs.

    2. Click Microsoft SharePoint 2010 Products.

    3. Right-click SharePoint 2010 Management Shell and then click Run as administrator.

  3. At the Windows PowerShell command prompt, type the following command:

    Add-SPSolution –LiteralPath <SolutionPath>\OBAExtensionsSDK.wsp

    Where <SolutionPath> is the path of the .wsp file.

    For example, if you copied the OBAExtensionsSDK.wsp file to c:\solutions, type Add-SPSolution –LiteralPath c:\solutions\OBAExtensionsSDK.wsp.

  4. Press Enter.

    After successfully adding the solution, the name of the .wsp file and its assigned SolutionID are displayed in the Windows PowerShell command prompt.

Verify that OBAExtensionsSDK solution is in the solution store

Use this procedure to verify that the solution was imported to the farm’s solution store.

note Note:

You must be a member of the Farm Administrators group to perform this procedure.

To verify that the OBAExtensionsSDK solution is in the solution store

  1. In Central Administration, on the Quick Launch, click System Settings.

  2. In the Farm Management section, click Manage farm solutions.

  3. On the Solution Management page, verify that obaextensionssdk.wsp is listed in the Name column. If it is not, add the .wsp file again.

    The solution that you add is not yet deployed. Follow the steps in the next section to deploy it.

Deploy the user profile-based forms solution

After you have used the Windows PowerShell Add-SPSolution cmdlet to add a solution to the solution store, you must deploy the solution before you can access it. Note that this solution is deployed globally which means that, once deployed, all site owners within your SharePoint farm can activate the Sample Profile Based List Feature on their site.

You can use the Central Administration Web site or Windows PowerShell to deploy solutions that you added. The result of deploying the solution using Central Administration is the same as deploying it with Windows PowerShell except that the permissions required by these two methods are different. You must be a member of the Farm Administrators group to use the Central Administration web site to deploy solutions. You must be a member of the Administrators group on a computer running SharePoint Server 2010 and have the permissions described in Add-SPShellAdmin to use the Windows PowerShell method.

In this section:

Deploy the OBAExtensionsSDK.wsp solution using Central Administration

Follow the procedure in this section to use the Central Administration web site to deploy the OBAExtensionsSDK.wsp solution.

To deploy the OBAextensionsSDK.wsp solution by using Central Administration

  1. You must be a member of the Farm Administrators group to perform this procedure.

  2. On the Central Administration Home page, in the Quick Launch click System Settings.

  3. In the Farm Management section, click Manage farm solutions.

  4. On the Solution Management page, click obaextensionssdk.wsp.

  5. On the Solution Properties page, click Deploy Solution.

  6. On the Deploy Solution page, in the Deploy When section, select one of the following:

    • Now

    • At a specified time. If you select this option, use the date and time boxes to specify a time. We recommend that you select a time when the load on the destination servers is low.

  7. Click OK.

    On the Solution Management page, the Deployed To column of the obaextensionssdk.wsp row displays Globally deployed.

For more information about how to deploy solutions, see Deploying a solution package.

Deploy the OBAExtensionsSDK.wsp solution using Windows PowerShell

Follow the procedure in this section to use Windows PowerShell to deploy the OBAExtensionsSDK.wsp solution.

To deploy the OBAExtensionsSDK.wsp solution using Windows PowerShell

  1. Log on to a server in the SharePoint Server 2010 farm as a member of the Administrators group. Verify that you meet the following minimum requirements: See Add-SPShellAdmin.

  2. Open the SharePoint 2010 Management Shell.

    1. On the Start menu, click All Programs.

    2. Click Microsoft SharePoint 2010 Products.

    3. Right-click SharePoint 2010 Management Shell and then click Run as administrator.

  3. At the Windows PowerShell command prompt, type the following command:

    Install-SPSolution –Identity OBAExtensionsSDK.wsp

  4. Press Enter.

    After a successful deployment, the command prompt is returned. If an error message occurs, read the error message, make the necessary corrections to the syntax and try again.

For more information about how to use Windows PowerShell to deploy solutions, see Install-SPSolution.

Verify that the OBAExtensionsSDK solution was deployed

To verify that the OBAExtensionSDK solution was deployed

  1. You must be a member of the Farm Administrators group to perform this procedure.

  2. On the Central Administration Home page, click System Settings.

  3. In the Farm Management section, click Manage farm solutions.

  4. On the Solution Management page, in the Name column, click obaextensionssdk.wsp.

  5. On the Solution Properties page, the Deployment Status row displays Deployed and the Deployed To row displays Globally deployed.

Activate the Sample Profile-Based List feature

Complete this procedure to activate the Sample Profile Based List feature.

To activate the sample profile-based list feature

  1. You must be a member of the site Owners group to perform this procedure.

  2. Go to the site on which you want to use the user profile-based list solution.

  3. On the Site Actions menu, click Site Settings.

  4. In the Site Actions section, click Manage site features.

  5. In the Sample Profile Based List Feature row, click Activate.

    Activating this feature creates a new external list in the site named TimeEntry.

Note that activating the OBAExtensionsSDK feature creates a new external list named TimeEntry on the site. You can find this list by clicking All Site Content in the Quick Launch. You can edit the view of this list just like any other list. Note that, if the user account used to access the list is not mapped in the SAP system, the “No SAML mapping found for user: <domain>\<user>” error appears. If this occurs, contact your SAP administrator.

Manage user properties

When the OBAExtensionsSDK.wsp solution is deployed in the SharePoint farm, a new property is created in the user profile store. The name of this property is TimaProfile, by default but can be changed by a developer. To verify the name of the property, you can view the value of the UserProfilePropertyName property in the Entity Namespace node of the TimeEntry.xml external content type.

The value of this property is blank by default, which means that all users can see all fields in the view and edit external list forms. The purpose of the user profile-based forms feature is to enable some fields in external list forms to be hidden from some users based on the SAP role to which the user belongs.

Determining which fields are hidden from which users in view and edit forms is a collaborative process between an SAP administrator, a developer, and a SharePoint administrator. First, an SAP administrator must provide the developer with a list of the SAP roles. The developer must annotate the TimeEntry.xml external content type to determine which fields will be hidden on the forms for particular SAP roles. Then an SAP administrator must create a new property in the user profile and map the TimaProfile property to it.

In this section:

Create the TIMAProfile property

Complete the procedure in this section to create a property in the user profile store.

To create the TIMAProfile property

  1. Verify that you have the following administrative credentials.

    You must be a member of the Farm Administrators SharePoint group or a Service Application Administrator for the User Profile Service Application.

  2. On the Central Administration web site, in the Quick Launch, click Application Management.

  3. In the Service Applications section, click Manage service applications.

  4. In the Name column, click the link for the User Profile Service Application.

  5. On the User Profile Service Application page, in the People section, click Manage User Properties.

  6. On the Manage User Properties page, click New Property.

  7. On the Add User Profile Property page, in the Property Settings section, do the following:

    • In the Name box, type a name for the new property.

      For example, TIMAProfile.

    • In the Display Name box, type a display name for the new property. This is the name that will appear in the user profiles.

      note Note:

      If you use multiple languages in your deployment, you can provide alternative display names for each language by clicking Edit Languages. In the dialog box, click Add Language, select a language from the menu, and then type the display name of the new language. You can add display names for any of the available languages. The display name that appears depends on the language of the operating system on the computer of the user who views the property.

  8. Accept the default settings for the other sections and then click OK.

    The new property appears on the Manage User Properties page. This property also appears in all SharePoint user profiles.

For more information about creating custom properties for a user profile, see Add, edit, or delete custom properties for a user profile (SharePoint Server 2010).

Edit the TIMAProfiles property in a user profile

The value of the TIMAProfiles property for a particular user’s profile will determine what fields are hidden on view and edit forms for that user. Complete this procedure for each user profile for which you want to enable this capability.

note Note:

You will need to know the SAP role to which users are assigned to complete this procedure. Ask the SAP administrator or developer who customized the solution to provide a list of the users and their SAP roles.

To edit the TIMAProfiles property in a user profile

  1. Verify that you have the following administrative credentials:

    Verify that the user account that is used to perform this procedure is a member of the Farm Administrators SharePoint group or is a Service Application Administrator for the User Profile Service Application.

  2. On the Central Administration web site, in the Quick Launch, click Application Management.

  3. In the Service Applications section, click Manage service applications.

  4. In the Name column, click the link for the User Profile Service Application.

  5. On the User Profile Service Application page, in the People section, click Manage User Profiles.

  6. On the Manage User Profiles page, in the Find profiles box, enter part of the name of the user profile that you want to edit and click Find.

  7. Under Account name, position the cursor over the user profile you want to edit and click the drop-down arrow that appears and then click Edit My Profile.

  8. On the Edit User Profile page, in the TIMAProfile property box, enter the SAP role to which this user is assigned.

    Click Save and Close.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft