a!cmiCopyDocumentFromAppian() Function

Function

a!cmiCopyDocumentFromAppian( scsExternalSystemKey, usePerUserCredentials, atomPubUrl, repositoryId, objectId, properties, appianDocument, appianDocumentVersion, appianDocumentAllowExpired )

Copies an Appian document to a location in the CMIS target system, specified by the value of the objectId parameter.

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 folder to which the Appian document will be copied.

properties

Any Type

The CMIS document properties, given as a dictionary. The string "cmis:" will automatically be included in the key name if no colon is present in key name. Example: {name:"test name", description:"test description"}

appianDocument

Document

The Appian document to which the document to copy to the target CMIS system.

appianDocumentVersion

Number (Integer)

The version number of the Appian document to copy to the target CMIS system. If no value is provided for this parameter, the current version of the document will be copied.

appianDocumentAllowExpired

Boolean

Determines if expired Appian documents can be copied. Default: true.

Returns

Writer

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

Example

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

Pick a document in Appian and copy to the specified CMIS folder ID

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
32
33
34
35
36
37
38
39
40
=load(
  local!appianDocument,
  local!cmisFolderId,
  local!cmiCopyDocumentFromAppianWriter: bind(
    null,
    a!cmiCopyDocumentFromAppian(
      scsExternalSystemKey: cons!CMIS_SCS_KEY,
      usePerUserCredentials: true,
      atomPubUrl: cons!CMIS_URL,
      repositoryId: cons!CMIS_REPO_ID,
      objectId: local!cmisFolderId,
      properties: {name: "Example Document"},
      appianDocument: _
    )
  ),
  {
      a!textField(
        label: "Folder Id",
        instructions: "The object id of the CMIS folder into which the Appian document will be copied",
        value: local!cmisFolderId,
        saveInto: local!cmisFolderId
      ),
      a!pickerFieldDocuments(
        label: "Select an Appian Document",
        instructions: "The selected document will be copied to the target CMIS site",
        maxSelections: 1,
        value: local!appianDocument,
        saveInto: local!appianDocument
      ),
      a!buttonArrayLayout(
        buttons: {
          a!buttonWidget(
            label: "Copy Document to CMIS",
            value: local!appianDocument,
            saveInto: local!cmiCopyDocumentFromAppianWriter
          )
        }
      )
  }
)
Open in Github

On This Page

FEEDBACK