Assign Master Profile and Custom Profile Permissions to User Profiles

You can define Master Profile and custom profile permissions for user profiles that allow 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
Open and Open and Update option
Disable Auto check out option
Retain document name
Enable Create PDF/A option at check-in

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

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 to set Master Profile permissions and any custom profile permissions. (or)
Assign custom permissions to a user profile or permission set and enable the View Setup & Configuration permission.

The system applies permissions in the following order when a user accesses X-Author Contracts features:

Any user profile permissions defined in the APTS_ProfilePermissions admin entry will take priority.
Any user profiles not defined in the APTS_ProfilePermissions admin entry will use the Master Profile permissions in the admin entry.
If the APTS_ProfilePermissions admin entry does not exist, the system will enable/disable X-Author Contracts features using Salesforce custom permissions defined in the user profile or in permission sets assigned to the user.
- If a user profile or permission set assigned to a user does not include a specific custom permission for X-Author, the system will check for and use the permission in the Master Profile in the APTS_ProfilePermissions admin entry. For example, if xa_displaycheckincreatepdfa is not included in a user's custom permissions and is set to false in the Master Profile, the system will not allow the user to access that feature.

Note: If a permission is missing from both the Master Profile and a custom profile in the APTS_ProfilePermissions admin entry, users will encounter an error. All permissions in the sample code below must be included. If you don't want users to access a feature, set the permission to false.

Profile Permission Priority – APTS_ProfilePermissions Admin Entry


APTS_ProfilePermissions permissions assigned to a specific Profile	APTS_ProfilePermissions permissions available for the Master Profile	Result
Present	Present	User has access to the permissions assigned to their specific profile.
Not Present	Present	User has access to the permissions assigned in the Master Profile.
Not Present	Not Present	User receives an error.
Present	Not Present	User has access to the custom permissions assigned to their specific profile.

Configuring APTS_ProfilePermissions Admin Entry for Master Profile and Custom Profiles

APTS_ProfilePermissions allows you to define X-Author Contracts permissions for the Master Profile and custom user profiles.

Navigate to Admin tab.
Click New.
Enter APTS_ProfilePermissions in the Name field.
Enter JSON in the Value field.

In the Code field, you must define the following parameters.

Master Profile Parameters:


Name	Type	Description
id	ID	MasterProfile
name	string	Master Profile
Permission	string	The X-Author Contracts Advanced feature name.
Value	boolean	Indicates whether the user profile has the feature access.

Master Profile Code

{
	"profiles": [
		{
			"id": "MasterProfile",
			"name": "Master Profile",
			"permission": {
				"xa_contracts": "<value>",
				"xa_template": "<value>",
				"xa_checkinasfinal": "<value>",
				"xa_checkinwithredlines": "<value>",
				"xa_checkinwithoutredlines": "<value>",
				"xa_unlockreadonlyclause": "<value>",
				"xa_unprotectdocument": "<value>",
				"xa_hidecheckoutmenu": "<value>",
				"xa_disableautocheckout": "<value>",
				"xa_displaycheckinretaindocumentname": "<value>",
				"xa_displaycheckincreatepdfa": "<value>"
			}
		}
	]
}

Custom Profile Parameters:


Name	Type	Description
id	ID	The id of a user profile.
name	string	The name of a user profile.
Permission	string	The X-Author Contracts Advanced feature name.
Value	boolean	Indicates whether the user profile has the feature access.

Custom Profile 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>",
				"xa_hidecheckoutmenu": "<value>",
				"xa_disableautocheckout": "<value>",
				"xa_displaycheckinretaindocumentname": "<value>",
				"xa_displaycheckincreatepdfa": <"value">
			}
		}
	]
}

Sample

{
	"profiles": [
		{
			"id": "MasterProfile",
			"name": "Master Profile",
			"permission": {
				"xa_contracts": "true",
				"xa_template": "true",
				"xa_checkinasfinal": "true",
				"xa_checkinwithredlines": "false",
				"xa_checkinwithoutredlines": "true",
				"xa_unlockreadonlyclause": "true",
				"xa_unprotectdocument": "true",
				"xa_hidecheckoutmenu": "false",
				"xa_disableautocheckout": "false",
				"xa_displaycheckinretaindocumentname": "true",
				"xa_displaycheckincreatepdfa": "false"
			}
		}
	],
	"profiles": [
		{
			"id": "00eW0000000EKg8",
			"name": "System Administrator",
			"permission": {
				"xa_contracts": "true",
				"xa_template": "false",
				"xa_checkinasfinal": "true",
				"xa_checkinwithredlines": "false",
				"xa_checkinwithoutredlines": "true",
				"xa_unlockreadonlyclause": "true",
				"xa_unprotectdocument": "true",
				"xa_hidecheckoutmenu": "false",
				"xa_disableautocheckout": "true",
				"xa_displaycheckinretaindocumentname": "true",
				"xa_displaycheckincreatepdfa": "false"
			}
		},
		{
			"id": "00eA0000000nWXj",
			"name": "Custom Sys Admin",
			"permission": {
				"xa_contracts": "true",
				"xa_template": "true",
				"xa_checkinasfinal": "true",
				"xa_checkinwithredlines": "true",
				"xa_checkinwithoutredlines": "true",
				"xa_unlockreadonlyclause": "true",
				"xa_unprotectdocument": "true",
				"xa_hidecheckoutmenu": "false",
				"xa_disableautocheckout": "true",
				"xa_displaycheckinretaindocumentname": "true",
				"xa_displaycheckincreatepdfa": "false"
			}
		}
	]
}

Tip: If the Code field has multiple entries for the same user profile, the first entry is used for feature access.

Configuration Priority – APTS_ProfilePermissions Admin Entry with Salesforce Custom Permissions

The following table provides details about which permission configuration is given priority when evaluating user X-Author Contracts permissions:


APTS_ProfilePermissions	Custom Permissions	View Setup & Configuration	User Access
Yes	Yes	Not applicable	User can access features according to the APTS_ProfilePermissions configuration.
Yes	No	Not applicable	User can access features according to the APTS_ProfilePermissions configuration.
No	No	Not applicable	User can access features.
No	Yes	Yes	User can access features according to the custom permission.
No	Yes	No	User can access features.

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Assign Master Profile and Custom Profile Permissions to User Profiles

Profile Permission Priority – APTS_ProfilePermissions Admin Entry

Configuring APTS_ProfilePermissions Admin Entry for Master Profile and Custom Profiles

Configuration Priority – APTS_ProfilePermissions Admin Entry with Salesforce Custom Permissions

Footer Section

Explore