Expand my Community achievements bar.

SOLVED

Is there a Projects Management best practices guide

Avatar

Level 5

I have searched the AEM Guides documentation, the AEM 6.5 documentation, and Experience League and I'm not seeing any details about managing AEM Projects. Is there another documentation source that I'm missing?

We have more than 1000 Projects listed in the AEM repository's Projects folder, both AEM Projects and AEM Guides translation projects. Archiving doesn't seem to be an option for the completed translation Projects I've looked at. Are completed Projects supposed to be deleted? If so, this doesn't remove any of the files inside that Project, does it? How are completed Projects meant to be handled?

 

Versions on Production (Prod)
AEM Guides (UUID) 4.4 On-Prem Installation (24 Jun 2024)
AEM 6.5.19 (Service Pack 19) On-Prem Installation (15 Jan 2024)

1 Accepted Solution

Avatar

Correct answer by
Employee

@sschnelbach : there are different processes that organizations may follow for different types for projects, to explain:

 

In general, when a new project is created there are few aspects that account to maintenance:

  • user groups created to manage roles and permissions within that project.
  • metadata created to define purpose and processing of the project
  • workflows/tasks that may run around this
  • temporary files that may be created applicable to operate at different phases of project

Based on different requirements, the projects are deleted either manually or setup to be deleted automatically.

 

Let us understand how projects specific to AEM Guides can be handled for archival or retention and options available to handle these automatically.

 

Project Type: Translation

Retention needs: to retain the project to track translation progress, review and approve the translated content and revisit what was translated   

Impact of its volume: these projects can grow in numbers with time as each project is created for specific combination of source and target language and different users may create it for the content they work on. And on top each project creates several user groups for access, so the user groups in system will also grow quickly and should be avoided. The temporary files also account to repository size. The number of open projects also impacts the reporting and querying on translation project jobs.

Recommendation on archival: Once the project is translated it is best that:

  • its status is changed to inactive immediately, as active projects directly impacts ongoing translation projects
  • project should be deleted [1] (including the Project Assets Folder, as you don't need the temporary files after the translation is completed) once the content is reviewed and approved, without that the user groups are not cleaned up and will have effect on the general system performance (if there are huge number of projects)

And to support the best practice for translation, webeditor has introduced configuration on settings panel that can assist with cleanup - as pointed out in the release notes for last cloud release - this will be available in upcoming non-cloud release (4.6)

 

 

Project Type: Review

Retention needs: to retain the review data for audit purpose. The projects are also reused/repurposed for multiple reviews sub-projects as each review project has a dashboard for review tasks

Impact of its volume: these projects can be limited in number and hence can stay in system for longer as there are minimal metadata or user groups, and the ongoing tasks are archived as completed based on maintenance jobs that cleanup workflow data. Workflow cleanup is part of maintenance that can be scheduled under Operations

Recommendation on archival: all the review related data is kept in a separate data store hence even if the workflows are purged the content is available to revisit. However the projects should not be deleted if the review manager needs to audit the reviews via dashboard. If there are no audit requirements then the projects can be deleted once it completes its purpose. This will release any metadata like user groups or temporary assets etc.

 

 

I hope this helps.

 

 

[1]: https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/sites/administer...

View solution in original post

4 Replies

Avatar

Employee

Here is the link-> https://experienceleague.adobe.com/en/docs/experience-manager-guides/using/release-info/release-note...

 

Validate the same if it's available in the version you are using.

If it's not supported, you can create a custom workflow to delete the completed project.

Avatar

Level 5

This option does not appear to be available to me, but I can delete my old Translation Projects.

 

Can you confirm that the Translation Project management best practice is to delete the Project, including the Project Assets Folder, after the translation project is completed? Since that sounds like it would also delete all those FMLANG files that appear during GUID searches, that would be great.

Avatar

Correct answer by
Employee

@sschnelbach : there are different processes that organizations may follow for different types for projects, to explain:

 

In general, when a new project is created there are few aspects that account to maintenance:

  • user groups created to manage roles and permissions within that project.
  • metadata created to define purpose and processing of the project
  • workflows/tasks that may run around this
  • temporary files that may be created applicable to operate at different phases of project

Based on different requirements, the projects are deleted either manually or setup to be deleted automatically.

 

Let us understand how projects specific to AEM Guides can be handled for archival or retention and options available to handle these automatically.

 

Project Type: Translation

Retention needs: to retain the project to track translation progress, review and approve the translated content and revisit what was translated   

Impact of its volume: these projects can grow in numbers with time as each project is created for specific combination of source and target language and different users may create it for the content they work on. And on top each project creates several user groups for access, so the user groups in system will also grow quickly and should be avoided. The temporary files also account to repository size. The number of open projects also impacts the reporting and querying on translation project jobs.

Recommendation on archival: Once the project is translated it is best that:

  • its status is changed to inactive immediately, as active projects directly impacts ongoing translation projects
  • project should be deleted [1] (including the Project Assets Folder, as you don't need the temporary files after the translation is completed) once the content is reviewed and approved, without that the user groups are not cleaned up and will have effect on the general system performance (if there are huge number of projects)

And to support the best practice for translation, webeditor has introduced configuration on settings panel that can assist with cleanup - as pointed out in the release notes for last cloud release - this will be available in upcoming non-cloud release (4.6)

 

 

Project Type: Review

Retention needs: to retain the review data for audit purpose. The projects are also reused/repurposed for multiple reviews sub-projects as each review project has a dashboard for review tasks

Impact of its volume: these projects can be limited in number and hence can stay in system for longer as there are minimal metadata or user groups, and the ongoing tasks are archived as completed based on maintenance jobs that cleanup workflow data. Workflow cleanup is part of maintenance that can be scheduled under Operations

Recommendation on archival: all the review related data is kept in a separate data store hence even if the workflows are purged the content is available to revisit. However the projects should not be deleted if the review manager needs to audit the reviews via dashboard. If there are no audit requirements then the projects can be deleted once it completes its purpose. This will release any metadata like user groups or temporary assets etc.

 

 

I hope this helps.

 

 

[1]: https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/sites/administer...

Avatar

Administrator

@sschnelbach Did you find the suggestions helpful? Please let us know if you require more information. Otherwise, please mark the answer as correct for posterity. If you've discovered a solution yourself, we would appreciate it if you could share it with the community. Thank you!



Kautuk Sahni