Adding "About" information to a custom Lists tool

Tool developers can add descriptive information about the tool in the Lists designer. Workspace members must have access to the Lists tool designer to see this information.

  1. Enter the Designer.

  2. Click Settings and Options.

  3. Click the About this Tool tab.

  4. Enter or update the information in the Name, Version, and Description fields.

    See the section below for details about this information.

  5. Save and publish your changes.

About entering Name, Version, and Description information

The Name, Version, and Description provide a mechanism for external applications to identify a custom Lists tool and to document the design for other custom tool designers.

Including a Name, Version, and Description is recommended, but optional. There is no automated mechanism for incrementing the Version number; it is the responsibility of the lists designer to increment the Version number as needed.

Guidelines for specifying name and version number

Note the following guidelines for specifying the Lists tool Design name and incrementing the version number:

  • The Design Name is intended to be a unique string that identifies the organization that designed the Lists tool and the application class or purpose of the Lists tool. We recommend using the same URI format that is used in SharePoint Workspace to identify other templates. The URI has the general format of "urn:your-company-namespace:unique-name". If you are modifying a Lists tool template to create an entire new use for the Lists tool, you should give it a new URI.

  • The Design Version provides a mechanism for designers to document the modifications they make to a Lists tool template. Once a Lists tool template has been deployed and external applications have been developed to access the tool, it is important to provide information in the Design Version number so that application developers can ensure that their solutions are working with the correct version of the Lists tool. External applications may be affected when fields, views, and forms are added to the Lists tool, when new ones are added to it, or when an existing one is modified. Typically, external applications are not affected by modifications that are purely user interface design, such as moving a field in a form.

    The Design Version is an ordered set of 4 digits, delimited by periods, and is stored as a string. The Design Version conforms to the version identification scheme: (0.0.0.0). The four version digits represent from left to right:

    • Major version

    • Minor version

    • Custom version

    • Build number

The following guidelines are recommended for incrementing these numbers:

  • Major version: change indicates an incompatible Lists tool schema change. A major version upgrade of a Lists tool application should be considered a different application altogether. While functionally the application remains in the same application class, it is completely different from the perspective of its record data schema.

  • Minor version: change indicates that existing external applications should continue to work because no incompatible schema changes have been made. Note that in a minor version upgrade you can add new fields, forms, and views to a Forms tool but cannot delete or make schema modifications to existing ones.

  • Custom version: change is used typically to identify an update release for a specific customer, which has functionality or modifications to serve a specific purpose.

  • Build number: change is a designer specified increasing sequence used to associate a particular software build sequence to the forms application, typically used in build release management.

Share Facebook Facebook Twitter Twitter Email Email

Was this information helpful?

Great! Any other feedback?

How can we improve it?

Thank you for your feedback!

×