Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Current »

Difficulty: novice

Content

Learning Objectives

After reading this article, you’ll be able to:

  • Identify a reference in Workplace Management.

  • Change the object reference.


The object reference pattern

Every object in Workplace Management receives a unique reference. The object reference consists of letters referring to the object and numbers referring to the instance number in the sequence. Together, they make up a unique reference for every instance in Workplace Management. By default, the object reference naming is logically structured. Some references start with the year, followed by a dynamic number. Every time a new instance is created in Workplace Management, this number increases by 1.

 Examples of object references

Examples of object references

Below, you can see a list of the most commonly used objects in Workplace Management:

  • The Contact object is using CON-yy000.

  • The Request object is using REQ-000000.

  • The Asset object is using AST-000000.

  • The Catalog item object is using CAT-000000.

  • The Work order object is using WRK-yy0000.

  • The Property object is using PRP-000000.

  • The Area object is using SP-0000.

  • The Reservation object is using RES-yy00000.

  • The Contract object is using CTR-yy000.

  • The ObjectReport object is using “Client”-REP-000

  • The Document object is using D-yy00000.

It is possible to enter a date formatting pattern (yy=year, mm=month, dd=day) as part of the reference pattern.

 Redefine an object reference

Redefine an object reference

Even though the object references have been pre-defined in the baseline, creating a client-specific reference pattern is possible.

Please keep in mind that the default reference names are commonly known by developers, consultants, and existing clients working with Workplace Management. Therefore, only change the reference name if absolutely necessary as this complicates the use and the management of the environment.

In the example below, we will change the object pattern for the object “Request.”

  1. Search for the relevant object; in our case, the object is Request, using the Object button on the startboard;

  2. Open the object by clicking on the hyperlink in the column Name;

  3. Access the settings of the object by clicking on the Gear icon” in the top right corner;

  4. Click on New to generate a new reference pattern.

    1. In the following section, we will go over the reference pattern settings.

  5. After adjusting the settings, click on Save and return;

  • If applicable, you will notice the default reference pattern for the object is already defined in the settings list. When a new pattern is created, the latest one will overrule the existing patterns in the list.

  • A reference is unique and generated at the time of creation on an instance. Thus, changing the pattern after creating an instance will not update the existing references.

 Reference pattern settings

Reference pattern settings

In the table below, you will find the reference patterns explained.

Setting

Explanation

Object

Refers to the object for which the pattern is applicable. Refrain from attempting to change this.

Pattern

The pattern indicates the format the object reference follows.

Pattern override

It is possible to redefine the default pattern. When this field is populated, the value in the field “Pattern” will be replaced.

Recognition pattern

A regular expression that can automatically discover if some text conforms to this reference. This is used, for instance, when creating areas through a DWF import.

Individual reference pattern

Setting not used in the adaptive user interface.

Latest reference

The latest reference determines the start value of the sequence.

Type

It is possible to specify on which type (enumeration) this pattern should be applicable. Note: The reference is created based on the type specified for the instance at the moment of creation. Switching the category after creating the instance will not generate a new reference.

Category

It is possible to specify which category this object reference pattern should apply to. Note: The reference is created based on the category specified for the instance at the moment of creation. Switching the category after creating the instance will not generate a new reference.

Sort field

When this field is set, the instances will be sorted in a list based on the value of this field. By default, the list view sorts on the reference in an ascending manner. However, this setting will deviate from default.

Prefix field

Setting is not used in the adaptive user interface.

Append prefix

Setting is not used in the adaptive user interface.

 Reference pattern on the general ledger

Reference pattern on the general ledger

The accounting module in Workplace Management allows the user to specify a unique reference pattern for outgoing and for incoming invoices per general ledger. It is possible to have multiple general ledgers running simultaneously; thus, this option allows the user to more easily identify which general ledger an invoice is connected to.

To set a unique reference pattern for invoices on a general ledger:

  1. The General Ledger can be found under the Accounting module in the Navigation menu;

  2. Open a general ledger by clicking on the hyperlink in the Reference column;

  3. Click on the Settings tab;

  4. Fill in a unique pattern for incoming and outgoing invoices.

If these fields are left empty, the default reference pattern for the general ledger object will be applicable.

Summary

  • No labels