9 AutoNumbers

This chapter describes how to manage the automatic numbering of Agile PLM objects.

9.1 How AutoNumbers Are Used

From the AutoNumbers node, you can configure sources for automatic numbering in Agile PLM. For example, you can change the name of an autonumber source or its subclass assignments, or expand the sequence when necessary.

You can also specify your own prefix or suffix for an autonumber source, or create new autonumber sources. You can delete an autonumber source that is no longer needed provided that it has not been used to create an object in Agile PLM clients.

There are two types of autonumbers that can be used; a standard and a custom method. The standard method is to define a sequence by specifying the prefix, suffix, character set, and number of characters allowed. The custom method is more flexible and uses the process extensions framework to define any numbering sequence.

To use process extensions to create custom autonumber sources, you need to either purchase the Agile SDK or work with Oracle Consulting - Agile Practice or an Agile partner to develop process extensions that suit your company's needs. For more information about process extensions, see the Agile SDK Developer Guide.

9.1.1 Modifying an AutoNumber Source

You can modify any number source from the AutoNumbers node.

To modify an autonumber source:

Under Data Settings, double-click AutoNumbers. The AutoNumbers window appears.
Double-click a row to open that source's window (for example, the AutoNumber: Deviation Number window).
In any editable field, enter a new value or select from the drop-down list.
When you have finished, click Save.
To revert to the original settings or start over, click Cancel. You will be prompted whether you want to cancel the new settings in the window; click OK if you do or Cancel if you do not.

The autonumber properties are described in "Configuring AutoNumber Sources."

9.2 About AutoNumber Sources

An autonumber source is a predefined, consecutive number series used for the automatic numbering of objects created in Agile PLM clients. Each object in Agile PLM is assigned a number when it is created. You can allow users to choose between assigning numbers manually and letting Agile PLM assign numbers automatically, or you can prevent manual number assignment.

The Agile PLM administrator sets up the number assignment convention for the Agile PLM system from the following two administrative nodes:

From the Classes node, you assign specific autonumber sources to specific subclasses. See "Changing the AutoNumber Source Property."
From the AutoNumbers node, you configure the number sources themselves, including their names, whether they have a prefix or suffix, and how many numbers are in each sequence. You can view which subclasses are assigned to a specific number source, and you can configure this arrangement. You can also create new number sources or delete number sources that are not needed.

Autonumber sources are assigned to subclasses so that Agile PLM will know which number source to use when automatically assigning numbers to objects. A separate autonumber source is provided and assigned to most subclasses with your Agile PLM installation.

Several Agile PLM subclasses, such as Manufacturer and User, do not allow autonumbering.

To view the existing autonumber sources, double-click the AutoNumbers node. You can use the autonumber sources provided, or you can make any of the following changes to the configuration:

Create new autonumber sources using the New button.
Enable or disable an autonumber source using the Enable or Disable buttons.
Assign one or more autonumber sources to a subclass.
Assign one or more subclasses to an autonumber source.
Add a prefix or suffix to an autonumber source using the Prefix or Suffix field in the setup window.
Change the name of an autonumber source using the Name field in the setup window.
When all numbers in an existing autonumber source have been used, expand the number series using the Next Number field in the setup window.
Delete an autonumber source that is not needed using the Delete button.

Note:

For information about requiring automatic numbering, see "Preventing Manual Number Assignment."

If you create a new subclass, you can assign it any existing number sources for autonumbering, or create a new number source just for that subclass.

The following table lists the autonumber sources as configured at installation.

Table 9-1 AutoNumber sources configured at installation

