Article ID: 5344, created on Jun 4, 2008, last review on Apr 29, 2014

  • Applies to:
  • Plesk Billing

Resolution

Creating Custom Attributes

You can create three types of custom attributes in Plesk Billing:

  • Product Attributes
  • Order Form Attributes (Client Attributes)
  • Generic Attributes

Product Attributes

Product attributes do not affect pricing. They creates questions that will appear during the order process. Answers to these questions will create package attributes. If the package attribute modifies an already existing attribute, Plesk Billing should be able to pass this value to the panel module to be automatically provisioned. Product attributes that create new attributes will not be provisioned.

Setting up Product Attributes

Step One

Go to System -> Order Settings -> Custom Attributes. From here you will see three opions: "New Generic Attributes", "Manage Questions", and "New Product or Order Form Attributes". "New Generic Attributes" and "Manage Questions" are options that are used intenally only, clients will not see these questions and the values need to be entered by the admin. "New Product or Order Form Attributes" are used to collect information through the order from from a client to be tied to either the client or the client's package.

Step Two

Click on "New Product or Order Form Attributes". A popup window will appear. Enter a descriptive name for the attribute you're going to enter. This is something that only the admin will see. Then click Edit.

Step Three

You should now see a new line item, containing the name you just assigned. Click on the green pencil next to Null. Choose Product Attribute. Click Edit.

Step Four

Next is the Association field. This will decide which product this attribute is tied to. If you want to have the same attribute tied to several different products, you will need to create an attribute for each of them. You can use the same custom question over and over (this will be created in the next step), but each product must have it's own attribute.

Step Five

Now we will create the question to be tied to this attribute. Click on "Manage Questions". From this new screen, click on "Add Custom Question". There are several fields here:

Name:
Choose a descriptive title for this question. This is an internal value, and your client's will not see it.
Display Order:
This can be set at whatever the default value is.
Question:
This is the question you will ask your clients. Do not put a question mark at the end, as this will not parse correctly!
Description:
Write a brief description to clarify the question. It will be displayed with the question.
Type:
Set the format the anser will take. Choices include Hidden, Text, Password, Text Area, Slelct, and Radio.
Input Restrictions:
Anything to restrict the input a client will send you. In this case, the only restriction your client probably needs is Required, which will require them to choose a control panel when purchasing the product. When you are done filling these out, click next.

Step Six

Answers: Some question types require that you set predetermined answers. If these are required, you must enter the values in a list, one item per line, with no commas or other separators. Click next.

Step Seven

Here you will set the display values the client sees for all of the possible answers you set in the previous step.

Values:
set a display value for each of the answers.
Selected:
Choose the value to display first in the drop down menu. Click next.

Step Eight

This stage lets you review the answers you have entered. If they are correct, click "add wizard question" to finalize your choices. This should take you back to the questions screen, where you will see the question you created, as it will appear on the order form.

Step Nine

Now we need to tie this question to your attribute. Go to System -> Order Settings -> Custom Attributes again. Find the attribute you were working on before. Click on the green pencil in the column Custom Question. From the drop down menu, select the question you just created, and click edit.

To view your work, go through the order process. Choose the product you've tied the attribute to, and proceed to the cart. You should see this question as part of the section "Additional Product Information".

Order Form Attributes

Order Form Attributes also do not affect pricing. They create questions that will appear during the order process. Answers to these questions will be stored as client attributes.

Setting up Order Form Attributes


Step One

Go to System -> Order Settings -> Custom Attributes. From here you will see three opions: "New Generic Attributes", "Manage Questions", and "New Product or Order Form Attributes". "New Generic Attributes" and "Manage Questions" are options that are used intenally only, clients will not see these questions and the values need to be entered by the admin. "New Product or Order Form Attributes" are used to collect information through the order from from a client to be tied to either the client or the client's package.

Step Two

Click on "New Product or Order Form Attributes". A popup window will appear. Enter a descriptive name for the attribute you're going to enter. This is something that only the admin will see. Then click Edit.

Step Three

You should now see a new line item, containing the name you just assigned. Click on the green pencil next to Null. Choose Order Form Attribute. Click Edit.

Step Four

Next is the Association field. This will decide which order form this attribute is tied to. If you want to have the same attribute tied to several different order forms, you will need to create an attribute for each of them. You can use the same custom question over and over (this will be created in the next step), but each order form must have it's own attribute.

