a!cmiGetFolderChildren() Function

Connector Functions

Function

a!cmiGetFolderChildren( scsExternalSystemKey, usePerUserCredentials, atomPubUrl, repositoryId, folderId, pagingInfo )

Retrieves the children of the folder given as the folderId parameter, obeying the given pagingInfo.

Parameters

Keyword	Type	Description
`scsExternalSystemKey`	Text	The key from the Third Party Credentials admin console page that corresponds to the set of credentials that should be used to authenticate.
`usePerUserCredentials`	Boolean	If `true` the credentials set in the Third-Party Credentials settings page by the current user running the expression will be used. If `false` the site-wide credential values will be used.
`atomPubUrl`	Text	The Atom Pub URL of the CMIS target system.
`repositoryId`	Text	The repository id on the CMIS target system.
`folderId`	Text	The object id of the CMIS folder.
`pagingInfo`	PagingInfo	The start index and batch size of the list of objects to retrieve, created with `a!pagingInfo()`. Unlike most indexes in Appian, the start index is 0-based instead of 1-based to match the indexing scheme used by CMIS. The sort values in the paging info are ignored.

Returns

The function returns the standard connector result dictionary described in the main Connectors page.

If successful, the result field contains a dictionary representation of the objects within the given folder.

Usage considerations

If called multiple times in the same expression with the same parameters, only one query is made when the expression is evaluated and the result is reused for each identical call. This caching only applies within a single expression evaluation. Return values are not cached in separate expressions, or in separate evaluations of the same expression.

Examples

Copy and paste an example into an Appian Expression Editor to experiment with it.

Get the contents of a folder in CMIS

This example returns an array with the contents of the folder if the query is successful. Otherwise, it returns a message with the error encountered.

Replace the <folderId> text with a valid folder id in CMIS, e.g. workspace://SpacesStore/becc294e-e3df-4c8a-a548-9bbf61a29026.

=a!localVariables(
  local!cmisResult: a!cmiGetFolderChildren(
    scsExternalSystemKey: cons!CMIS_SCS_KEY,
    usePerUserCredentials: true,
    atomPubUrl: cons!CMIS_URL,
    repositoryId: cons!CMIS_REPO_ID,
    folderId: "<folderId>",
    pagingInfo: topaginginfo(0, 10)
  ), 
  if(local!cmisResult.success,
    local!cmisResult.result,
    local!cmisResult.error
  )
)

Feature compatibility

The table below lists this function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Partially compatible	Can be used with Appian Portals if it is connected using an integration and web API.
Offline Mobile	Partially compatible	Can be used with offline mobile if it is loaded at the top of the form.
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Incompatible	Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.

a!cmiGetFolderChildren() Function