Design
The design menu can be used to make numerous settings that affect the individual appearance of subscriptions and subscription lines.
Subscription Design
Here you can define a design for your Subscriptions.n.
 |
|---|
| Ill. Subscription Design Card |
| Field | Description |
|---|---|
| Code | Specifies a Code to identify the subscription design facilities. |
| Description | Provides a Description of the subscription design. |
| Auto-Text Code | Specifies an autotext to be used as the default for this subscription design. None of the autotext codes are specified here, the Default autotext from the subscription setup will be used. |
| Custom Text Code | Specifies a Custom Text to be used as the Default for this subscription design. If you do not specify a Custom Text here, the default Custom Text from the subscription setup will be used. |
| Hide if no Qty. to Inv. | Does not show Line. in the invoice document if they do not have a Quantity. This can be useful, for example, if purchase items and maintenance are maintained in the same Subscriptions and both should appear on the Invoice when purchased, but the purchase line should be completely hidden in the subsequent invoice, which only contains the Maintenance, and should not be listed with the Quantity 0. Another business transaction is consumables, such as support, for which no consumption has been incurred in a particular Billing Frequency Code Filter. |
| Component Indentation | Determines whether detailed information on the Subscription Item is displayed with indentation or not. You can choose whether you want no indentation, a small indentation or a large indentation. |
| Double Indentation | Specifies whether detailed information on bundle items should be double indented. If you check this box, the subscription item details associated with a Bundle Item will receive an additional Indentation. However, this only works if you have set the "Component Indentation" field to any option except "None". |
| Show Service Period | Determines whether the current service period should be displayed as detailed information for a Subscription Item. The service period is the billing period. |
| Show Next Period Qty. | Displays the expected total quantity that will be invoiced in the next billing period as detailed information for a Subscription Item, if applicable, i.e. for license-type Subscriptions where the billing of a previously purchased number of licenses is carried over to the next period. |
| Period Segmentation | Defines how information about Periods is displayed as detailed information for a Subscription Item. There are four options. None Segmentation Means that components from different performance periods are not specially marked. Default Means that the components from previous periods are marked with the abbreviation (VPA=Previous Period Billing). Previous/Current Period Means that there is a special Heading for components from the previous and current Period. Per Period This means that there is a separate Heading for components from each individual Period. |
| Component Date is Starting Date | Specifies that for the first (and only for the first) billing of a Subscriptions, the first Recording Date of a component is reflected in the Description of the Billing Period and not the Actual Starting Date of the Billing Period. |
| Show legend | This only applies if the "Recalculation" field is set to Default. A legend is displayed at the bottom of the invoice lines explaining what the abbreviation (NA) means when components from previous Periods are invoiced. |
| Skip Details on Collective Billing | Specifies whether billing details should be skipped or remain part of the collective invoice. |
Action "Standard Text Lines
You can use this function to store standard line texts for the Documents for the subscription design.
 |
|---|
| Ill. Subscription Design Standard Text Lines |
| Field | Description |
|---|---|
| Position | Here you specify whether the Text should be displayed as the first line or the last line. |
| Type | Specifies the Type of Text that is automatically inserted into the document lines. The following options are available: Subscription Period Accounting period Performance period End Customer Name Tenant Name Tenant Id Subscription Nos. Subscription description Interim Billing |
| Font Type | Specifies whether the font should be displayed in bold or normal. |
| Repeat if Collective Billing | Specifies whether this text element should be repeated for each Subscriptions that is part of a collective invoice. |
Auto-Text
Auto-Text allows you to automatically insert freely definable texts at the beginning or end of the document lines of your Subscriptions. A wide variety of placeholders are available for defining Auto-Text. The texts can also be linked to conditions.
General
 |
