Working in a Version-Controlled Environment

In Loftware Enterprise™ SP, you can use version control The ability to maintain distinct versions of a label template or other object. An object is checked out to be modified, and checked in to save a new version. After a version is checked in, that version cannot be changed. to retain multiple versions of objects that support version control The following types of objects are version controlled when saved in a version-controlled folder: label templates, forms, images, layer objects, layouts, reusable objects, field data catalogs, applications, business rules, processes, workflow templates, and data services. Images do not support minor versions. and to roll back to a previous version if necessary. In a multi-user environment, you can use version control to help ensure that users do not accidentally overwrite each other's work.

Creating version-controlled items

Any object that can be version controlled that you create in a folder for which version control is turned on will be version-controlled. Version control can be enabled or disabled only during the creation of a folder. After a new folder has been saved, its version control setting can no longer be changed. Any object that is created in or saved into a folder becomes version-controlled if version control is turned on for that folder.

Note: If you save a copy of a version-controlled object into a different folder, the version control history is not propagated to the new instance.

Note: You cannot import an object from an import (SER) file into a folder in which an object with the same name already exists unless the folder is version-controlled and the object in the folder is checked in. If you import an object into a folder in which an object with the same name already exists, the version numbers use the following behavior:

If the exported object is a minor version, then the minor version number of the object is incremented. For example, if the object was version 1.5 before the import, then it will be version 1.6 after the import.
If the exported object is a published (major) version, then the version number of the object is published to the next major version. For example, if the object was version 1.5 before the import, then it will be version 2.0 after the import.

Recognizing version-controlled items

When you open a version-controlled object, the Version is displayed in the bar at the bottom of the editing pane in Label Design or Process Design . A lock icon is also displayed in this bar if the object is checked in. Also, in the File menu, the Version Control > Check In option is available if the item is checked out, and the Version Control > Check Out option is available if the item is checked in and you have the permissions needed to check out the item.

Checked-in version-controlled label template

Checked-out version-controlled label template

Version-controlled folders are identified in console trees where they appear by the icon Folder with version control . In a console tree, if a label template is checked out, it is identified by the icon Label template, checked out . If checked in, it is identified by the icon Label template, checked in .

Understanding version numbers

A major.minor numbering scheme is used to differentiate between published versions (major versions) and minor versions of an object. Images have only published versions. Layouts must be published before they are available for attachment to a label template.

The first time that an object is checked out, the Version is 0.1. The minor version is incremented each time that a user checks out the object. Merely saving an object does not change its version.

When an object is published, its major version number is incremented and its minor version number is set to zero. For example, if you have a label template with a version of 1.3, publishing that label template creates a version 2.0.

Note: For a version-controlled reusable object to be displayed in Label Design , the reusable object must be in the Reusable Objects folder or a subfolder and the reusable object must be published.

Printing and version control

By default, the latest available version of a version-controlled object is selected when you print an object . However, the versions available for you to print can be limited by your permissions. If you have the necessary permissions for printing from Label Design , then you can print any published version When version control is used, a version for which the minor version number is zero. Users with some permissions can print only the latest published version. or minor version except a version that is checked out to another user. Otherwise, you can print only the latest published version.

A Data Provider Person or process that enters data into a form or other data entry view for a label that was configured by a Designer. A user acting as a Data Provider requires the DOCUMENT_PRINTER role or equivalent permissions. typically has only the permissions necessary to view and print published versions. For a Data Provider, the latest version is the latest published version.

Checking in a version

A checked-in version cannot be altered. The most recently published version When version control is used, a version for which the minor version number is zero. Users with some permissions can print only the latest published version. can be rolled back and deleted if no minor version has been checked in after that published version. If the most recently published version is immediately preceded by other published versions, they can also be rolled back and deleted. Other than those exceptions, although an entire object can be deleted, individual versions of it cannot be deleted separately.

Checking out before making changes

Before you begin making changes to a version-controlled object, you should check it out so that you will be able to save and check in changes when finished. Checking out an object also prevents other users from making changes to it at the same time and from viewing your version until you check it in. If you do not check out a version-controlled object before changing it, then you must save your changes to a new object to retain them. Otherwise, the changes will be discarded when the object is checked out.

Publishing objects

Typically, the latest published version of an object is used for printing and within business rules and processes.

Because some users do not have the permissions necessary to print minor versions of a version-controlled label template, you may need to create a published version When version control is used, a version for which the minor version number is zero. Users with some permissions can print only the latest published version. of a label template for review. Because a version-controlled field data catalog must be published before it can be attached to a label template, you may need to create a published version of a field data catalog for review. You can do so by publishing the object in place.

Requesting review and approval of a label template (workflow)

If your Loftware Enterprise SP environment is using workflow, you can request review of a label template or layer object by starting a workflow. For more information, see Using Workflows.

Approving or rejecting a label template (workflow)

If your Loftware Enterprise SP environment is using workflow, you may be responsible for reviewing and approving a label template or layer object that someone else has edited. For more information, see Using Workflows.

Requesting that a label template be published to another folder

Your LOCAL_ADMIN A Loftware role with most administrator permissions as well as all of the permissions for a DOCUMENT_DESIGNER and a DOCUMENT_PRINTER. By default, all pages are displayed to users with this role. may configure separate folders for development (where you create and edit objects) and production (where released objects are stored), or for any situation in which objects are edited in one folder and must be moved to another. If you are a Designer Person who creates and designs label templates, forms, and applications for use by Data Providers., you may not have the necessary permissions to publish objects to the production area. When an object is ready to be released, request that a LOCAL_ADMIN A Loftware role with most administrator permissions as well as all of the permissions for a DOCUMENT_DESIGNER and a DOCUMENT_PRINTER. By default, all pages are displayed to users with this role. publish the object to the production area.

Alternatively, you may have the permissions necessary to export an object to a separate file and import it into another folder.

If the exported object is a minor version, then the minor version number of the object is incremented. For example, if the object was version 1.5 before the import, then it will be version 1.6 after the import.
If the exported object is a published (major) version, then the version number of the object is published to the next major version. For example, if the object was version 1.5 before the import, then it will be version 2.0 after the import.

Best Practices

If label templates that you create are typically copied from one folder to another, it is recommended that you save layouts and label templates in separate folders to prevent confusion. Administrators can copy all label templates and layouts in a folder to a second folder. If associated layouts and label templates are mingled in the same folder, when an administrator copies all items in the folder to a second folder, label templates in the second folder still point to the layouts in the original folder.

Note: You must publish a field data catalog before it can be attached to a label template. You can attach a version-controlled layout to a label template before the layout is published; however, you must publish a version-controlled layout before printing a label template containing the layout or the print job will fail.

Note: Each version of an object can have different tags applied.