Skip to main content

Groovy Script – Assign Visibility to a Placeholder

Updated over a week ago

Description: Sample Groovy script to assign visibility to a placeholder based on roles, groups, and users. This script controls who can view the placeholder after it is created or updated.

You can assign placeholder visibility using:

  • Roles: Grant visibility to users assigned to specific roles.

  • Groups: Grant visibility to users belonging to specific groups.

  • Users: Grant visibility to individual users using their email addresses.

Context: Document

Document Type: Placeholder

Remark: Accessible in Post task mode only.

Script:

def execute() {

DocumentVO document = placeholderService.getPlaceholderDetails();

// Add roles

def roles = new ArrayList<>();

roles.add("Role 1");

roles.add("Role 2");

// Add groups

def group = new ArrayList<>();

group.add("Group A1");

// Add user emails

def user = new ArrayList<>();

user.add("user1@example.com");

Map<String, List<String>> visibilityMap = new HashMap<>();

visibilityMap.put(Recipient.ROLE, roles);

visibilityMap.put(Recipient.GROUP, group);

visibilityMap.put(Recipient.USER, user);

placeholderService.assignVisibility(document, visibilityMap);

}

Did this answer your question?