Step Five

Now we will create the question to be tied to this attribute. Click on "Manage Questions". From this new screen, click on "Add Custom Question". There are several fields here:

Name:
Choose a descriptive title for this question. This is an internal value, and your client's will not see it.
Display Order:
This can be set at whatever the default value is.
Question:
This is the question you will ask your clients. Do not put a question mark at the end, as this will not parse correctly!
Description:
Write a brief description to clarify the question. It will be displayed with the question.
Type:
Set the format the anser will take. Choices include Hidden, Text, Password, Text Area, Slelct, and Radio.
Input Restrictions:
Anything to restrict the input a client will send you. In this case, the only restriction your client probably needs is Required, which will require them to choose a control panel when purchasing the product. When you are done filling these out, click next.

Step Six

Answers: Some question types require that you set predetermined answers. If these are required, you must enter the values in a list, one item per line, with no commas or other separators. Click next.

Step Seven

Here you will set the display values the client sees for all of the possible answers you set in the previous step.

Values:
set a display value for each of the answers.
Selected:
Choose the value to display first in the drop down menu. Click next.

Step Eight

This stage lets you review the answers you have entered. If they are correct, click "add wizard question" to finalize your choices. This should take you back to the questions screen, where you will see the question you created, as it will appear on the order form.

Step Nine

Now we need to tie this question to your attribute. Go to System -> Order Settings -> Custom Attributes again. Find the attribute you were working on before. Click on the green pencil in the column Custom Question. From the drop down menu, select the question you just created, and click edit.


To view your work, go through the order process. Choose any product, and proceed to the cart. You should see this question as part of the section "Additional Customer Information".

Generic Attributes

Generic Attributes can affect pricing. They create questions that will appear during the order process. Answers to these questions will create package attributes. If the package attribute modifies an already existing attribute, Plesk Billing should be able to pass this value to the panel module to be automatically provisioned. Product attributes that create new attributes will not be provisioned.

Setting up Product Attributes

Step One

Go to System -> Order Settings -> Custom Attributes. From here you will see three opions: "New Generic Attributes", "Manage Questions", and "New Product or Order Form Attributes". "New Generic Attributes" and "Manage Questions" are options that are used intenally only, clients will not see these questions and the values need to be entered by the admin. "New Product or Order Form Attributes" are used to collect information through the order from from a client to be tied to either the client or the client's package.

Step Two

Click on "New Generic Attributes". There are several fields here that must be filled in.

Generic Attribute Key:
This is the internal attribute name, something only you will see. Choose a descriptive name.
Generic Question Name:
This is an internal value for the question. Enter something meaningful, like a biref version of the question.
Default Question:
This value will appear in the product's attribute screen.
Default Answer Value:
This is the default answer you would like for the Default Question. You may leave this blank.
Question Description:
This is a description that will appear with the question on the product attribute screen. Click save.

Step Three

Go to the product you want to create an addon for. Click on attributes. You should see the attribute that you just created displayed here. Next, you will want to create an addon, which is what will create the options and proces for this attribute.

Step Four

Click on addon-ons. Then click on "Create New Addons For This Product". This will take you through the add-on wizard.
Step One:
Set the basic format for the addon.
Panel Attribute to Change:
set this to the generic attribute you just created.
New or Update Existing Addon:
You are creating a new addon.
Addon HTML Display Type:
Choose how you would like this addon to display.
Addon Display Label:
This is the question that will be displayed for your client's to see on the order form.
How Many Options Do You Need?:
Choose the number of options here. For example, if you offer 4 choices, choose 4. Click next.
Step 2:
Set the choices your client will see. Option Display Name is what will be displayed on the order form, and Option Internal Value(s) is what will be passed to the attributes section of the package details page when the order is complete. Click next.
Step 3:
Set the prices for each of the options you've chosen. You can have a separate recurring and setup fee. Click next.
Step 4:
Here you can decide which other products to create this addon for. Only products with a similar structure will be available here (you may not see any options). Click finish.

Step Five

You should now see the addon you've created, along with each of the options you created for it. To view the result of your work, go through the order process, choosing the product you tied the addon to. When you get to the cart, you should see the addon options you created.

08b3edb77202fffdd656b40acff117c1 56797cefb1efc9130f7c48a7d1db0f0c

Email subscription for changes to this article
Save as PDF