Skip to main content
March 11, 2023
Solved

Folder in appian()

  • March 11, 2023
  • 3 replies
  • 0 views

I'm creating an Appian web API to retrieve documents from our Appian system and link them with our other systems.

To that end, I'm utilising Appian's folder() function to gather information about the contents of a folder.

folder(
    theCaseFolder,
    "documentChildren"
)

The issue I'm facing is that, while this code works most of the time, we have some instances with over 1000 documents recorded against the case. I notice in the Appian documentation that:

The documentChildren and folderChildren properties provide the top 1000 documents or folders that are direct offspring of the specified folder, accordingly.

My issue is that we have a few cases where there are over 3000 papers attached. Is it possible to obtain a list of those kid documents, or am I completely out of luck?

    Best answer by stefanhelzle0001

    When creating an API that should return lists, you always have to implement a paging mechanism to reduce the volume of transported data.

    In my applications, I always store some document metadata to the DB. This would make building an API very simple as I can query the data from DB. Not sure whether that would work for you.

    There are some plugins with alternative implementations of getting documents from folders. Did you try that way?

    3 replies

    richardm900458
    March 11, 2023

    1000 is sadly often times the magic appian number. e.g. Task instances or in the case for the folder function.
    "The documentChildren and folderChildren properties return up to the first 1000 documents or folders, respectively, that are direct children of the selected folder. Results are returned in alphabetical order by name." 
    from
    https://docs.appian.com/suite/help/23.1/fnc_scripting_folder.html


    the questions is: why do you need more for retrieving the right document?
    wouldn't work a folder structure like per week/per month?

    stefanhelzle0001
    Brainy
    March 12, 2023

    When creating an API that should return lists, you always have to implement a paging mechanism to reduce the volume of transported data.

    In my applications, I always store some document metadata to the DB. This would make building an API very simple as I can query the data from DB. Not sure whether that would work for you.

    There are some plugins with alternative implementations of getting documents from folders. Did you try that way?

    March 12, 2023

    well it worked thank you