Name	Where Used	Prefix	Number of Characters
ATO Number	ATO	ATO	7
Audit Number	Audit	Audit	5
Broker Number	Broker	BROKER	5
CAPA Number	CAPA	CAPA	5
Component Manufacturer Number	Component Manufacturer	COMMR	5
Contract Manufacturer Number	Contract Manufacturer	CTRMR	5
Contracts Number	Contract	CONTRACT	1
CTO Number	CTO	CTO	7
Customer Number	Customer	CUST	5
Declaration Number	Declaration	MD	5
Designs Number	Design	DESIGN	5
Deviation Number	Deviation	DEV-	6
Discussion AutoNumber	Discussion	D	5
Distributor Number	Distributor	DISTRIBUTOR	5
Document Number	Document	DOC	6
ECO Number	ECO	ECO-	6
ECR Number	ECR	ECR-	6
File Folder Number	File Folder	FOLDER	7
Gate AutoNumber	Gate	G	5
Historical Report File Folder Number	Historical Report File Folder	HFILE	5
Manufacturer Rep Number	Manufacturer Representative	MR	5
Markup Number	Markup	MARKUP	7
Mfr. Orders Number	MCO	MCO-	6
NCR Number	NCR	NCR	5
Package Number	Package	PKG	5
Part Number	Part	P	6
PCO Number	PCO	PCO	5
Phase AutoNumber	Phase	PH	5
PR Number	Problem Report	PR	5
Program AutoNumber	Program	PGM	5
Project AutoNumber	Project	PROJECT	7
Project Number	Sourcing Project	PRJ	5
Publish Price Number	Published Price	PRICE	5
Quote History Number	Quote History	QUOTE	5
RFQ Number	Request for Quote	RFQ	5
Site Change Orders Number	SCO	SCO	5
StopShip Number	Stop Ship	STOP-	6
Task AutoNumber	Task	T	5

9.3 Configuring AutoNumber Sources

Autonumber sources have the properties listed in the following table.

Table 9-2 AutoNumber source properties

Property	Description
Name	This is the name of the autonumber source. It might simply be the same as the subclass, or it might represent a further distinction, for example, Fasteners or Fasteners-Red. You can change this name.
API Name	Unique systemwide identifier for objects and can be autogenerated. You can specify an API name, but internal consistency is enhanced by accepting the system-generated name.
Description	A brief description about the autonumber source. This is an optional field.
Enabled	Whether this autonumber source is enabled (Yes) or not (No). The default is Yes.
Type	Standard or Custom. The default is Standard. Custom autonumbering is available to customers with SDK capabilities, which allow you to add a process extension that incorporates existing numbering schema. See "Process Extensions." Also see Agile SDK Developer Guide.
Prefix	Property of a standard autonumber. The characters that precede each number that Agile PLM automatically assigns for this autonumber source, for example, Acme000759 (Acme = prefix). You can change the prefix.
Suffix	Property of a standard autonumber. The characters that follows each number that Agile PLM automatically assigns for this autonumber source, for example, Acme000759SW5 (SW5 = suffix). You can change this suffix.
Character Set	Property of a standard autonumber. The characters that are entered in this property are used to create the autonumber. Appropriate for internal autonumber only. Character set can include only a-z, A-Z, 0-9; no special characters are supported.
Number of Characters	Property of a standard autonumber. Sets the number of characters to use or the length. So if "4" is entered, the numbering can be 0001-9999. Appropriate for internal autonumber only. Limit is 10, so this property can be populated only with 1, 2, 3, 4, 5, 6, 7, 8, 9, or 10.
Starting Number	Property of a standard autonumber. The first number that Agile PLM automatically assigns in the sequence. This property can be thought of as an arbitrary "next number."
Next Number	Property of a standard autonumber. While you can manipulate the "Starting Number" value, the Next Number simply reports what the system will use for the next offered autonumber.
Custom Autonumber	This property of a custom autonumber is only activated (and visible) when Type is Custom. A drop-down list field that you populate with your company's customized autonumbering system. The list of custom autonumbers reflects the set of custom autonumbers deployed on the Agile Application Server.

Note:

For ready-to-use subclasses, the defaults of AutoNumber Required = No and Autogenerate = Yes means that a number will be automatically generated when you create an object in that subclass; however, users can enter a new object number.

9.3.1 Changing an AutoNumber's Prefix or Suffix

The Prefix and Suffix properties identify the fixed string of letters or numbers that precede or follow an autonumber. For example, the autonumber prefix for parts is P, so all parts created in Agile PLM clients have numbers preceded by the prefix P, such as P00678. If the autonumber source also had a suffix of 00, number assignments would be followed with 00.

The Agile PLM administrator can change the prefix and suffix properties for an autonumber source. New objects created for subclasses that use this autonumber source have the new prefix or suffix in their autonumbers.

Note:

It is not recommended to change any properties other than Name, Description and Enabled for an autonumber already in use.

9.3.2 Changing Where an AutoNumber Source Is Used

