Login allows user to establish connection between Adobe FrameMaker and Document Server.

1. First time users will see the placeholders required for authentication empty in the Linked2 window when they select any of the option from the Linked2 Menu in Adobe FrameMaker (Checkin, Checkout, Cancel Check Out or Search). Users need to provide following details in the corresponding placeholders:
   • Username
   • Password
   • Host (Link where the Documentum server 6.5 is hosted)
   • Port
2. After successful authentication with the Documentum server, it populates the list of repositories in the <repository> drop down for which user has permissions. If authentication fails then an error message is displayed.
3. User needs to check “Remember me” option at the time of Login to save and remember the login details for the next time.
4. When the user closes Linked2 window, user session also closes. User will be prompted again to Login when the select any of the option from the Linked2 menu in Adobe FrameMaker.

Checkin allows user to add a new file or modify an existing Checkout file to Documentum server. All the changes made to Checkout file will be updated to the Documentum server when the user checks in.

User can Checkin following types of file:

• XML Type
  • DITA (Full DITA support with nesting)
  • Non DITA (Treated as Single file)
• Other Type (Treated as Single file)

Checkin a new file:

1. Click on Checkin option in Linked2 menu on Adobe FrameMaker.
2. After successful Login, Linked window open with Checkin tab.
3. Browse to the location of the file which needs to be Checkin by clicking on Browse option.
   (Note: Select a DITA-XML file as Linked2 application supports DITA Task, DITA Concept, DITA Map and reusability via Conref, Href, Xref)
4. Enter the documentum path where the file needs to be stored.
5. Click Checkin. Once the file is checked in successfully a message is displayed “Checkin Successfully”.

Checkin an existing Checkout file:

1. Click Checkin option from the Linked2 menu in Adobe FrameMaker if a file is already checked out and open in Adobe FrameMaker.
2. A popup message will be displayed with the message “File will be closed for Checkin”.
3. Click OK to Checkin the file or Cancel not to checkin the file.
4. “Checkin Successful” message is displayed after file is checked in successfully.
5. File is checked in at the same location on the document server from where the file was checked out.

(Note: If an already checked out the file is not open in FrameMaker, then we need to follow the same steps as in Checkin a new file)

When the user checks out a file, it will be available for modification only for that user. Other users can not access that file for modification unless the current user checks in. Checkout actually works as a lock on the file. When checkout is performed, the file is copied to the user’s machine and Read-only copy will be available for other users.

1. Click on Checkout option in the Linked2 menu option of Adobe FrameMaker to check out a file.
2. After successful Login, Linked2 window opens with Checkout tab.
3. Navigate to the file which needs to checked out using Cabinets/Folders.
4. Select the file which needs to be checked out from the Files section.
5. Click on Checkout button.
6. User can check out the file using three option which will be displayed when clicked on Checkout button:
   • All, root and descendents: Parent and children will get checked out.
   • Root: Only Parent will get checked out.
7. After the file is checked out it would open in Adobe FrameMaker. (Note: At the time of Checkout the copy of the file from the documentum server is made at the location: C:\Documents and Settings\User\Documentum\Checkout).
8. User can edit the file that is open in Adobe FrameMaker. After modifying the file user can the check in the modified file using Checkin functionality.
9. The checked out file will be locked for other users and a key symbol is displayed be the file in the file section in Checkout screen of Linked2 window.

User can view the file by using this functionality. The only difference between Checkout and View is that, in View a Read Only copy will be available and the user cannot modify this file where as in Check-out, the file is available for modification.

1. Click on Checkout option in the Linked2 menu option of Adobe FrameMaker to check out a file.
2. After successful Login, Linked2 window opens with Checkout tab.
3. Navigate to the file which needs to checked out using Cabinets/Folders.
4. Select the file which needs to be opened in View (Read Only) mode from the Files section.
5. Click on View(Read Only) button.
6. File opens in Adobe FrameMaker in read only format. User cannot edit this file.

If the user doesn’t want to modify the file nor do they want the file to be updated with modifications after checkout, cancel checkout can be performed. The file will be reverted back to its previous version without any changes and lock will be removed on this file.

1. Click on Cancel Checkout option in the Linked2 menu option of Adobe FrameMaker to check out a file.
2. After successful Login, Linked2 window opens with Cancel Checkout tab.
3. Select the file/files from the list and Click Cancel Checkout button.
4. A popup message will be displayed after the file/files are Cancel Checkout. Click on Yes to refresh the screen.

Note:

• If user wants to Cancel Checkout only descendent, then select only descendent file.
• If user select the root file and click on Cancel Checkout, then the root as well as descendants will also be reverted to previous version.

Search functionality enables the user to search for files to be modified/ viewed in the Documentum Server.

Simple Search:

User can just enter the keyword and search.

1. Click on Search option in the Linked2 menu option of Adobe FrameMaker to check out a file.
2. After successful Login, Linked2 window opens with Search tab.
3. User can enter a Keyword into “Contains” field and click on “Search” button.
4. After search is completed list of the files are displayed in the Search Result window.
5. User can then select the file and Checkout or View Read Only.

Advanced Search:

User can specify location, object type, properties, date, size etc and the search the file.

1. Click on Search option in the Linked2 menu option of Adobe FrameMaker to check out a file.
2. After successful Login, Linked2 window opens with Search tab.
3. User can enter a Keyword into “Contains”, select Object type, specify location and properties etc and click on “Search” button.
4. After search is completed list of the files are displayed in the Search Result window.
5. User can then select the file and Checkout or View Read Only.