|---|
| Ill. Auto-Text Card Tab General |
| Field | Description |
|---|---|
| Auto-Text Code | Specifies a Code to identify the Auto-Text Code. |
| Language Code | Specifies the language that is used when the specified Text is translated on Documents for foreign business partners. |
| All Language Codes | Specifies that the Text should be used for all Language Codes. If a Language Code has been selected in the "Language Code" field, it will be overwritten by this function. |
Auto-Text-Data
 |
|---|
| Ill. Auto-Text Card Tab Auto-Text Data |
| Field | Description |
|---|---|
| Date Format Type | Defines how the Date is to be displayed. |
| Date Format | This field fills automatically after a value has been entered in the "Date Format Type" field. |
Lines
In the Line. you can define which texts are to be displayed on the subscription documents. Placeholders can be used to define the texts. The texts can also be linked to conditions.
 |
|---|
| Ill. Auto-Text Card Lines |
Placeholder
A large number of placeholders are available for the Auto-Text, which can be loaded and refreshed using the "Refresh placeholders" function.
 |
|---|
| Ill. Placeholder List |
Custom Texts
Custom Texts allow you to control the display of detailed information lines for each subscription line completely individually.
One Current standard definition for the display of detailed information Software license lines that you can use without further Settings leads, for example, to the following Line:
01.03.2021: 10 licenses added at € 59.00 results in € 590.00
You can vary this display form via Options in the field by omitting certain details, such as the price. This would then result in the following display, for example:
01.03.2021: 10 licenses added
This can be achieved through simple parameterization. Custom Texts also allow you to determine the structure of the detailed information line completely freely. This chapter describes how Custom Texts work.
With version 20.3.648.0, Custom Texts are initially only available for the Calculation Methods Default Subscription and Software License. The other Calculation Methods will be added in the next versions.
General
 |
|---|
| Ill. Custom Texts Card Tab General |
| Field | Description |
|---|---|
| Customization Code | Specifies a code to identify the Custom Text. |
| Language Code | Specifies the language that is used when the specified Text is translated on Documents for foreign business partners. |
| All Language Codes | Specifies that the Text should be used for all Language Codes. If a Language Code has been selected in the "Language Code" field, it will be overwritten by this function. |
Lines
In the lines, you can define how the detailed information texts of the subscription lines in the subscription documents are to be structured. Placeholders can be used to define the texts. The Custom Texts specified here are only examples and could look completely different depending on how you think the detailed information line should be structured.
 |
