You can define custom permissions for user profiles that allow the users to access the following X-Author Contracts features:

  • Contracts tab
  • Templates tab
  • Check-in as final
  • Check-in without redlines
  • Check-in with redlines
  • Unprotect document
  • Unlock read-only clause

Irrespective of the user profile permissions, any user can check-in a document with redlines using X-Author for Contracts 1.0.

You need to perform one of the following actions for all the user profiles in your org to permit users to access X-Author Contracts features:

  • Define the APTS_ProfilePermissions admin entry.
  • Assign custom permissions to a user profile and enable the View Setup & Configuration permission.

The admin entry is given first priority and the next priority is given to custom permissions along with the View Setup & Configuration permission. If the admin entry is configured, the system does not check for custom permissions.

The following conditions apply when a user accesses the X-Author Contracts features:

  • If all the user profiles are included in the admin entry, users can access the features according to the feature access defined in the admin entry.
  • If only a few user profiles are included in the admin entry:
    • Users with included user profiles can access the features according to the feature access defined in the admin entry.
    • Users with excluded user profiles cannot access any of the features.
  • If the admin entry is not defined and all the user profiles have custom permissions along with the View Setup & Configuration permission, users can access the features according to the custom permissions available for the user profile.
  • If the admin entry is not defined and only a few user profiles have custom permissions along with the View Setup & Configuration permission:
    • Users with user profiles for which all the custom permissions are available can access all the features.
    • Users with user profiles for which only a few custom permissions are available can access only the features related to the available custom permissions.
    • Users with user profiles for which no custom permissions are available cannot access any of the features.
  • If the admin entry is not defined and all the user profiles have no custom permissions, users cannot access any of the features.

You must not define some user profiles in the admin entry and the remaining profiles in the custom permissions.

To configure APTS_ProfilePermissions admin entry

The APTS_ProfilePermissions admin entry allows you to define custom permissions for user profiles. 

  1. Navigate to Admin tab.
  2. Click New.
  3. Enter APTS_ProfilePermissions in the Name field.
  4. Enter JSON in the Value field.
  5. In the Code field, you need to define the following parameters.

Parameters

NameTypeDescription

id

ID

The id of a user profile.

name

string

The name of a user profile.

PermissionstringThe X-Author Contracts feature name.


ValuebooleanIndicates whether the user profile has the feature access.

Code

{
   "profiles":[
      {
         "id":"<UserProfileID>",
         "name":"<UserProfileName>",
         "permission":{
            "xa_contracts":"<value>",
            "xa_template":"<value>",
            "xa_checkinasfinal":"<value>",
            "xa_checkinwithredlines":"<value>",
            "xa_checkinwithoutredlines":"<value>",
            "xa_unlockreadonlyclause":"<value>",
            "xa_unprotectdocument":"<value>"
         }
      }
CODE

Sample

{
   "profiles":[
      {
         "id":"00eW0000000EKg8",
         "name":"System Administrator 1",
         "permission":{
            "xa_contracts":"true",
            "xa_template":"false",
            "xa_checkinasfinal":"true",
            "xa_checkinwithredlines":"false",
            "xa_checkinwithoutredlines":"true",
            "xa_unlockreadonlyclause":"true",
            "xa_unprotectdocument":"true"
         }
      },
      {
         "id":"00eA0000000nWXj",
         "name":"System Administrator N",
         "permission":{
            "xa_contracts":"true",
            "xa_template":"true",
            "xa_checkinasfinal":"true",
            "xa_checkinwithredlines":"true",
            "xa_checkinwithoutredlines":"true",
            "xa_unlockreadonlyclause":"true",
            "xa_unprotectdocument":"true"
         }
      }
   ]
}
CODE

If the Code field has multiple entries for the same user profile, the first entry will be considered for feature access.

To assign custom permissions to a user profile

  1. Create custom permissions. For more information, see Custom Permissions.
  2. Go to Setup > Manage Users > Profiles.

  3. In the Enabled Custom Permissions section, click Edit.
  4. Add required Custom Permissions and click Save.

To configure View Setup & Configuration Permission

For information on how to configure View Setup & Configuration permission, see Profile Settings and Security.

Configuration Priority

The following table provides the details about which configuration is given priority:

APTS_ProfilePermissions 

Custom Permissions 

View Setup & Configuration 

User Access

YesYesNot applicableUser is able to access the features according to the APTS_ProfilePermissions configuration. 

Yes

No

Not applicable

User is able to access the features according to the APTS_ProfilePermissions configuration.

No

No

Not applicable

User is unable to access the features.

No

Yes

Yes

User is able to access the features according to the custom permission.

No

Yes

No

User is unable to access the features.