The Where Used property shows you what subclasses use a particular autonumber source in Agile PLM. You can modify this property to permit additional subclasses to use the number source, or to prevent a subclass from using it.

To view or change subclasses that use a particular autonumber source:

Under Data Settings, double-click AutoNumbers. The AutoNumbers window appears.
Double-click a row, and that source's window appears (for example, the Deviation Number window).
On the Where Used tab, click the Add button.

The "Add classes to where used tab" dialog box appears, showing all subclasses that exist in your Agile PLM system. The subclasses listed in the Selected List list use this number source for objects created in Agile PLM clients. The subclasses listed in the Choice List list do not use this number source.
To change the configuration, double-click a subclass name to move it from one list to the other.
To save your changes and close the dialog box, click OK.
When you have finished, click Save.
To revert to the original settings or start over, click Cancel. You are prompted to confirm whether you want to cancel new settings on the window; click OK if you do or Cancel if you do not.

9.3.3 Custom AutoNumbers

Select a custom autonumber source from the list. You can create custom autonumber sources only if they have been deployed on the Agile Application Server using the process extensions framework. When you create a custom autonumber source, you select from the Custom Autonumber drop-down list. If no custom autonumber sources have been deployed, the list is empty.

9.3.4 Timeout

Enter the number of seconds after which a timeout error will occur if the custom autonumber source does not respond. The default is 30 seconds.

9.4 Creating a New AutoNumber Source

You can create a new autonumber source for user-defined subclasses if required.

9.4.1 Before You Begin

Consider the following details before creating a new autonumber source.

Which subclasses will use the new autonumber source?
What name will you give the new autonumber source?
Will the new autonumber source require a prefix? If so, what prefix?
Will the new autonumber source require a suffix? If so, what suffix?
What size number sequence is required?

To create a new autonumber source:

Under Data Settings, double-click AutoNumbers. The AutoNumbers window appears.
Click New. The Define the AutoNumber dialog box appears.
Fill in the Name, API Name and Description fields, and select Yes or No in the Enabled list.

Set the value in the Enabled list to Yes if you are ready to introduce this new number source to the Agile PLM system. The default is Yes in this dialog box, but it may be prudent to set it to No until the subclass is entirely set up.
Select the type of new autonumber:

If you selected Standard, fill in, as your company's needs require, the Prefix, Suffix, Character Set, Number of Characters, and Starting Number fields.

To prevent duplicating a number source, see "About AutoNumber Sources" for a list of the prefixes for autonumber sources already provided with your Agile PLM installation.

The Number of Characters setting determines how many autonumbers can be assigned. For example, if you enter 4 in the Number of Characters field, the range of numbers available for this series is from 0001 to 9999 (or a total of 9,999 numbers). Choose a value that will prevent the sequence from being exhausted in a short time.
If you selected Custom, fill in Custom AutoNumber and Timeout (seconds) fields.
Click the down arrow for the Where Used list. A dialog box appears, showing all subclasses that exist in your Agile PLM system. Since you are creating a new number source, the Selected field will be empty.
If you have already created the subclass that will use this number source, double-click the subclass's name in the Choices list to move it to the Selected list. If you have not created the subclass that will use this number source, this step cannot be completed; in this case, leave the Enabled field set to No.
To save your changes and close the dialog box, click OK.

The new name appears as a new object on the AutoNumbers window.

For information about how to prevent Agile PLM users from manually assigning numbers for this subclass, see"Preventing Manual Number Assignment."

9.5 Deleting an AutoNumber Source

The Agile PLM administrator can delete an autonumber source that is not needed, provided that it has not been used to create an object in Agile PLM clients.

If an autonumber source has been used to create an object, disabling it makes it unavailable for further use. See "Modifying an AutoNumber Source."

To delete an autonumber source:

Under Data Settings, double-click AutoNumbers. The AutoNumbers window appears.
Select the autonumber source you want to delete.
Click the Delete button.

If the autonumber source has already been used to create an object in Agile PLM clients, you see an error message stating that the object is already in use, and the Agile PLM system does not delete it.

If the autonumber source has not already been used to create an object in Agile PLM clients, a dialog box appears to confirm the deletion.
Click OK to confirm the deletion.

The autonumber source is deleted, and is no longer available for assignment to a user-defined subclass.