|---|
| Ill. Custom Text Lines |
| Field | Description |
|---|---|
| Type | Specifies the type of detail information line to which the Custom Text applies. The following options are available: Default subscription full Quantity Default subscription Previous Period Default subscription compressed Quantity Software license full Quantity Software license subset Software license Previous Period Software license compressed Quantity If you want to ensure that all lines of a Calculation Method are to be created using Custom Texts, Custom Texts should also be stored for all Line Types of this Calculation Method. In case of doubt, the same Custom Texts can be stored in all Lines of the same Calculation Method. |
| Custom Text | Specifies the template text line, including the placeholders, that is used to create the detailed information line. If this field is empty, this Custom Text is ineffective and the standard text valid for this Line. is output instead. |
| Available Placeholders | Shows how many placeholders, e.g. %1, %2, %3 etc., are available for this Line. By clicking on the displayed number, the placeholders can be called up so that it becomes clear which variable values are hidden behind the placeholders. |
| Blocked | If this field is ticked, this Custom Text is ineffective and the standard text valid for this Line. is output instead. |
When you select the Type field, the Custom Text field is pre-assigned with the text that the Default uses without defining a custom text. You can use this Text as a starting point to create your own definition.
Placeholder
Different placeholders are available for each Line Type. These are:
| Type | Placeholder | Name |
|---|---|---|
| Standard subscription full amount | %1 | Date of entry |
| %2 | Absolute amount | |
| %3 | Brief description | |
| %4 | Retail price | |
| %5 | Currency symbol | |
| %6 | Total amount | |
| %7 | Quantity | |
| %8 | Plus/Minus | |
| %9 | Ongoing/Cancelled (lower case) | |
| %10 | Flat rate (lower case) | |
| %11 | Space + Flat rate (lower case) | |
| %12 | Flat rate + space (lower case) | |
| %13 | Space + flat rate + space (lower case) | |
| Standard subscription previous period | %1 | Entry date |
| %2 | Absolute quantity | |
| %3 | Brief description | |
| %4 | Retail price | |
| %5 | Currency symbol | |
| %6 | Total amount | |
| %7 | Quantity | |
| %8 | Plus/minus | |
| %9 | Added/removed (lower case) | |
| %10 | Flat rate (lower case) | |
| %11 | Space + flat rate (lower case) | |
| %12 | Flat rate + space (lower case) | |
| %13 | Space + flat rate + space (lower case) | |
| Standard subscription comp. quantity | %1 | Date of entry |
| %2 | Absolute quantity | |
| %3 | Brief description | |
| %4 | Retail price | |
| %5 | Currency symbol | |
| %6 | Total amount | |
| %7 | Quantity | |
| %8 | Plus/minus | |
| %9 | Flat rate (lower case) | |
| %10 | Space + flat rate (lower case) | |
| %11 | Flat rate + space (lower case) | |
| %12 | Space + Flat rate + Space (lower case) | |
| Software licence full quantity | %1 | Date of entry |
| %2 | Absolute quantity | |
| %3 | Brief description | |
| %4 | Retail price | |
| %5 | Currency symbol | |
| %6 | Total amount | |
| %7 | Quantity | |
| %8 | Plus/minus | |
| %9 | Ongoing/cancelled (lower case) | |
| %10 | Flat rate (lower case) | |
| %11 | Space + flat rate (lower case) | |
| %12 | Flat rate + space (lower case) | |
| %13 | Space + flat rate + space (lower case) | |
| Software licence subset | %1 | Date of entry |
| %2 | Absolute quantity | |
| %3 | Brief description | |
| %4 | Retail price | |
| %5 | Currency symbol | |
| %6 | Total amount | |
| %7 | Quantity | |
| %8 | Plus/minus | |
| %9 | Added/removed (lowercase) | |
| %10 | Number of days | |
| %11 | Day/days | |
| %12 | Flat rate (lower case) | |
| %13 | Space + flat rate (lower case) | |
| %14 | Flat rate + space (lower case) | |
| %15 | Space + Flat rate + Space (lower case) | |
| %16 | Number of periods | |
| %17 | Period(s) | |
| Software licence previous period | %1 | Entry date |
| %2 | Absolute quantity | |
| %3 | Brief description | |
| %4 | Retail price | |
| %5 | Currency symbol | |
| %6 | Total amount | |
| %7 | Quantity | |
| %8 | Plus/minus | |
| %9 | Added/removed (lowercase) | |
| %10 | Flat rate (lowercase) | |
| %11 | Space + Flat rate (lowercase) | |
| %12 | Flat rate + Space (lowercase) | |
| %13 | Space + Flat rate + Space (lowercase) | |
| Software licence comp. Quantity | %1 | Date of entry |
| %2 | Absolute quantity | |
| %3 | Short description | |
| %4 | Retail price | |
| %5 | Currency symbol | |
| %6 | Total amount | |
| %7 | Quantity | |
| %8 | Plus/minus | |
| %9 | Flat rate (lowercase) | |
| %10 | Space + Flat rate (lowercase) | |
| %11 | Flat rate + Space (lowercase) | |
| %12 | Space + Flat rate + Space (lowercase) |
If you click on the number of Available Placeholders, the placeholders valid in the current context are displayed:
 |
