Self Service Process Unarchive (SSPU)

Overview

The Self Service Process Unarchive (SSPU) is an Appian plug-in and application that enables users to unarchive a subset of processes from within the Appian environment. This will be useful for most Appian Cloud customers as they do not have direct access to the server backend to either directly search for archived processes or to unarchive processes using a script.

Preconditions:

  • The Appian environment is on version 20.2 or higher.
  • The process(es) that will be unarchived has been logged to one of the removed_processes_db_PX*.csv logs.
  • The archived process(es) have not been automatically compressed or deleted on the filesystem.
  • The processes in the application must be started as a System Administrator for them to function as expected.

What the application will NOT do:

  • Support environments that are not single server or 3 node HA
  • Support the use of databases other than MySQL and MariaDB

== SSPU Application features ==

  • Ability to unarchive processes using information from the removed_processes_db_PX*.csv logs.
  • Supports parsing the logs on environments with multiple application servers.
  • Schedule when inserts to database, unarchives and archives are performed.
  • Archived Processes report to view archived processes currently in the Archived Processes table that is used in the application.
  • Process model ID to process model names mapping report for easy reference of process model names in the past.
  • After unarchiving processes, a task is created to rearchive processes so user doesn't forget to archive them to minimise memory usage.
  • Unarchive summary provides a support case template in the event it is detected that there are compressed or deleted processes that Support will have to manually verify/unarchive.

Key Features and Functionality

== SSPU Plug-in features ==

  • Insert Archived Processes To DB smart service
    • Parses the removed_processes_* logs on the server and inserts information about archived processes into a database table in batches to avoid a situation where disk increases too rapidly.
    • Accounts for HA environments to parse the logs in other nodes hosting an application server.
    • Uses a database table to keep track of removed_processes_* logs already parsed to minimise duplicate database inserts.
  • Unarchive Processes smart service
    • Unarchives archived processes that have not been compressed or deleted.
    • Outputs results of unarchive into different buckets depending on whether specific archived processes were unarchived or not.
      • unarchived
      • non existent
      • compressed or deleted
      • already unarchived
  • Archive Processes smart service
    • Archive processes that are completed in the environment.
    • Performed using the batch API call for improved speed.
    • Detects whether process was successfully archived or not.
Anonymous
  • After hours spent on the installation, I realized that the smart service for inserting the archived processes into DB only works with MySql and not with Oracle. Is there a way to make this work with Oracle db too? Thanks

  • Hello,

    I would like to suggest an improvement which is to allow configurable timeouts on calls to Stores Procedures. 

    We've had issue where the default 30s to execute the SP to update the list of process models is not enough and we've customized it ourselves.

    Many thanks.

  • Hi , 

    I am unable to update to the latest version , option is disabled in Cloud environment . 

    Please suggest !

  • We are getting the same error in Appian 22.2 Is there any way to deploy the app?

  • Hi, I wonder why the file removed_processed_PX* file is not being written. My last file as more than one month. How can i enable the logging to this file?

  • Hi,
    I am trying to install the application in our environment updated to version 21.4, and we get the following error in the 3 process models of the app.


    - processModel 0002e4e4-6349-8000-05ca-7f0000014e7a "SSPU Insert Archived Processes Into DB": An error occurred while creating processModel [uuid=0002e4e4-6349-8000-05ca-7f0000014e7a]: com.appiancorp.process.validation.ValidationException: Process Model is not valid. (APNX-1-4071-007)
    - processModel 0002e4e4-88a2-8000-05dd-7f0000014e7a "SSPU Unarchive Processes": An error occurred while creating processModel [uuid=0002e4e4-88a2-8000-05dd-7f0000014e7a]: com.appiancorp.process.validation.ValidationException: Process Model is not valid. (APNX-1-4071-007)
    - processModel 0002e4e4-8966-8000-05e0-7f0000014e7a "SSPU Archive Processes": An error occurred while creating processModel [uuid=0002e4e4-8966-8000-05e0-7f0000014e7a]: com.appiancorp.process.validation.ValidationException: Process Model is not valid. (APNX-1-4071-007)


    In the app specifications it only supports 20.2 and 20.3.


    Could this be the problem?
    Thanks

  • thanks Richard,

    i forgot to update that one

    it's working now

    thanks again for the help :) 

  • Hi Andre, thanks for letting me know. Just to rule out the version, can confirm whether the latest version (v1.0.1) of the plugin is currently deployed in your environment? The quickest way to check would be to go to the plugins page in the admin console (/suite/admin/page/plugins).

  • Hi Richard, we seem to have another error this time, but very similar
    I've provided the output from the log below.

    Cheers, Andre

  • Hi Stephan,

    The plugin has been updated so the process shouldn't fail when parsing your process names anymore.