Working with files

After you upload a file to the repository, you can perform CMS file operations on the file such as check-out, open read-only, check-in, view dependents, and more.

Note: The Adobe Experience Manager settings in the Preferences dialog provide some more options to automatically checkout and check in files. See CMS > Adobe Experience Manager for more details.

Check out a file

To check out a file, right-click on a file and select Checkout. The file is checked out and opened for editing in FrameMaker.

When the file is successfully checked out, a check indicator appears on the file icon in the Repository Manager.

Check in a file

After you are done with making changes to a checked out file, check the file back into the repository. Check in allows other users to work with the updated file.

To check in a file, right click on the file that you want to check in and select Checkin. In the Checkin dialog, you can add comments to describe the changes you have made in the document. If the file is open in FrameMaker, it is checked in and closed.

Note: You can also add labels when you check in your AEM Guides files from FrameMaker. For more details, refer Add labels while checking files in AEM.

Cancel Checkout of a file

After making changes to a checked out file, you can choose to not check these changes back into the repository. In this case, you can cancel the file check out and release the file for other users.

To cancel the file check out, right-click on a checked out file, and select Cancel Checkout.

The file check out is canceled and the latest copy of the file is downloaded from the server. Other users can now check out this file.

Other operations on a file

Besides for the operations described above, you can also perform the following operations on files in the AEM repository:

Open

Open the file in the read-only mode without checking out the file.

Checkout With Dependents

If the file that you want to checkout has dependents, you can choose Checkout With Dependents to checkout all files at once.

View Dependents

Display the list of dependent or missing files.

Dependents Resolution: Multi-Level or One Level

When you work with files that have dependents, you can choose how many level of dependent files should FrameMaker resolve. By default, multi-level dependent files are resolved. This means that all references or dependents in the file are resolved. For a file having a lot of references, this operation could be time consuming. If you choose to resolve only one-level references, then only the direct references up to one level are resolved by FrameMaker. This improves the performance while opening or checking out a file.

Delete

If the file is not checked out, delete the file from the repository.

Explore

Locate the physical destination of the file on the local machine. This is available for only those files that have been checked out once.

Open on Server

Open the selected file in default browser.

Open file in AEM Web Editor

This option appears for all DITA files. Select this option to open the DITA file in the Web Editor. You can view and edit the DITA file in the Experience Manager Guides Web Editor.

Open DITA map in AEM Web Editor

This option appears for a DITA map. Select this option to open the DITA map in the Web Editor. You can view and edit the map in the Experience Manager Guides Web Editor.

Open DITA map in AEM Map Dashboard
This option appears for a DITA map. Select this option to open the DITA map in the Map Dashboard. You can view and edit the map in the Experience Manager Guides Map Dashboard.
View Metadata

Display the metadata associated with the file. You can also associate XMP metadata with a FrameMaker file, for details see XMP Metadata in FrameMaker and Adobe Experience Manager.

View Versions

Display the list of versions available for the selected file in the repository. In the Versions dialog, you can right-click on any file and perform the following operations:

  • Compare any two versions of the file

  • Open any previous version of the file

View Properties

Display the list of file properties such as created date, created by, server path, and more.

Refresh:

Refresh the current state of the file. For example, if you view the file as checked out by another user, the user then checks the file in. Refresh the state of the file after the other user checked the file in.

Add labels while checking files in AEM

FrameMaker allows you to add labels when you check in your AEM Guides files from FrameMaker. These labels are already defined in AEM Guides and appear as a dropdown list in FrameMaker. For more details, refer to Add labels section in the AEM Guides User Guide.

To add labels while you check in your file, right-click on the file that you want to check-in and select Check-in.



If your labels are not defined in AEM Guides, then you can add them in the Version Label category separated by commas.


Note: The check-in labels are displayed in the version history of the document in the AEM Guides user interface.

Unicode support for managing files through AEM connector

FrameMaker also provides support for Unicode characters in files and folders accessed or created through AEM connector. For example, you can use Unicode characters to add comments and version labels while checking in files. You can also use Unicode in the properties, version, or metadata for a file.

Figure 1. Unicode support for managing files through AEM connector

Note: You are recommended not to add spaces along with Unicode characters in the file and folder names.

Learn more about Unicode support in FrameMaker.