a!cmiDelete() Function

Function

a!cmiDelete( scsExternalSystemKey, usePerUserCredentials, atomPubUrl, repositoryId, objectId, allVersions )

Deletes an object in the CMIS target system.

See also: Writer, bind().

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.

objectId

Text

The object id of the CMIS object to delete.

allVersions

Boolean

Determines if all versions of the object should be deleted when applicable. Default: true.

Returns

Writer

This function returns a writer and must be used with the bind() function.

Examples

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

Delete an object in CMIS

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
=load(
  local!cmisObjectId,
  local!cmiDeleteWriter: bind(
    null,
    a!cmiDelete(
      scsExternalSystemKey: cons!CMIS_SCS_KEY,
      usePerUserCredentials: true,
      atomPubUrl: cons!CMIS_URL,
      repositoryId: cons!CMIS_REPO_ID,
      objectId: _,
      allVersions: true
    )
  ),
  {
      a!textField(
        label: "CMIS Object Id to Delete",
        value: local!cmisObjectId,
        saveInto: local!cmisObjectId
      ),
      a!buttonArrayLayout(
        buttons: {
          a!buttonWidget(
            label: "Delete Object",
            style: "DESTRUCTIVE",
            value: local!cmisObjectId,
            saveInto: local!cmiDeleteWriter
          )
        }
      )
  }
)

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.

Custom Record Field Expressions Incompatible
Process Reports Incompatible

You cannot use this function to configure a process report.

Process Events Incompatible

You cannot use this function to configure a process event node, such as a start event or timer event.

Open in Github Built: Mon, Dec 05, 2022 (08:15:30 PM)

On This Page

FEEDBACK