Activities

This documents describes important Activities used in Document Management. While there are a number of Activities whose interfaces are easily understandable, there are some that need additional explaining. This section aims to document those Activities only. You should refer to the model or Interface Browser to see a full listing of the Activities currently available in Document Management.

When to use this information:

Use this page when you need information on how to use more complex Activities in Document Management.

Contents

Activity EditDocument for Check In Process

public String startCheckIn(final DocumentRevision documentRevision) throws IfsException

This is the first of the two methods that must be called as part of the Check In process. The other is finishCheckIn(). This method checks to see if the current user has rights to perform a Check In on the current document, and if so, returns an authentication ticket to the caller. Also note that it is sufficient to pass an instance of DocumentRevision with only the key attributes (DocClass, DocNo, DocSheet, DocRev) set. Upon calling this method, the status of the DocumentFileReferences of this DocumentRevision are changed to Operation In Progress, and the DocumentRevision (an IN-OUT parameter) is modified to contain all of the document's attributes including a reference to DocumentTitle and an aggregation of the DocumentFileReferences connected to this document.

public void finishCheckIn(final DocumentRevision documentRevision, CheckInTypeEnumeration.Enum checkInType, String fileTransferTicket) throws IfsException

This is the second of the two methods that must be called as part of the Check In process. The first is startCheckIn(). This method checks to see if the current user has rights to perform a Check In on the current document, and if so, checks in the files uploaded to the File Transfer Service. Note that when calling this method, the DocumentRevision passed must contain the set of DocumentFileReferences to be checked in. This collection of references is then iterated by this method and each of the files are checked in to the document repository, and their file states are changed to Checked In. This method will finally delete the ticket directory.

There are two common scenarios of Check In:

  1. Check In Existing - A document revision with existing file references that were previously checked out is now being checked in. In this scenario the caller may optionally add some new references.
  2. Check In New - A document with no file references is being checked in with new file references. In this scenario all references added are new.

When adding a new DocumentFileReference to the DocumentRevision, the caller is required to set the DocClass, DocNo, DocSheet, DocType, FileType (optional) and the UserFileName properties of the reference. On the other hand an existing reference must have the LocalFileName attribute set instead of the UserFileName. Ideally, when calling this method, you would make use of the same DocumentRevision instance used when calling startCheckIn() as this instance would already contain the list of DocumentFileReferences that needs to be checked in. The parameter checkInType takes values EXISTING or NEW depending on the two scenarios described above.

 

Activity EditDocument for Check Out Process

public String startCheckOut(final DocumentRevision documentRevision, DocumentFileNameTypeEnumeration.Enum fileNameType) throws IfsException

This is the first of the two methods that must be called as part of the Check Out process. The other is finishCheckOut(). This method checks to see if the current user has rights to perform a Check Out on the current document, and if so, checks out the files from the repository to a new ticket directory and returns the ticket to the caller. Also note that it is sufficient to pass an instance of DocumentRevision with only the key attributes (DocClass, DocNo, DocSheet, DocRev) set. Upon calling this method, the status of the DocumentFileReferences of this DocumentRevision are changed to Operation In Progress, and the DocumentRevision (an IN-OUT parameter) is modified to contain all of the document's attributes including a reference to DocumentTitle and an aggregation of the DocumentFileReferences connected to this document. The parameter fileNameType can take values DOCMAN_FILE_NAME or USER_FILE_NAME depending on how the caller wants the files to be named.

public void finishCheckOut(final DocumentRevision documentRevision, String checkOutPath, String fileTransferTicket) throws IfsException

This is the second of the two methods that must be called as part of the Check Out process. The first is startCheckOut(). This method checks to see if the current user has rights to perform a Check Out on the current document, and if so, sets the status of the DocumentFileReferences to Checked Out, and deletes the ticket directory. Note that it is sufficient to pass an instance of DocumentRevision with only the key attributes (DocClass, DocNo, DocSheet, DocRev) set. The method fetches the list of references and iteratively sets their file states to Checked Out.