Content Tools

Overview

These functions extend Appian content and offer document/folder search, directory listing, and the ability to get/set the searchable attribute of a folder.

Functions are designed for and only work on Appian content, not the local filesystem. All search functions assume the root folder and all subfolders are searchable. Search functions will not return results contained within non-searchable objects.

All functions use the serviceContext of the user account executing the expression at runtime.

Key Features & Functionality

Data Types

contentSecurityRoleMap: CDT that backs the returnContentRoleMap function

Smart Services

Copy Document (Change Extension)
Delete Document Version
Delete Folder Contents
Delete Files Older Than
Delete Files Created Before
Delete Multiple Documents
Remove Member From Folder Security
Inherit Security From Parent for Folder
Inherit Security from Parent for Document
Remove Member From KC Security
Delete Rule/Constant Versions
Set Folder Security
Create Document Version
Create expression rule
Update expression rule expression
Update expression rule parameters

Functions

getfoldersrequiringchangesapproval
getsubfoldersfromfolder
getdocumentsfromfolder
getdocumentinternalidsfromfolder
getfilesolderthandate: Get files older than a particular date
getfileslargerthansize: Get files larger than a particular size
finddocumentsbyname
getconstantorruleuuidbyname
findcontentbyattribute
getcontentdetailsbyuuid
getcontentdetailsbyinternalname
getcontentobjectdetailsbyid
getcontentobjectswithnumofversions: function to find rules or constants with a given number of versions. Useful to find out objects that can increase memory usage in the collaboration engine. See https://forum.appian.com/suite/help/16.3/kb/kb-1226.html
getcontentobjectrevisionhistorydetails: Retrieves the revision history of a content object formatted as "[version id, date created, date updated, size, author]"
getconstantsfromfolder
getconstantsbyname
setfoldersearchability
getfoldersearchability
getdownloadersfromgroup
returncontentrolemap
getprocessmodeldetailsbyuuid
getrulereferencebyname
generateuuid

Parents

Radhamani Ramasamy over 4 years ago

Hi Team,

We are using this plugin.

In health check, we received some of the APIs used in this plugin got removed/deprecated. Can we expect any update on the plugin sooner?

We used the below functions in our app. We are going to upgrade to 20.1. Can you confirm that the below functions will work in 20.1?

FindContentByAttribute
FindDocumentsByName
FindFoldersByName
GetContentObjectDetailsByID
GetDocumentsFromFolder
GetSubfoldersFromFolder

Health check report:

Content Tools (com.appiancorp.ps.plugins.contenttools) references removed and deprecated Appian APIs
[removed] com.appiancorp.suiteapi.common.LocalObject.<init>(java.lang.Integer,java.lang.Long)
[removed] com.appiancorp.suiteapi.common.exceptions.AppianException.<init>(com.appiancorp.suiteapi.common.exceptions.ErrorCode,java.lang.Object[])
[removed] com.appiancorp.suiteapi.common.exceptions.AppianException.<init>(com.appiancorp.suiteapi.common.exceptions.ErrorCode,java.lang.Throwable)
[removed] com.appiancorp.suiteapi.content.ContentFilter.<init>(int,int)
[removed] com.appiancorp.suiteapi.process.exceptions.SmartServiceException.Builder.<init>(java.lang.Class,java.lang.Throwable)
[removed] com.appiancorp.suiteapi.type.TypedValue.<init>(java.lang.Long,java.lang.Object)
[deprecated] com.appiancorp.suiteapi.common.ServiceLocator.getContentService(com.appiancorp.services.ServiceContext)
[deprecated] com.appiancorp.suiteapi.common.ServiceLocator.getStatisticsService(com.appiancorp.services.ServiceContext)
[deprecated] com.appiancorp.suiteapi.content.ContentService.approve(java.lang.Long[])
[deprecated] com.appiancorp.suiteapi.content.ContentService.getAllChildren(java.lang.Long, com.appiancorp.suiteapi.content.ContentFilter, java.lang.Integer)
[deprecated] com.appiancorp.suiteapi.content.ContentService.getAllChildrenAndVersions(java.lang.Long, com.appiancorp.suiteapi.content.ContentFilter)
[deprecated] com.appiancorp.suiteapi.content.ContentService.getExpiredIds(java.lang.Long, java.lang.Integer, com.appiancorp.suiteapi.content.ContentFilter)
[deprecated] com.appiancorp.suiteapi.content.ContentService.getInactive(java.lang.Long, com.appiancorp.suiteapi.content.ContentFilter)
[deprecated] com.appiancorp.suiteapi.content.ContentService.getPendingPaging(java.lang.Long, com.appiancorp.suiteapi.content.ContentFilter, int, int, java.lang.Integer, java.lang.Integer)
[deprecated] com.appiancorp.suiteapi.content.ContentService.getVersions(java.lang.Long[], java.lang.Integer)
[deprecated] com.appiancorp.suiteapi.content.ContentService.unexpire(java.lang.Long[])
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Mike Cichy over 4 years ago in reply to Radhamani Ramasamy

Yes it will work.

https://docs.appian.com/suite/help/20.1/Appian_Release_Notes.html#removals
- Cancel
- Up 0 Down
- Reply
- More
- Cancel

Comment

Mike Cichy over 4 years ago in reply to Radhamani Ramasamy

Yes it will work.

https://docs.appian.com/suite/help/20.1/Appian_Release_Notes.html#removals
- Cancel
- Up 0 Down
- Reply
- More
- Cancel

Children

April Schuppel over 4 years ago in reply to judym598

Hi - Compatible Version(s) is based on what the app author has tested with at the time of submission. Appian has great backwards compatibility so in general, there's no need to worry if a new Appian version comes out but the plug-in hasn't been updated. We just updated this plug-in today and the new version has been tested with 20.1, so the compatibility has been updated. The new plug-in version adds the Delete Rule/Constant Versions Smart Service.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
judym598 over 4 years ago in reply to Mike Cichy

How does this plugin compare to Content Expressions (v1.0.8) [com.appiancorp.cloud.plugins.contentfunctions]? We are currently using the Content Expressions plugin which I don't believe is available anymore - superceded by the above plugin? - and some OOTB functions. We did have to update a few things following the 19.1 upgrade to use the OOTB function 'findcontentbyattribute' in processes that were using the 'finddocumentsbyname()' function from the plugin. Can we safely upgrade to this plugin?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
judym598 over 4 years ago in reply to Mike Cichy

Glad to know this will work with 20.1 - Can you update the information for this plugin? It currently says 'Compatible Version(s): 17.2 +, 19.3 - which is misleading. Perhaps it should say 17.1 - 20.1.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Radhamani Ramasamy over 4 years ago in reply to Mike Cichy

Makes sense! Thanks, Mike!
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Mike Cichy over 4 years ago in reply to Radhamani Ramasamy

The plugin will not be affected in any way. The "removed" tag is an internal tag that HC reads - we will be updating the HC. There may be some updates to the Content Tools plugin but always in a backwards compatible fashion. Public APIs that have been truly removed will be called out in release notes.
- Cancel
- Up 0 Down
- Reply
- More
- Cancel
Radhamani Ramasamy over 4 years ago in reply to Mike Cichy

Thanks! But in health check we see some of the APIs removed. In which way, it will affect?
- Cancel
- Up 0 Down
- Reply
- More
- Cancel