Loading
Omnistudio Document Generation
Table of Contents
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

          Search all of Salesforce Help
          Set Up Document Generation Partner Community User

          Set Up Document Generation Partner Community User

          Perform these tasks to set up the partner digital experience user. This topic applies to both Omnistudio Document Generation and Salesforce Document Generation.

          For server-side Omnistudio document generation to work, the execution mode for Integration Procedure must be set to Synchronous. Otherwise, document generation will fail for digital experience users.

          Enable Salesforce Digital Experience for Omnistudio Document Generation Partner Community User

          Enable Salesforce Digital Experiences, configure a domain name, and then enable standard external profiles.

          1. From Setup, in the Quick Find box, enter Digital Experiences.
          2. Click Settings.
          3. Select the Enable Digital Experiences checkbox.
          4. Enter the domain name and then click Check Availability.
          5. Click Save, and then click OK.
          6. From Settings, scroll to Role and User Setting, and then select Allow using standard external profiles for self-registration, user creation, and login.
          7. Click OK, and then click Save.

          Create a Partner Account for Omnistudio Document Generation Partner Community User

          Create an account to associate it with a contact.

          1. In the App Launcher, search for and open Accounts.
          2. Click New, add required details, and then save the account.
          3. Open the new account, and from the dropdown menu, select Enable As Partner.
            Select Enable As Partner option.

          Create an Omnistudio Document Generation Partner Community User

          Create a contact and enable it as partner.

          1. In the App Launcher, search for and open Contacts.
          2. Click New.
          3. In the Partner Account field, select the account that you created for your partner community.
            In the Account Name​​ field, you must select the account you created for your partner community.
          4. Save the contact.
          5. Open the new contact that you created, and then select Enable Partner User.
          6. In the New User page, select these items:

            User License: Partner Community

            Profile: <Name of the cloned profile>

            Note
            Note

            If you’ve cloned a profile, then in the profile field, select the cloned profile name.

          7. Define other required fields, such as email and nickname.
          8. Select Salesforce CRM Content User.
          9. Click Save, and then click OK.
            Important
            Important

            If you receive a Portal Account Owner has No Role error, assign a profile to the owner of the partner account. Then repeat this procedure.

          Clone and Configure a Partner Profile for Omnistudio Document Generation Partner Community User

          On the Profile Setup page, to create a custom profile you must clone an existing profile.

          Important
          Important

          If you want to use custom profiles for your partner users, Salesforce recommends that you clone the user profile linked to your user license and customize that profile.

          1. From Setup, in the Quick Find box, enter Profiles, and then select Profiles.
          2. Click the name of a profile that’s similar to the one that you want to create, and then in the profile page, click Clone.
          3. Enter a profile name.
          4. Click Save.
          5. Click Edit, next to the cloned profile name.
          6. From Standard Object Permissions section, select access level as read for these objects:
            • Omni Data Transformations

            • Omni Data Transformation Items

            • Omni Processes

          7. From the General User Permissions section, select these options:
            • Enables consumers and partners to execute Omniscripts, DRs, Cards through a Community or off platform.

            • Enables Customers and Partners to generate documents via communities.

          8. From the Administrative Permissions section, select API Enabled.
          9. Click Save.

          Create a Digital Experience Site for Omnistudio Document Generation Partner Community User

          Configure a name and a URL for the digital experience site.

          1. From Setup, in the Quick Find box, enter Digital Experiences.
          2. Click All Sites I New.
          3. Select a Lightning template (next to the lightning icon) or click Build Your Own I Get Started.
          4. In the Name field, enter a name for the digital experience site, such as PartnerSite.
          5. In the optional part of the URL field, enter the same name you entered in step 4.
            Important
            Important

            Although marked as optional, this field is mandatory. Omnistudio Document Generation requires that you set up your partner community URL.

          6. Click Create.

          Create a Permission Set for Omnistudio Document Generation Partner Community User

          To grant the licenses and permissions, create a Permission Set for Digital Experience partner community users.

          1. From Setup, in the Quick Find box, enter Perm then select Permission Sets.
          2. Click New.
          3. Enter a label, such as, Omnistudio Runtime for Communities.

            By default, the API Name is the same label.

          4. Click Save.

            A prompt appears listing dependent permissions.

          5. Click Save.

          Add Apex Class Access and Visualforce Page Access to Permission Set for Document Generation Partner Community Profile

          After you create the permission set, add the apex class access and Visualforce page access to the partner community profile. You can add the apex class access directly from the partner community user profile or from the permission set that you created. This topic applies to both Omnistudio Document Generation and Salesforce Document Generation.

          1. Open the custom permission set that you created, such as, Omnistudio Runtime for Communities.
          2. Click Apex Class Access.
          3. Move these classes from the Available Apex Classes list to the Enabled Apex Classes list:
            Client-Side
            • omnistudio.DocgenAppHandler
            • omnistudio.DocGenObjectMappings
            • omnistudio.DocGenUtility
            • omnistudio.DocumentServiceClient
            • omnistudio.DocxGenUtil
            • omnistudio.ObjectDocumentCreationDocxController
            • omnistudio.ObjectDocumentCreationDocxHandler
            • omnistudio.ObjectDocumentCreationDocxService
            Server-Side
            • omnistudio.ComponentController
            • omnistudio.BusinessProcessDisplayController
            • omnistudio.NewportUtilities
          4. Click Save.
          5. Open the custom permission set that you created, such as, Omnistudio Runtime for Communities.
          6. Click Visualforce Page Access.
          7. Move these classes from the Available Visualforce Pages list to the Enabled Visualforce Pages list.
            Client-Side
            • omnistudio.DocTemplateList
            • omnistudio.DocumentTemplate
            Server-Side
            • omnistudio.DRHome
            • omnistudio.DRMapper
            • omnistudio.OmniDesignerCustomLabelDeployer
            • omnistudio.OmniLwcCompile
            • omnistudio.OmniLwcDesignerTinyMceEditor
            • omnistudio.OmniscriptDesigner
            • omnistudio.OmniscriptDocuSignReturnPage
            • omnistudio.OmniscriptHome
            • omnistudio.OmniscriptInstancePage
            • omnistudio.OmniscriptLwcDocuSignViewPdf
            • omnistudio.OmniscriptLwcPreviewPage
            • omnistudio.OmniscriptPreviewPage
            • omnistudio.SessionPage
          8. Click Save.

          Assign Permission Sets to Omnistudio Document Generation Partner Community User

          Assign DocGen runtime community user permission set and the custom permission set that you created.

          1. From Setup, in the Quick Find box, enter Users, and then select Users.
          2. Click the name of the partner user.

            Don't click Edit.

          3. From the Permission Set Assignments section, click Edit Assignments.
          4. Assign these permission sets:
            1. DocGen Runtime Community User
            2. The new permission set that you created in the previous step, such as Omnistudio Runtime for Communities.
          5. Click Save.

          Configure Partner Community Digital Experience Site for Omnistudio Document Generation Partner Community User

          Activate the partner community digital experience site and associate the site to the cloned partner community profile, assign the relevant permission sets.

          1. From Setup, in the Quick Find box, enter Digital Experiences.
          2. Click All Sites.
          3. Find the partner community that you created, and then click Workspaces I Administration.
          4. In Settings, click Activate. Click OK.
          5. In Preferences, select the Show All Settings in Workspaces check box, and then click Save.
          6. In Members, select Partner from the Search dropdown.
          7. Select the profile that you cloned earlier from Available Profiles, and then click Add to move the profiles to the Selected Profiles list. Click Save.
            Important
            Important

            You can either use custom profiles or permission sets for members of the partner community. For more information on permission sets, see Set Up Document Generation Partner Community User.

          8. Return to the Digital Experiences All Sites page.
          9. Close the window.

          Add Docgen Document Template Library for Omnistudio Document Generation Partner Community User

          To generate document versions, you must add the partner community user as a member to the library.

          Important
          Important

          Add every new user for the community to the Docgen Document Template Library. Or, you can create a public group and add the group to the Docgen Document Template Library, so that you can add new users to that group.

          1. In the App Launcher, search for and open Files.
          2. Click Libraries.
          3. Click Docgen Document Template Library.
          4. Click Manage Members.
          5. Select the partner community user and then enable the Library Administrator access for the user.
          6. Click Add.
          7. Close the window.

          Define Sharing Rules for Document Generation for Omnistudio Document Generation Partner Community User

          Sharing rules grants partner community users read access to records. The documents that can be accessed depend on the rule. You can create sharing rules based on your business needs. For document generation, create sharing rules for Document Templates, Omni Data Transformation, and Omni Process.

          1. From Setup, in the Quick Find box, enter Sharing.
          2. Click Sharing Settings.
          3. To set up the sharing rules for Document Templates, Omni Data Transformation, and Omni Process, scroll to the relevant Sharing Rules section, and then click New.
          4. Define required fields, such as label, rule name, rule type, and share with.
          5. Set up the sharing rules:
            See these examples for more details.
            Document templates: Document templates don't contain sensitive data, and aren't specific to any customer. You can design a sharing rule that shares only the document templates that partner users require.
            Document Template Sharing Rule: This sharing rule allows the partner user to access the document templates.
            Document Template Sharing Rule window
          6. Click Save.
          7. Repeat steps 3–6 for Omni Data Transformation Sharing Rules and Omni Process Sharing Rules.

          Enable Partner Community Users to Generate Documents via an Experience Site

          To invoke an Omniscript from a partner site, integrate the Omniscript with an experience page and configure a custom button to launch the Omniscript. Retrieve and append the Omniscript Lightning URL to make sure that the Omniscript is accessible within the partner site. For a seamless and personalized user experience, include dynamic parameters in the URL to pass object-specific data.

          Required Editions

          Available in: Lightning Experience
          Available in: Professional, Enterprise, Unlimited, and Developer Editions
          User Permissions Needed
          To add Omniscript to the Digital Experience partner site DocGen Designer

          Prerequisites

          To ensure your Omniscript is accessible within the partner site, configure a custom button.

          1. Retrieve the Lightning URL from the Omniscript.
            1. Open the Omniscript that you want to add to your partner site. For example, fndSingleDocxLwc Omniscript.
            2. Select the action as How to Launch.
            3. Scroll to Lightning, and then copy the URL starting from ?c—target.
              Example: ?c__target=c:docGenerationSampleSingleDocxLwcEnglish&c__layout=newport&c__tabIcon=custom:custom18&c__tabLabel=Single Doc - DOCX (LWC)
            4. Click Done.
          2. Add the Omniscript Lightning URL to the button configuration.
            1. Open the custom button setup you created earlier.
            2. Paste the URL in the Button or Link URL field.
          3. Obtain the Omniscript page path from your Partner Site.
            1. Go to the partner site Homepage, for example https://www.testpartnersite.com/s
            2. Access the page where the Omniscript is placed, for example https://www.testpartnersite.com/s/omnipage
            3. Copy the path after .com. For example, /s/omnipage
          4. Prepend the Omniscript path to the custom button URL in the Button or Link URL field.
            For example /s/omnipage?c__target=c:docGenerationSampleSingleDocxLwcEnglish&c__layout=newport&c__tabIcon=custom:custom18&c__tabLabel=Single Doc - DOCX (LWC)
          5. To pass an object ID dynamically, add the Object ID as a parameter; append &c__ObjectId= at the end of the URL.Modify the Button or Link URL field to add the Omniscript and object path
            For example, /s/omnipage?c__target=c:docGenerationSampleSingleDocxLwcEnglish&c__layout=newport&c__tabIcon=custom:custom18&c__tabLabel=Single Doc - DOCX (LWC)&c__quoteId={!Quote.Id}
          6. Save your changes.
           
          Loading
          Salesforce Help | Article