|---|
| Ill. Custom Texts Placerholder List |
Custom Text Example
Using free text and placeholders entered in the Custom Text field for each Line Type, you can define the template that will be used to build the Line when creating information detail lines.
When you select a Type, the Custom Text is initially filled with the definition that corresponds to the Default that would be used if you were not working with Custom Texts. You can use this default as a starting point for redesigns or delete this default and enter your Custom Text from scratch.
Here are some examples of Custom Text entries and their effects when generating information detail lines. As an example, we assume that the Custom Text was entered for the Type "Software License Full Quantity" and that the following dates apply: Date = 01.03.2023, Quantity = 10, Short Descriptions = Licenses, Price = €59.00.
| Custom Text | Resulting information detail line |
|---|---|
| %1: %2 %9 %3 to %4 %5 results in %6 %5 (Corresponds to Information Detail Scope: "Complete Information") | 01.03.2023: 10 added licenses at € 59.00 results in € 590.00 |
| %1: %2 %9 %3 to %4 %5 (Corresponds to Information Detail Scope: "Quantity + Description + Price") | 01.03.2023: 10 added licenses at € 59.00 |
| %1: %2 %9 %3 results in %6 %5 (Corresponds to Information Detail Scope: "Quantity + Description + Total") | 01.03.2023: 10 added licenses results in € 590.00 |
| %1: %2 %9 %3 (Corresponds to Information Detail Scope: "Quantity + Description") | 01.03.2023: 10 added licenses |
| Date: %1 | Quantity: %8%2 |
| %7 %3 at %4 %5 each Total Amount: %6 %5 | 10 licenses at € 59.00 each. Total Amount: 590,00 € |
| On %1: %8%2 %3 makes %6 %5 |
Subscription item details
The subscription item details allow you to customise the detail lines that are dynamically created during invoicing.
 |
|---|
| Abb. Subscription item details |
The following fields are available:
| Field | Description |
|---|---|
| Code | Specifies a code that uniquely identifies these subscription item details. |
| Subscription type group code | Specifies a subscription type group for which this item detail setup is valid. If the field is left blank, it is valid for all subscription type groups for which no separate item detail setup is stored. |
| Language Code | Specifies the language used when translating subscription item details for foreign business partners. |
| All Subscription Type Groups | Specifies whether these subscription item details should be used for all subscription item groups. |
| All Languages | Specifies whether these subscription item details should be used for all languages. |
| The lines contain the following fields | |
| Field | Description |
| :- | :- |
| Line type | Specifies whether the line is used for internal descriptive comments or to define a subscription item detail. |
| Type | Specifies the type of detail information line to which the user-defined text is applied. |
| Detail text | Specifies the default string used to display detail information lines of the user-defined text line type. |
| Position | Specifies whether the detail lines should be inserted before or after the component quantity lines. |
| Detail filter type | Specifies that a filter should be set on the subscription item group to which the subscription item belongs, or on the subscription item itself. |
| Detail filter | Specifies a filter that is set on the subscription item group to which the subscription item belongs, or on the subscription item itself. |
| Calculation Method | Specifies a filter for the calculation method. |
| Locked | Specifies that the relevant user-defined text line is locked for use. |
| The following actions are available in the line | |
| Action | Description |
| :- | :- |
| Set Detail Text | Resets the detail text and its positioning to the default values. |
| Show placeholders | Shows the selection of placeholders for this line. |
Service Report Design
The performance record design allows a performance record to be created for items using the standard consumption calculation method, which can then be attached to the invoice as a separate PDF file.
 |
|---|
| Abb. Service Report Design |
The card has the following fields:
| Field | Description |
|---|---|
| Code | Specifies a code that uniquely identifies this performance record design. |
| Description | Provides a more detailed explanation of the performance record design. |
| Subscription no. headine | Specifies whether the subscription no. should be inserted as a heading. |
| Billing period headline | Specifies whether a heading should be created for the billing period. |
| Include subheading | Specifies whether subscription lines should be inserted as subheadings for the service details. |
| Empty Line before Subhead | Specifies whether a blank line should be inserted before each subheading. |
| Position Nos. | Specifies whether Position Nos. should be generated to serve as counters for the service details. |
| Unit of Measure Rendering | Specifies how the unit is displayed. |
|
|---|
| Personal support www.ckl-software.de/ |