VC/m is normally configured so that check-outs create a new version and copy it to the check-out location. This copy is then marked as the master copy of the new version (and therefore editable).
For the browser interface, with automatic registration, only one check-out route to a sandbox is needed (from the library). For the character-based interface, a second transfer route from the "NEW" location to the sandbox is needed. This is used for new objects which are created in the "NEW" location by default and have to be checked out from there to a sandbox before they can be edited.
To configure a normal check-out transfer route set the following values:
| Function code | By convention this is "OUT" although any other arbitrary function code could be used. If a value other than "OUT" is used, VC/m menus must be customized with new menu options which initiate transfers using this function code (eg ^%vc220("RESERVE") instead of ^%vc220("OUT")). |
|---|---|
| From location | This should be the location from which the object will be checked out. Typically this is a library which contains the master copy of the latest version. |
| To location | This is the location to which the object should be checked out. Typically this is a development location, work area or sandbox. |
| Access codes | A list of access codes (separated by commas) which designate which groups of users will be able to perform transfers using this transfer route. |
| Dependencies | Normally there is no need to specify any dependent locations for a check-out route. |
| New active locations | This should be the name of the location being checked out to (prefixed by a plus character), eg +Development. |
| New master location | This should be the name of the location being checked out to (eg Development). When an object is checked out the presence of the master copy in the checked-out location indicates that this version is editable. |
| Copy /move (Transfer type) | As you are creating a new version and you do not want to delete or affect the version from which it was created, this should be Copy (or C in the character-based interface). |
| Create new version? | Check this box (or enter Y in the character-based interface). This causes VC/m to increment the version number during check-out. |
| Audit trail level | A check-out is a significant event. Enter a low number (eg 10) to indicate that this is an important event. A high number (eg 90) indicates a less important event. |
| Audit trail message | Enter the text of the message that you would like to see in the audit trail for this event. "Checked out from %FROM" is a good default value. |
| Comments | When a system has a large number of complex transfer routes, it can be helpful to add a comment here to help understand the purpose of the transfer route at a later date. |
| Copy only if changed? | Leave this unchecked (or enter N in the character-based interface). |
| Status date behavior | Enter Hide to hide the status date prompt (or H in the character-based interface). |
| Status date caption | Leave this blank. |
| Function caption | This should already be "Check-&Out". |
To configure a check-out route for "NEW" objects set the following values:
| Function code | By convention this is "OUT" although any other arbitrary function code could be used. If a value other than "OUT" is used, VC/m menus must be customized with new menu options which initiate transfers using this function code (eg ^%vc220("RESERVE") instead of ^%vc220("OUT")). |
|---|---|
| From location | Enter "NEW" here. This is where newly registered objects are created. |
| To location | This is the location to which the object should be checked out. Typically this is a development location, work area or sandbox. |
| Access codes | A list of access codes (separated by commas) which designate which groups of users will be able to perform transfers using this transfer route. |
| Dependencies | Normally there is no need to specify any dependent locations for a check-out route. |
| New active locations | This should be the name of the location being checked out to (prefixed by a plus character), eg +Development. |
| New master location | This should be the name of the location being checked out to (eg Development). When an object is checked out the presence of the master copy in the checked-out location indicates that this version is editable. |
| Copy /move (Transfer type) | For a check-out from the "NEW" location, you should enter Move here (or M for the character-based interface). This removes the copy of the newly created object from "NEW", otherwise it will always appear there, which serves no purpose. Note: You will get a warning message explaining the potential dangers with using a Move type transfer route. In this circumstance it is OK to perform a move rather than a copy. |
| Create new version? | Check this box (or enter Y in the character-based interface). This causes VC/m to increment the version number during check-out. |
| Audit trail level | A check-out is a significant event. Enter a low number (eg 10) to indicate that this is an important event. A high number (eg 90) indicates a less important event. |
| Audit trail message | Enter the text of the message that you would like to see in the audit trail for this event. "Created" is a good value. |
| Comments | When a system has a large number of complex transfer routes, it can be helpful to add a comment here to help understand the purpose of the transfer route at a later date. |
| Copy only if changed? | Leave this unchecked (or enter N in the character-based interface). |
| Status date behavior | Enter Hide to hide the status date prompt (or H in the character-based interface). |
| Status date caption | Leave this blank. |
| Function caption | This should already be "Check-&Out". |
Last reviewed: Nov 9, 2004
Copyright 1997, 2005 George James Software.