![foo] [foo]: /path/to/image.png # Get Started [domtrac] Copyright © 2011-2017 Docucom AG Domtrac® is a registered trademark of Docucom. All rights reserved. ### In this chapter - [Login][domtrac.login] - [Menu][domrac.menu] - [Statements][domtrac.sac.statements] - [Conditions][domtrac.sac.conditions] ## Login [domtrac.login] Domtrac supports different [login mechanisms][access.authentication] like LDAP, SSO or Domtrac login. The method used for a specific user is defined on the [User Account][access.user]. ### Client Authorisation When you login to Domtrac, the system determines the authorisation to [clients][access.client] and [applications][access.user.group]. Access to applications is controlled by adding the user to one or more [user groups][access.user.group]. ![](img/access/client-auth.png) - You have access to the client assigned on your user account. - If no client is assigned on your user account, the clients defined on the user groups assigned to your account will be used to define the list of clients you can access. - When the flag *Include Children* is set for a client, you also have access to the children of that client. ### Domtrac After successful login the Domtrac UI is presented. The menus are build according to the authorities of the user groups assigned to the user and the first available application is loaded into the application area of Domtrac. ## Menu [domtrac.menu] ### Applications The applications shown in the menu depend on the assigned user groups and the selected client. In the top of the screen you find the menus and the logout button. When you click on a Menu, the Application Menu on the left hand side changes to show the available options for the selected menu. Press the logout button to logoff, the login screen is shown. The left hand side of the screen you find the available options for the active menu. The options may include applications and/or sub menus. Sub menus are indicated by a + or - sign depending if the sub menu is open or closed. Click on a sub menu to show or hide the applications of the sub menu. When you click on an application, the application is shown in the content area of Domtrac® and the title of the left hand side menu is changed to show the name of the application. ### User Menu Press on your user name in the right bottom when logged-in. #### Client Your current client is shown. As admin all available clients are visible and can get switched. On the left the used client is shown. #### Printer All available printer for your client are visible. You can select the needed printer for your documents. #### Password Change your password for your user account. ##### Current Password Enter your current password. ##### New Password Enter a new password. ##### Retype New Password Retype the new password. ##### External User Token For some applications Domtrac needs access to other systems, f.e. the FTP from Finnova. This FTP needs different login data ( User ID and Password) than Domtrac. The external user token is the entering screen for this login datas for a remote system. Information See the information about the user account. Language Change Language of Domtrac UI. ## Work Basket Summary Allows the end users to access and manage their interactive tasks. Primary User End User Icon Position 1 ### Tasks Workflows that need interaction result in the creation of tasks which are shown in the task view. If a task is visible to a particular user depends on: The client the user is logged in for The access authority needed to process the next step in the workflow. The access needed is defined on the activation group. Task View In the top of the task view you can filter and search for tasks. Search Input a search string and press enter. Assigned to Select the tasks based on who they are assigned to: My Own Unassigned My Own and Unassigned Assigned to Group Overdue Check to only show tasks that are overdue. Overdue tasks are tasks that have a due date that is less or equal to today. State Select the task based on their state: All Error Finished Running Unfinished Waiting Date From Show tasks related to the state from a defined date. Date To Show tasks related to the state to a defined date. Refresh Refresh the work basket notification. Start Show the list of the workflows, which starts via the StartDialog Handle. With a double click on the workflow you start it. All Clients Show the tasks of all clients. Only usable as admin. Client Tasks Shows the tasks of your client. ### Upload The upload application allows to load files from your local computer to Domtrac for processing. The workflow used to process the file is defined on the communication queue. Here you can define if a specific workflow is used for the processing or if the workflow is selected based on the contents of the file. There are two different ways to upload the file to Domtrac. Press upload to select the file to be uploaded from the file browser. Drag and drop the file to the designated drop area in the upload application. ### User Box Workflows can write documents to the User Box. These documents are assigned to a user or a user group. When the user logs in to Domtrac he find the documents in the User Box that he is authorized to see. Search Input a search string and press enter. Date From - Date To Select the date range to filter documents by creation date. ## Production Summary Allows the operator to manage their automated tasks and view the status of the system. Primary User Operator, Admin Icon Position 2 ### Message Queue DONE The queue view in the production menu is used to control the queues. Queues can be started or stopped individually or all queues can be started or stopped. When all queues are started, only the queues that have the Auto Start Flag set will be started. #### Start or Stop all queues You need the appropriate authorization to be able to start and stop queues. To start all queues, press Start All in the top right. Please note that only queues will be started when Autostart is defined for the current environment. For more information see the queue configuration. To stop all queues, press Stop All in the top right. #### Start or Stop individual queues You need the appropriate authorization to be able to start and stop queues. Find the queue you want to start or stop in the table. You can use the filter in the top to show only queues that match your search. Right click on the queue to show the context actions for the queue. When the queue is already started, you will only have the context action available to stop the queue. When the queue is already stopped, you can only start the queue. ### Job The job view allows to control jobs: Control the job scheduler Start jobs List of running jobs History of job executions ### Log Log messages produced by Domtrac can be viewed using the Logbook or the Log Files application. Log messages produced by external applications can be configured in a way that the files are available for viewing in Domtrac with the Log Files application. Files transfers and Sent E-mail are also logged and can be viewed with the Sent application. #### Logbook The log view shows all messages logged by Domtrac. Filter Messages In the top of the log view you can search and filter for messages. Filter with the state: Debug Error Fatal Information Warning Search Input a search string and press enter. Date From - Date To Select the date range to filter messages by date. Context Actions View Select View from the context action to see the details of the message. In the details of the messages you can find the stack trace which should be provided to Docucom when reporting a problem with Domtrac. Log File All log files created by Domtrac and applications that are integrated in Domtrac can be written to the log folder which is defined in the directory application. Any log file residing in the log folder are accessible using the log file viewer. Select File On the left hand side of the viewer, you can select the file. Sub folders residing in the log folder and zip files can be accessed directly. You can use the search field in the top of the view to search for a file. View File On the right hand side of the viewer, you can browse the file. You can use the search field in the top of the view to search for a entries in the file. The arrows in the top allow you to navigate to the find results and to the top and bottom of the file. Sent The sent view shows transferred files and sent emails. In the top of the view you can search by entries. The button in the top right lets you toggle between viewing transferred files or sent emails. 3.4 Enclosure TBD For using enclosures you have to define some settings on different places in Domtrac. Here you can upload the PDF/A files which are using as enclosures. This enclosure category is equal to the enclosure category in Configuration -> Process -> Enclosure. Name The name of the enclosure category. Display Name The display name of the enclosure category. Type Select the predefined type of the enclosure. 1.Step: Enclosure Name Type Category Source ID Group Region Valid To Languages 2. - n. Step: Templates Number depends on used number of languages for enclosures. 3.5 Documents TBD The document view shows the registered documents in Domtrac. 3.6 File TBD ### Active Sessions ## Access Summary Allows the business administrator to manage clients/tenants, users, groups and other security related things. Primary User Business Admin, System Administrator Icon Position 3 ### Clients Represents a client in a multi client enabled installation. This is also known as “tenant”. At least one client has to be configured. Name The client name is used to uniquely identify the client. When importing data: the client name has to be assigned from the incoming data there has to be an entry in the client table with the exact same name as was assigned from the incoming data see also External Name External Name The external name can be used to map a client with a name that differs from the name used to identify the client in Domtrac. When importing data: if name is not assigned and external name is assigned, Domtrac will attempt to assign it using the external name. URL Enter the URL of the client if available and necessary. Organisational Unit The organisational unit is used to define the organisational structure. Parent Select the parent for the client from the list of clients. Short Name The short name used to identify the client. Often the name and location is input here. Thumbnail Drag and drop an image for the client. Address: Name The name of the client. Name Add-On An addition to the name. Street The street name and street number. Add-On An addition to the street or additional information like apartment, floor, etc. P.O. Box The P.O. Box. ZIP The ZIP code of the city. City The name of the city. Country The country is selected from the Countries. 4.2 Location DONE Represents the location for the clients. Name The name of the location. Type The type of the location. The Mailroom application uses Printers and Inserters with the location of type “Mail Room”. The Printer application is used to show the available printers when showing the Printer Selection Dialog. The type is used here to show only printers with the appropriate Location Type. Client Specify the client of the location. Parent Optionally you can specify the parent Location. Description Optional description of the Location. Address The address of the location. City The name of the city. P.O. Box The P.O. Box. ZIP The ZIP code of the city. Phone Number The phone number of the location. Fax The fax number of the location. 4.3 User Account DONE Each user in Domtrac needs a user account. To each user account, a user group will be added. 1.Step: User Authentication The authentication used to login the user. User ID The identification of the user. This information can be accessed when defining a Property of type User. User DN The DN of the user. External User ID The External User Id can be used together with the External Password to login to a remote system. This information can be used for the Authentication in for example Web Services. User has to change password on next login When using the database authentication, you can specify here that the user has to change the password when he logs in next time. On the login screen the user will be prompted to change his password and the this information will be reset. New Password When using the database authentication, you can set a new password for the user here. The password has to be repeated in Repeat Password. Repeat Password Only needed when a new password was entered in New Password. Repeat the same password input in New Password. External Password See External User ID. User Groups Assign the user groups the user belongs to. 2.Step: User Details Thumbnail Drag and drop an image for the user. The image is shown in several places where you can assign a user. Department Department of the user. Printer Select the default printer for this user. Location Select the Location from the list. Language Select the Language from the list. The language is used for the UI for this user. Changing the language will take effect after renewed login. Locale Select the local form the list. The local is the Language used for the formatting of dates, amounts, etc. Display Name The name of the user. Initials Initials of the user. This information can be accessed when defining a Property of type User. First Name First name of the user. This information can be accessed when defining a Property of type User. Last name Last name of the user. This information can be accessed when defining a Property of type User. Street Street, number and add-on. This information can be accessed when defining a Property of type User. City The city of the user’s address. This information can be accessed when defining a Property of type User. E-mail Address The E-mail address of the user. This information can be accessed when defining a Property of type User. 4.4 User Groups DONE In a user group you assign authorisations for the user accounts. If it is not an administrator user group, you can assign the authorization for each menu and submenu and the functions in this menu. Name The name of the user group. Administrator Check this to specify that this is an administrator user group. The administrator has access to all applications, clients and data. You do not specify the User Group Authorization for an administrator. Show Customer Data Controls the data that is visible in the Document View and in the Output View. Description Optional description of the User Group. Group Authorization The User Group Authorization defines access to individual applications. This option is not available when you checked the Administrator checkbox. Use the add button and the context actions to add or change authorizations. Application Choose the application from the list of available applications to which you grant authorization. Authorization The available authorization(s) can be selected here that is/are available for the selected application. Client Optionally select the client for which the authorization will be available. Include sub clients When a client is selected this checkbox is shown to allow you to select if access is also granted to all children of the client. If you want to grant a different access for the children, you have to leave this unchecked and add additional user group authorizations for the client’s children. Description Optional description of the User Group Authorization. List of all Applications Application Path Authorization to.. Description of authorization Access Keys (Access->Key) Change Authorised to change the access key Access Security (Access->Security) Change Authorised to change the access security Add-On (Production->Add-On) Change Authorised to change an add-on Application (System->Application) Change Authorised to do changes in the applications. Authentication (Access->Authentication) Change Authorised to change the authentication. Bundle (Workflow->Bundle) Change Authorised to change a bundle. Business Adapter (Change Management->Business Adapter) Import Authorised to import xml files. Calendar (Process->Calendar) Change Authorised to change a calendar. Campaign (Production->Campaign) Change Authorised to change a campaign. Character (Interactive->Style->Character) Change Authorised to modify a character. Clients (Access->Clients) Change Authorised to change the clients. Condition (Configuration->Data->Condition) Change Authorised to modify the conditions. Counter (Configuration->Interactive->Counter) Change Authorised to modify a counter. Country (Data->Country) Change Authorised to change a country. Currency (Data->Currency) Change Authorised to change a currency. Data Assignment (Configuration->Data->Data Assignment) Change Authorised to change a data assignment. Data Transformation (Configuration->Data->Data Transformation) Change Authorised to change a data transformation. Delivery (Configuration->Process->Delivery) Change Authorised to change the deliveries. Dialog (Configuration->Interactive->Dialog) Change Authorised to change a dialog. Directory (System->Directory) Change Authorised to change the directories. Document Class (Stationery->Doc Class) Change Authorised to change a doc class. Document Template (Interactive->Document Template) Change Authorised to change document template. Documents (Production->Documents) Bulk Update Authorised to bulk an update. Cancel Documents Authorised to cancel documents. Delete Documents Authorised to delete documents. E-Mail (Communication->Email) Change Authorised to change the e-mail template. E-Mail Host (Communication->Email->Host) Change Authorised to change the e-mail host. Envelope (Stationery->Envelope) Change Authorised to change the envelope. File (Production->File) Change Authorised to change a file. File Transfer (Communication->File Transfer) Change Authorised to change a file transfer. Form Type (Stationery->Form->Type) Change Authorised to change a form type. Formatter (Config->Workflowhandlers->Formatters) Change Authorised to change the formatter handle. Formatting (Config->Data->Formatting) Change Authorised to change the formatting. Housekeeping (Process->Housekeeping) Change Authorised to change the housekeeping. Inserter (Device->Inserter) Change Authorised to change the inserter. Inserter Model (Device->Inserter->Model) Change Authorised to change the inserter model. Job (Process->Job) Change Authorised to change the job. Job Class (Process->Job Class) Change Authorised to change the job class. Language (System->Language) Change Authorised to change the language. Location (Access->Location) Change Authorised to change the location. Log File (Production->Log->File) Authorised to see the log file. Logbook (Production->Logbook) Authorised to see the logbook. Maintenance (Production->Maintenance) Maintenance Authorised to use the maintenance. Message Queue (Communication->Queue) Change Authorised to change the queue. Start / Stop Authorised to start and stop the queue. Message Queue (Production->Queue) Start / Stop Authorised to start and stop the queue. Output Mill (Workflow->Output Mill) Change Authorised to change the output mill. Package (Change Management->Package) Change Authorised to change the package. Restore Authorised to restore the package. Paragraph (Interactive->Style->Paragraph) Change Authorised to change the paragraph. Printer (Device->Printer) Change Authorised to change the printer. Printer Model (Device->Printer->Model) Change Authorised to change the printer model. Property (Process->Data->Property) Change Authorised to change the property. Write Config Authorised to write the config. Semantics Library Manager (CML) (Change->Management->Import->Lm) Change Authorised to do changes with the CML files. Import Authorised to import files to CML. Service Level (Process->Service Level) Change Authorised to change the service level. Setting (System->Setting) Change Authorised to change the settings. Sheet (Workflow->App Sheet) Change Authorised to change the sheet. Sheet (Workflow->App Sheet->Single) Change Authorised to change the single sheet. Simple Network Management Protocol (SNMP) (Communication->Snmp->Trap) Change Authorised to change the SNMP. Style (Interactive->Style) Change Authorised to change the styles. Tasks (Workbasket->Task) All Tasks Authorised to see all tasks. Assign to User Authorised to assign a task to another user. Delete Authorised to delete a task. Process Authorised to process a task. Rerun Authorised to rerun a task. Start Authorised to start a task. Test Data (Config->Data->Test Data) Change Authorised to change the test data. Text File (Workflow->Text File) Change Authorised to change the text file. Text Module (Interactive->Text Module) Change Authorised to change the text module. Text Table (Interactive->Text Module) Change Authorised to change the text module. Upload (Workbasket->Upload) Execute Workflow Authorised to execute the workflows. User Account (Access->User Account) Change Authorised to change the user account. User Group (Access->User Group) Change Authorised to change the user group. Web Service (Communication->Web Service) Change Authorised to change the web service. Web Service Security (Communication->Web Service->Security) Change Authorised to change the web service security. Workflow (Workflow->Workflow) Change Authorised to change the workflow. 4.5 Authentication TBD Security Select the security from the list: Database LDAP Domain Name The name of the authentication domain. Is Visible Domain TBD LDAP Type Select the LDAP type: Microsoft Active Directory Apache Directory Server 1.0.x Apache Directory Server 1.5.x Apple Open Directory FedoraDS Generic Directory Server Novel eDirectory Server OpenDS OpenLDAP Generic Posix/RFC2307 Directory Sun Directory Server Enterprise Edition Host The host name of your directory server. Port The port on which your directory server is listening. Second Host / Second Port Alternate host and port if first host is not available. Third Host / Third Port Alternate host and port if first and second hosts are not available. Access Security Access security used for the LDAP. Technical User DN TBD Password TBD Timeout The timeout in seconds after which Domtrac® will stop the connection attempt. Ignore Groups TBD Membership defined in user entry The group membership is defined in the User Schema. User Schema User Search This value is used in addition to the base DN when searching and loading users. If no value is supplied, the subtree search will start from the base DN. User Filter The filter to use when searching user objects. Name The RDN (relative distinguished name) to use when loading the username. The DN for each LDAP entry is composed of two parts: the RDN and the location within the LDAP directory where the record resides. The RDN is the portion of your DN that is not related to the directory tree structure. First Name The attribute field to use when loading the user’s first name. Last Name The attribute field to use when loading the user’s last name. Display Name The attribute field to use when loading the user’s full name. E-mail The attribute field to use when loading the user’s email address. Password TBD Group Schema Group Search This value is used in addition to the base DN when searching and loading groups. If no value is supplied, the subtree search will start from the base DN Group Filter The filter to use when searching group objects. Name The attribute field to use when loading the group’s name. Description The attribute field to use when loading the group’s description. Membership Schema Members The attribute field to use when loading the group’s members. Membership The attribute field to use when loading the user’s groups. 4.6 Access Security TBD TBD Name Name of the Access Security. Network Layer Security Select the network layer security from the list: None SSLv3 STARTTLS TLS Cipher Suite Select a cipher suite from the list. Trust Material When a Network Layer Security other than “None” is selected, the Trust Material has to be specified. Client Challenge TBD Key Material When Client Challenge is checked, Key Material has to be specified. Authentication Select the authentication from the list: Basic Authentication None SMTP Authentication User Token When Authentication “Basic Authentication” is selected the User Token has to be specified. Description Optional description of the Access Security. 4.7 Access Keys TBD TBD Name Name of the Access Key. Key Type Select the key type from the list: Key store Password Secret store Trust store User Token Key Store Type When Key Type “Trust Store”, “Key Store” or “Secret Store” is selected you have to specify the type of the key store. Description Optional description of the Access Key. TBD 5 Data DONE Summary Allows the business administrator to manage multilingual and client specific text lists. Primary User Business Admin Icon Position 4 5.1 Text Table In Domtrac 5, the user has the permission to create and display Multilingual Letters. The Business admin can use Texttables for defining Text in different languages. Texttable translate the items every time into default language of the Letter and display in the correct language Version in End User View. The end user can check the items displayed in his preferred language. Actually, Domtrac 5 provides a lot of languages for his user. Table Name The name of the Text Table. Client Optionally a client can be specified. Can Be Used as Caption When selected, the text in the table can be used to specify the caption in a Dialog. Text The text describing the table in the languages defined for the system. Description Optional description of the Text Table. Text Table Item Table The table to which the text item belongs. Name The name for the text item. Text The text in the languages defined for the system. 5.2 Country The country table contains properties related to a country. If you define a Property of type Country it will be automatically linked to this table and you will be able to access fields from here. Alpha-2 Code The ISO 3166/MA two character alphabetical code of the country. Alpha-3 Code The ISO 3166/MA three character alphabetical code of the country. Numeric Code The ISO 3166/MA three digits numerical code of the country. External Codes When the delivery system can not provide the ISO code, the code used by the delivery system can be configured here. If there are multiple codes pointing to the same ISO country code, they can be all added here, separated by a comma. When a document is imported with a unknown country code, the external codes are used to try to retrieve the ISO country code for the country and the ISO country code is than set for the document. If the original country code is needed it has to be assigned to a customer defined document property. Short Description The short description is used wherever you can select the country. The description is input in the languages defined for the system. Thumbnail The image for the flag of the country. Region The region can be selected from any of the predefined regions. The region code will be available whenever you are accessing the Country Object. Split Region The split region is normally used when processing documents for bulk mail. The split region can be input or selected from any of the regions that where input for another country. The split region code will be available whenever you are accessing the Country Object. Country Mapping The country mapping is used to be able to evaluate the country ISO code from an address using the name of the country that is present in the address. Country States Code The code of the state. Short Description The short description is used wherever you can select the state. The description is input in the languages defined for the system. 5.3 Currency The currency table contains properties related to a currency. If you define a property of type Currency it will be automatically linked to this table and you will be able to access fields from here. Code The ISO 4217 code of the currency. Symbol The currency symbol. Symbols can also be added by inputting the unicode(s). Number of Digits The number of digits for amounts in this currency, usually two. Short Description The short description in the languages that have been configured in Languages. 6 Configuration Summary Configuration of various aspects of the Domtrac application. Primary User Business Admin, Business Analyst, System Administrator, Data Expert Icon Position 5 6.1 Process Job Configuration Name The name of the job. Job Class The Job Class used for the job. Maximum Number Parallel The maximum number of parallel executions for this job. This is the absolute maximum for executions of this job. It is possible that a job is waiting for execution even thought the maximum specified here is not reached. That happens if the maximum number of parallel executions for the Job Class is reached. Disabled Check to disable the job. The job will not be scheduled, not show anywhere in the production job view and cannot be started manually. When you define a new job, this is checked by default. Debug Check to enable the writing of debug messages to the Logbook Description Optional description of the job. Planned TBD Type Scheduled Requested Environment Manual Start Allowed Execution Inactive Time Zone Run TBD Delivery Delivery Name The name of the delivery. Type TBD Archive File Mail Preview Print Redirect User Box Web Priority TBD High Immediate Low Normal Description Optional description of the delivery. Selection 1.Configuration Name The name of the selection. Description Optional description of the selection. 2.Delivery Rule Name The name of the delivery rule. Description Optional description of the delivery rule. Service Level Name The name of the service level. Description Optional description of the service level. E-mail Accounts Notification TBD Time Limit TBD Calendar Name The name of the calendar. Type TBD Inactive Trigger Description Optional description of the calendar. CalendarItem TBD Scope TBD At Every First Last Job Class Class Name The name of the job class. Maximum Number Parallel The maximum number of parallel executions for jobs with the same job class. Description Optional description of the job class. Housekeeping Group Name The name of the housekeeping group. Description Optional Description of the housekeeping group. Maximum duration in minutes TBD Housekeeping Name The name of the housekeeping. Description Optional description of the housekeeping. Sequence TBD Max duration in minutes TBD Type TBD Add-On Courier Document E-mail Execution Data File File Transfer Import Log User Box 6.2 Workflow How to start a Workflow: Workflow started from Queue Workflow started from Job Workflow started from Task View Documents Domtrac provides many ways to process documents. This section gives some example of the major ways to generate and retrieve documents for processing. Document from Letter Document from Prepared Document Document from Data File Document from Print File Workflow Created documents should execute in a workflow which is created by a business admin. A Workflow in Domtrac 5 is build with Workflow Handles. The handlers can be easily adapted to a workflow by drag and drop. Handler Activation Group The activation group controls handlers that are executed synchronous. These are normally interactive handlers but any other handler can also be added to an activation group. Interactive handlers must be in an activation group. When a workflow enters an activation group, a task is created in the Work Order View. A user needs to select the task in the Work Order View to proceed with the processing of the workflow. This can also be triggered from outside Domtrac® by opening a browser with the URL that points to the workflow. When a workflow exists an activation group the state of the workflow changes to either Running or Finished depending if more steps are to be processed or not. There can be multiple activation groups in a workflow: To support processing of a workflow by different users. The User Group allowed to process the part of the workflow inside the activation group is defined not he activation group. To support switching from synchronous to asynchronous processing and vice versa. This is especially useful if there is some long running process that we want to run in the background rather than having the user’s session blocked. On the activation group you define User access Properties of the Work Order Activation Group Configuration Name The name of the activation group in the workflow. User Group The user group that is allowed to execute this part of the workflow. Client Assign the client to the Work Order. Customer Assign the customer to the Work Order. Customer Number Assign the customer number to the Work Order. Due Date Assign the due date to the Work Order. Creator Assign the creator to the Work Order. Start Dialog This handle is used to define a workflow that is started from the Task View. The handle has to be defined within an activation group. Settings Name The name is used to identify the handle in the workflow. Dialog Select the dialog from the list of available dialogs. Document Viewer Shows one or more documents in the document viewer. The handle has to be defined within an activation group. Settings Name The name is used to identify the handle in the workflow. Watermark Preview Define a watermark for the preview. Disable Print Preview When checken, the printer in preview is disabled. All Select if you want all documents that have been produced by the previous handlers to be shown in the viewer. Files When All is not selected, you have to choose the handlers that produce documents to be shown in the viewer. Dialog Show a dialog. The handle has to be defined within an activation group. Settings Name The name is used to identify the handle in the workflow. Dialog Select the dialog from the list of available dialogs. Show URL Show an external URL in an iFrame. The handle has to be defined within an activation group. Settings Name The name is used to identify the handle in the workflow. URL Select the property which is used to get referenced in a dialog to the used URL. Document Template Show a document template in the end user view. The handle has to be defined within an activation group. Settings Name The name is used to identify the handle in the workflow. Document Template Select the document template from the list of available document templates. File Tools Use to perform file operation. Settings Name The name is used to identify the handle in the workflow. Action Select the operation to be performed: Compress Decompress Copy Delete Move Compress Settings If already exists Select the action to be taken if the file already exists Overwrite; the existing file is overwritten Rename; the existing file is renamed, a UUID is added Error; the workflow stops with an error Select Files Select the handles from which files are processed. You can only select handles that have been defined previously in the chain and that provide files. Destination Directory Select the destination directory from the list. Subdirectory Use the [extended assignment field]{#domtrac.ui.extended.assignment) to assign a value for the subdirectory. Leave blank if you do not want to use subdirectories. Type Select the type of the compression: Automatic TARGZIP ZIP 7z File Name Use the [extended assignment field]{#domtrac.ui.extended.assignment) to assign a value for the file name. Decompress Settings If already exists See If already exists above. Select Files See Select Files above. Destination Directory See Directory above. Subdirectory See Subdirectory above. Type See Type above. Copy Settings If already exists See If already exists above. Select Files See Select Files above. Destination Directory See Directory above. Subdirectory See Subdirectory above. Delete Settings Select Files See Select Files above. Move Settings If already exists See If already exists above. Select Files See Select Files above. Destination Directory See Directory above. Subdirectory See Subdirectory above. Input File The file input handle is used to define a workflow that starts with a file. The file may be a file containing data, a print file or any other file. Settings Name The name is used to identify the handle in the workflow. IMTF The handle corrects the format of PS files so they can be archived with the IMTF archive system. Settings Name The name is used to identify the handle in the workflow. Files Select one of the previous handlers in the workflow that generates files. File Name Statement to define the filename of the files written by the handler. Not implemented yet. Text File Create a text file on disk or in memory using the definition from the text file configuration. Settings Name The name is used to identify the handle in the workflow. Text File Select the text file configuration from the list. File Name Use the statement to define the file name used to write the text file. Data Transformation Transform a data file using the definition from the data transformation configuration. Settings Name The name is used to identify the handle in the workflow. Not implemented yet. Select Files Select files from disk. Settings Name The name is used to identify the handle in the workflow. Not implemented yet. Document Input This handle is used to define a workflow that is started from a document which is already in a doc table and is used for further processing. Settings Name The name is used to identify the handle in the workflow. Write Documents Save document templates in a doc table. Settings Name The name is used to identify the handle in the workflow. Document State Select the state of the documents from the list: Error Ready Received Delivery Select the type of the delivery. Manual Selection Deliveries Select the delivery configuration from the list. Show Filter your Doc Properties. All Assigned Mandatory Missing Set Document Properties You may want to add custom fields to be used inside the Workflow. The content can be put into the Barcode or in the textfile. The Client number is an example for such a content. This use case is addressed with the possibility to add Propertyitems to the PropertyGroup Doc. Such Doc-Properties differ from other properties in some ways: To add them the server needs a reboot They cannot be renamed They cannot be deleted Such properties can be filled in the DocWrite Handle Document from Archive Settings Name The name is used to identify the handle in the workflow. Not implemented yet. Data Input Start a workflow using data from another workflow or process. Settings Name The name is used to identify the handle in the workflow. Channel Assign documents to a channel. The condition defines if the document is selected or unselected (residual). A name can be defined for both. A new job is created, provided not all documents remain together. The Split and Channel handlers cause the generation of new workflow jobs by grouping documents in logical stacks. When all documents are still together after the channel, no new job will be generated. Settings Name The name is used to identify the handle in the workflow. Channel Name The name of the channel. Residual Name The residual name is used when the setted condition is false. If the condition is true, the channel name is used. Priority Select the priority for the documents of this channel: High Low Medium Service Level Select the service level from the configuration list. Condition If needed, set a condition valid for this channel. Description Optional description of the channel handle. Data Assignment Assign data from a file to properties using the data assignment configuration. Raw data needs to be assigned to properties so it can be used in the workflow and the workflow handles. Settings Name The name is used to identify the handle in the workflow. Mapping Select the data assignment from the list of available data assignments. Sort Sort documents in the job. Settings Name The name is used to identify the handle in the workflow. Sort Specify the properties and the order used for the sorting. Description Optional description of the sort handle. Section Define a section which consists of 1-n documents to structure the output. Settings Name The name is used to identify the handle in the workflow. Not implemented yet. Bundle Group documents in a bundle. Settings Name The name is used to identify the handle in the workflow. Not implemented yet. Split The Split and Channel handlers cause the generation of new workflow jobs by grouping documents in logical stacks. When all documents are still together after the split, no new job will be generated. Settings Name The name is used to identify the handle in the workflow. Type Select the type of the split from the list: Instructions Number of Bundles Number of Documents Number of Sheets Values Total If splitting after a bundle, doc or sheet, you have to define after how many documents you want to split. Therefore define the total with the statement editor. Properties Available when Values is selected for Type. Specify the properties used for the split. When any of the properties changes, a split will occur. Channel Name The name of the channel. Extend Channel Name When selected, the existing channel name will be extended with the name specified in Channel Name here. Description Optional description of the split. PDF The PDF Handle gives you the opportunity to join multiple documents in one PDF. Settings Name The name is used to identify the handle in the workflow. File Name Define the file name of the PDF. Document Templates The workflow contains multiple document template handlers. This document templates which should join in one PDF can get selected. Formatter Format a data file. The formatter is an external application that creates a print file from a data file. Settings Name The name is used to identify the handle in the workflow. Type Select the type of the formatting: File; format data from a file Property; format data from a property All Available if Letter is selected for Type. When checked, all letters generated in handles previous to the current are formatted. Files Available if All is not checked. Output Mill The mill reads all input documents and writes the documents to one or more print files using the output mill configuration. This configuration may contain handlers that manipulate the generated output. Settings Name The name is used to identify the handle in the workflow. Output Mill Select the output mill configuration from the list. Multiple Clients Allowed Is relevant for batch processing. When checked multiple clients for one process are allowed. Split Select the type of the split. Bundle Document None Page Multi-Channel Select the multi channel type. False Form Type Tray Combine in one file When checked, all documents are written in one doc. Duplex Allow duplex print. Condition Available if Conditional is selected for Duplex. When you specify a condition you control when duplex print is allowed. Reverse Output When checkedk, the output is printed reversed. Omit Extension If checked, the file extension (.xml, etc.) is omitted. File Name Use the statement to define the file name used to write the output mill. Document Template Compose a letter without user interaction. Settings Name The name is used to identify the handle in the workflow. Use Property Define the property which includes the document template Document Template Select the document template from the list of available document templates. XML Output When checked, the output is written in an XML file. Concatenate When checked, the documents are written in one PDF file. Control Sheet Create a control sheet. The control sheet is a separate sheet that usually contains information about the job being processed. Settings Name The name is used to identify the handle in the workflow. Not implemented yet. Table of Contents The Table of Content Handle allows you to create a Table of Content or Index of the used Templates in a workflow or of the created jobs in workflow execution. Settings Name The name is used to identify the handle in the workflow. Generation Level TBD At the moment only Job level because bundle / sort / etc. not implemented yet. Job Content TBD Document Content TBD Unit Select the unit for the layout. Inch Micrometer Millimeter Thousandths of an inch Margin Left Set the margin on the left. Value of margin depends on selected unit. Margin Right Set the margin on the right. Value of margin depends on selected unit. Margin Top Set the margin on top. Value of margin depends on selected unit. Margin Bottom Set the margin at the bottom. Value of margin depends on selected unit. Overlay Select the sheet configuration from the list. Cover Sheet Add a cover and/or trailer page. Pages will be added to the file generated with the mill. Settings Name The name is used to identify the handle in the workflow. Not implemented yet. Application Execute an external application using the application configuration. Settings Name The name is used to identify the handle in the workflow. Process Select the process. Document Instruction Scope Select the scope for the web service. Bundle Document Job Section Application Select the application configuration from the list. Description Optional description of the application. Web Service Perform a web service call using the web service configuration. Settings Name The name is used to identify the handle in the workflow. Scope Webservice Select the web service configuration from the list. Description Optional description of the web service. Module Perform a module to call a Java Class. Settings Name The name is used to identify the handle in the workflow. Not implemented yet. Execute Workflow This handle starts a subworkflow which starts with Data Input. Settings Name The name is used to identify the handle in the workflow. Data Assignment TBD Not implemented yet. Stop Each workflow has to be stopped with the End Handler. Settings Name The name is used to identify the handle in the workflow. Log Write a message to the Logbook Settings Name The name is used to identify the handle in the workflow. Generation Level TBD Log Level Select the used log level. Debug Error Fatal Information Warning Message TBD Condition Continue processing depending on a condition. Settings Name The name is used to identify the handle in the workflow. Condition Specify the condition. E Mail Generate e-mails using the e-mail template configuration. Settings Name The name is used to identify the handle in the workflow. Generation Level Job Bundle Document E-Mail Select the email configuration from the list. JMS Send a file using the queue configuration. The queue has to be defined as a JMS queue. Settings Name The name is used to identify the handle in the workflow. Scope TBD Files TBD Selection TBD Message Queue TBD Message Type TBD JMS Correlation ID TBD Print Print files using a printer configuration. Settings Name The name is used to identify the handle in the workflow. Files When All is not selected, you have to choose the handlers that produce documents to be printed. Selection Select the print selection. Current Printer; The user can select his current printer in the user menu. Dynamic LPR Printers Printer Select the printer configuration from the list. Document Name Use the statement to define the file name of the printing job. User Name Use the statement to define the user name. Error Handling Select the error handling. Exception Move File File Transfer Transfer files using the file transfer configuration. Settings Name The name is used to identify the handle in the workflow. File Transfer Select the file transfer configuration from the list. Remote Directory TBD Binary TBD Files When All is not selected, you have to choose the handlers that produce documents to be transfered. Compress TBD Number of Retries TBD Delay TBD Error Handling Select the error handling. Exception Move File Description Optional description of file transfer. User Box Generate entries in the user box. Settings Name The name is used to identify the handle in the workflow. User Group Select the user group. User File Reference Origin Message Document ID Document Type Document Title Account Customer Private Workflow Selection The workflow selection can be specified on the Queue to control which workflow is executed for the received file. Name Name of the workflow selection. Encoding Encoding of the incoming file. By default UTF-8 is selected. Data Extraction Workflow Selection Description Optional description of the workflow selection. Bundle Bundle Name Name of the bundle configuration. Bundle Select one or more properties here, the documents will be bundled when the values of the properties are the same. Press the and buttons to add or remove items. Press the and buttons to move items up or down. The place of an item in the list has no influence on the result. Sort Sorting in the envelope. Press the and buttons to add or remove items. Press the and buttons to move items up or down. Do not Split When envelope splitting is used you prevent that documents that belong together are packed in different envelopes. When you select one or more properties here, the documents have to be in the same envelope when the values of the properties are the same. Press the and buttons to add or remove items. Press the and buttons to move items up or down. The place of an item in the list has no influence on the result. Do not Bundle Optional condition to allow to force documents not the be bundled whenever the condition is met. These documents will be processed by themselves. Description Optional description of the bundle configuration. Packing Name Name of the bundle configuration. Items Use the add button or the context actions to add or change items. Description Optional description of the bundle configuration. Packing Items Envelope TBD Split Specify a value greater one to define that an attempt is made to fit the documents into the number of envelopes you specify here. When the number of envelopes generated does not exceed the maximum specified here, multiple envelopes are generated for the same recipient. Otherwise the next envelope is chosen. Insert Address Sheet Always Never Document Class Sequence The sequence in which the packing items are processed to find the correct envelope to be used. Text File DONE Generate Text-files, XML, .csv. etc. These files are used for many different purposes. Mostly, however, as an index file for archiving. Configuration Name Name of the text file configuration. Process Document Instructions Property Set When Instructions is selected for Process you need to specify the property set. Encoding The encoding of the text file that is generated. Line Break The line break to be used for the generated text file: NONE CR CRLF LF Generation Level The following options are available when Document is selected for Process: Bundle Document Job Page Section The following options are available when Instructions is selected for Process: Instruction Job Document Template Condition Optional condition controlling if a text file is generated or not. Description Optional description of the text file configuration. Text Use the add button or the context actions to add or change text used to generate the text file. Name Name of the text configuration. Generation Level The text configuration is used only for the generation level you select here. The following options are available when Document is selected for Process: Bundle Document Job Page Section The following options are available when Instructions is selected for Process: Job Instruction Document Template Output Level Header Body Footer Condition Optional condition to control when the text configuration is used. Text Input the text here. Variables are defined by using placeholders. The placeholders have to be in the format The placeholders configuration is done in the Variables step of the wizard.. Content All the placeholders defined in Text are collected and can be mapped here. Output Mill To include contents like barcode, images, logos, text, e.g. at the end of the final processing the output mill is used. We also need to include contents by condition in desired pages. During final processing, the workflow need the possibility to put contents for example on every page, front page of each document, on only a specific document, front page of the bundle, etc. If we put page numbers on every page, we can distinguish between page numbers are considered as whole bundle or document. 1.Step: Configuration Name Name of the output mill. Type Select the type for the output mill from the list: Compart Mill Pdf Tools Depends from your license model. Units Select the unit for the output mill from the list: Centimetre Inch Millimeter Points Version Define the version for this mill. File Format Select the file format from the list: AFP Advanced Function Printing EMF Enhanced Windows Metafile EPS Encapsulated Postscript GOF IFF Image File PCL Printer Command Language PDF Portable Document Format PS Postscript SVG Scalable Vector Graphic TXT Text XFF Exported FoxPro Database XHM XIF Extended Image Format XRX Subtype Only available if GOF, IFF, PDF or XRX are selected for File Format. Select the subtype for the file format. Error Handling Select the error handling from the list: Normal Relaxed Strict Debug Binary Mode Only available if Compart Mill is selected for Type. Select the binary mode from the list: Always Automatic Never Profile Directory Only available if Compart Mill is selected for Type. Define the profile directory for your license. Code Page Only available if Compart Mill is selected for Type. Self Contained Only available if Compart Mill is selected for Type. Merge Fonts Only available if Compart Mill is selected for Type. Embed Fonts Only available if Compart Mill is selected for Type. Separate Overlays Only available if Compart Mill is selected for Type. Form Definition Only available if Compart Mill is selected for Type. Description Optional description for the output mill. 2.Step Handler Add an Output Mill Handler 1.Step: Configuration Name Name of the output mill handler. Stop on Error Disabled Handler Type Select the handler type from the list: AFP Copy Group AFP Page Group Barcode Booklet Capture Barcode Capture Comments Capture Text Comments Convert to Image Duplex Add File Jog Line Move Multi-up Optical Mark Recognition Page Size Parcel PP Port Payé Remove Revert Rotate Scale Scale PDF Text Scope Type Direction Position X X Position of the handler on the document. Position Y Y Position of the handler on the document. Width Width of the handler. Height Height of the handler. Description Optional description from the output mill handler. 2. Step: Condition Add conditions to the handler, if needed. 3. Step: Content There is a palette to create the appropriate content for the handler: Text Field for static text or properties. Available properties: Bundle Doc Job Page Section If global properties are needed, they need to be mapped in Doc Properties in the Write Documents Handle. Line Break When no line breaks are used, the content is written in one line. If-then-else Add an if-then-else condition to Any or All Condition Case Conditional Add Sheet 6.3 Interactive This submenu allows you to define all elements which are used to create interactive documents. These elements are: Document Template Text Module Dialog Style Counter Document Template One or several documents should be created in a very efficient way on the business processing point of view. These documents get activated by a business application like Finnova. In addition manual corrections in the automatically generated document by the end user are normal. These corrections can be made in an easy to use web based preview of the document. The Business author of the Letter Template has a range of different possibilities, which are usable by a skilled end user. Domtrac Letter can easily get configured and used without IT-Professionals. Name Name of the document template category. Description Optional description of the document template category. Display Name & Description Name and optional description in the used languages. One or several documents should be created in a very efficient way on the business processing point of view. These documents get activated by a business application like Finnova. In addition manual corrections in the automatically generated document by the end user are normal. These corrections can be made in an easy to use web based preview of the document. The Business author of the Letter Template has a range of different possibilities, which are usable by a skilled end user. Domtrac Letter can easily get configured and used without IT-Professionals. Configuration Layout Mode Name The name of the document template configuration. Languages Select the languages and the default language for the document template. See Language Selection for more details. ID Document Template Define the ID for the document template. Document Class Select the class of the document. Category Select the category to which this document template will be added. Client Select the client, which owns this document template. If no client is set, it is a general document, which every client can use. Debug When debug is checked, some configuration errors are tolerated in the workflow execution. This means, they produce an error message instead of aborting the execution. Only Show in Preview When checked, the end user view in the workflow execution is skipped and only the PDF is shown. Description Optional description of the document template. Example PDF Upload an example of the document, produced by this document template and is used in document selection as thumbnail. Property Set Select the Property Set from the list of available Property Sets. The property set determines the data that will be available to be used in the document template. Formatter Select the formatter configuration to be used when producing a document from this document template. Language Selection Select the property from the used property set that is expected to hold the language code for the language in which to produce this document. Paragraph Style Select the default paragraph style for the document template. This is used for all paragraphs and table cells that do not have an own paragraph style set. Form Type Select the form type configuration for this document template. Landscape Check if document template is in landscape. Version ID Add the version ID from this document template. Variation The configuration of Domtrac5 provides multiple variations of one letter. These variations have to be differentiated according to conditions and output possibilities. The variation aspect comes up when a letter has for example two copies for different channels. A normal use case is, when the copy for the bank has a signature field in the fluent text and the copy for the customer doesn't have this signature field. Dialog Select the dialogs which are needed for the document template. Display Name & Description Optional Display Name and Description of the document template in different languages. Configuration Content Mode In the content mode you define the content of the letter. There are two basic content types that can be added: Block; this content is added to a flow area. Inline; this content is added to a content block. Block content types Text Table Notes Inline content types Property Text Module Counter Text Table Page Break Text Add a text to the flow are to create new text elements. When selected some text in the paragraph and do a right click you reach a sub menu: Copy Copy the selected text. If there are properties in the selected section, they will get copied as well. With a right click on a new Text the Paste occurs in the sub menu to paste this text. Reset Style Reset your previously setted character style for the selected text. Character Style Change the character style for the selected text. Move Text up Move the whole text up. Move Text down Move the whole text down. Delete Text Delete the text. Paragraph Properties You also reach this menu with a click on the blue pen on the left from the text. Editable Check editable if the end user should have the possibility to edit this text. Insert Text Modules from Categories Only selectable if editable is checked. Add the text module categories from which the end user can add a text module in this text in the end user view. Conditional Select the condition from the list of available conditions and properties of type boolean for this text. Select the: If If not condition. Optional Optional sections are very useful for the enduser to add several paragraphs or tables to a letter which are not used in all cases. This optional text sections are configured in the paragraph properties. To use a paragraph as an optional section you have two options (Selected or Unselected) Selected: The checkbox on the right sight in the end user view is already checked. Unselected: The checkbox on the right sight in the end user view is unchecked. For the title of the optional text there is now the possibility to set it multilingual. This has to be done about text table items. For this a locked Text Table 'DocumentTemplateOptions' is prepared which can be filled with items. This items can be used as multilingual optional sections. Only items in this text table can be used for the optional sections. Variation Only available if a variation in the content mode is defined. Select the variation from the list of the available variations. Then this text is only visible for the selected variation in end user view and PDF. Paragraph Style Select the used paragraph style for this text. If no paragraph style is set, the selected paragraph style from the layout configuration is used. Keep Together With Next Paragraph Check if this text should keep together with the following text or table. Table Add a table to the flow area to create new table elements. When selected some text in the table cell and do a right click you reach a sub menu: Copy Copy the selected text. If there are properties in the selected section, they will get copied as well. With a right click on a new Text the Paste occurs in the sub menu to paste this text. Reset Style Reset your previously setted character style for the selected text. Character Style Change the character style for the selected text. Move Table up Move the whole table up. Move Table down Move the whole table down. Delete Table Delete the table. Move Row down Move the row down. Move Column Right Move the column to the right. Cell Properties Editable Check editable if the end user should have the possibility to edit this table cell. Conditional Select the condition from the list of available conditions and properties of type boolean for the whole row from which you selected the cell. Select the: If If not condition. Optional Optional sections are very useful for the enduser to add several paragraphs or tables to a letter which are not used in all cases. In the cell properties you configure an optional row in a table. So the whole row from which you selected the cell is then an optional section. To use a table as an optional section you have two options (Selected or Unselected) Selected: The checkbox on the right sight in the end user view is already checked. Unselected: The checkbox on the right sight in the end user view is unchecked. For the title of the optional text there is now the possibility to set it multilingual. This has to be done about text table items. For this a locked Text Table 'DocumentTemplateOptions' is prepared which can be filled with items. This items can be used as multilingual optional sections. Only items in this text table can be used for the optional sections. Variation Only available if a variation in the content mode is defined. Select the variation from the list of the available variations. Then this row from the selected cell is only visible for the selected variation in end user view and PDF. Paragraph Style Select the used paragraph style for this text. If no paragraph style is set, the selected paragraph style from the layout configuration is used. Width Set the width of the cell. The size depends on the selected unit in the table properties. Default is percentage, so the whole row is 100 percent. Height Set the height of the cell. It depends on the selected unit in the table properties. Border Set the border for the cell. Vertical Alignment Select the vertical alignment for the text in the cell. Select: Bottom Center Top Keep with previous Keep the row from the selected cell with the previous row together. Table Properties Editable Check editable if the end user should have the possibility to edit: All; The whole table None; The table is not editable Conditional Select the condition from the list of available conditions and properties of type boolean for the table. Select the: If If not condition. Optional Optional sections are very useful for the enduser to add several paragraphs or tables to a letter which are not used in all cases. In the table properties you configure an optional table. So the whole tablel is then an optional section. To use a table as an optional section you have two options (Selected or Unselected) Selected: The checkbox on the right sight in the end user view is already checked. Unselected: The checkbox on the right sight in the end user view is unchecked. For the title of the optional text there is now the possibility to set it multilingual. This has to be done about text table items. For this a locked Text Table 'DocumentTemplateOptions' is prepared which can be filled with items. This items can be used as multilingual optional sections. Only items in this text table can be used for the optional sections. Variation Only available if a variation in the content mode is defined. Select the variation from the list of the available variations. Then this table is visible for the selected variation in end user view and PDF. Rows Define the number of rows for the table. Columns Define the number of columns for the table. Header Define the header for the table. Footer Define the footer of the table. Iteration The end user wants to print the information of all products (12 overall). All are of the same type with 10 product attributes. There are 2 possible ways to solve this Multiple tables: There are 20 tables needed. Each table stands for a single product and holds 10 rows with the product attributes. Multiple rows: One single table with 10 columns holding the product attributes. One row per product. The sum is 13 product-rows and a header as column caption. Prerequisites for the iteration: The Products are filled in the same propertyObject of collection type containing all product attributes as property items A single table can iterate over a double nested collection-property Static content including properties of non-collection type are always repeated in all iterations Unit Define the unit for the width/height of the table cells. Select between: Percentage Millimeter Notes Notes are used to give information to the end suer what to do. You have two possibilities for this notes: Normal note or with lines. The difference is the style that is applied. Note is just a yellow background and note with lines is like a page from a notebook. The style is applied when you close the configuration document template and in the workflow execution in the End User View. Notes are not used to produce letter, they are simple hints which facilitates the filling of data. They are the same like Text and: Do not have "Editable". They are never editable for the End User They can be "Conditional" They can be "Optional" They can be used in a "Variation". Have Paragraph Style's Have two three styles: Note; Yellow background Note with Lines; White background with lines Gray; Same background like text Can kept together with the next paragraph. Property Add a property into a text or table element. Domtrac classifies global properties and local properties: Global properties Global properties are added as objects to a property set. You can add the properties from the selected property set to the document template. If a property is multiple used in the same document template, they all have the same values. Name Optional name of the property. Property Select the needed property from the list. Editable If checked, the end user is aible to change the value of the property. Attention: If the property is multiple used in the letter and the end user changes this property, the changed value is adapted. A property from type collection can never get set editable. Mandatory Only available if editable is checked. When an end user execute a workflow he has to know which Properties in a Document Template should be filled mandatory or optional. A Document Template should have normal validation using the definition of the properties mandatory and mandatory receive where each of the values cannot be empty min max value of numerical Property min max length of a text Property Formatting Select a formatting from the list. The available formattings depend on the type of the used property. Local properties Local properties are used whose values should just occur in this document template individually and not in other documents. They are inserted like a global property and are always editable. Local Property Checked when the added property should be a local property. Name Mandatory name for the local property. Type Select the type of the local property from the list: Boolean Date Number Text Text Table Mandatory Always available, because local properties are editable. Initial Value Set an initial value f.e. a global property to fill it with this value or use the statement editor to define a new initial value. Formatting Select a formatting from the list. The available formattings depend on the type of the used property. Text Module Add a text module to the document template. If the text module contains properties you can add this text modules only if the used property in the module is part of the selected property set of the document template. So in the list when adding a text module, only the available are shown. There are two types of text modules: Type Block Text modules from type block can get inserted in text elements and notes. Type Inline Text modules from type inline can get inserted in text, table elements and notes. With the blue pencil you can add new text modules directly from the document template editor. Counter The end user wants to create a letter in PDF format. In his letter there are several paragraphs/sections with arbitrary subsections. The sections and subsections shall have a consecutive numbering matching their level. Add a counter to a text, a table or a note. Counter Select the counter from the list. Level Select the used level from the counter. The level depends on how much you configured for the used counter. Blue Pencil Configure a new counter directly from the document template editor. Text Table You have the permission to create and display multilingual document templates. Use text tables for defining Text in different languages. Text tables translate the items every time into default language of the document template and display in the correct language version in end user view. The end user can check the items displayed in his preferred language. Add a text table to a text, a table or a note. Text Table Select the text table from the list. Blue Pencil Configure new text table and new text table items directly from the document template editor. Page Break Set the page break after the section you needed. The page break is into a text section. Show Conditions Press the show condition button to make your used conditions visible. Green is an If condition Red is an If not condition Language The languages which you have defined in the layout configuration are available. Each new added language adapted the structure from the default language document template. This structure contains the sections which are added to the flow area (text and table). Copy Language If your letter is completely in the default language you can copy this content to another language, so the other language also needed to get translated. Name Name of the selection document templates. Property Set Select the used property set. Multiselect More than one result can get selected. Decision Table Text Module The configuration of Domtrac 5 provides text modules. With text modules the same content can be used in multiple separate document templates. Text modules can be created as text block modules or as inline text modules. Block style Text Modules constitute particular text sections in a letter. They start on a new Paragraph and can be created like sections in letter editor. A text block contains Paragraphs Tables Properties Counters Multilingual modules Conditional text blocks and tables The following settings can be set inside of a block style text module Paragraph Style Character Style Conditions Optional text block Editable sections Inline Text does not start on a new Paragraph like a text block, the Inline text is midst of a Paragraph. As a result of this Elements like Paragraph Style Optional sections has to be defined in the letter template on the selected text section. Also because of the fact that Inline text does not start a new Paragraph, it is not possible to add a table as an Inline Text. 1.Step: Configuration Category Select the appropriate category for the text module. Name The name of the text module configuration. Client Select the client, which owns this text module. If no client is set, it is a general text module, which every client can use. Description Optional description of the text module. Language Select the languages and the default language for the text module. See Language Selection for more details. Mode Select the used mode. Block Inline The configuration of Domtrac 5 provides text modules. With text modules the same content can be used in multiple separate document templates. Text modules can be created as text block modules or as inline text modules. Block style text modules provide a section of a document that can be reused in multiple different letter templates. A Text block is one or multiple paragraphs which can be used repetitively, for example to include a greeting. Block style Text Modules constitute particular text sections in a letter. They start on a new Paragraph and can be created like sections in letter editor. A text block contains Paragraphs Tables Properties Counters Multilingual modules Conditional text blocks and tables The following settings can be set inside of a block style text module Paragraph Style Character Style Conditions Optional text block Editable sections Inline Text modules provide a Word or phrase of a Paragraph in a Document that can be reused in multiple different document templates. Inline Text does not start on a new Paragraph like a text block, the Inline text is midst of a Paragraph. As a result of this Elements like Paragraph Style Optional sections has to be defined in the letter template on the selected text section. Also because of the fact that Inline text does not start a new Paragraph, it is not possible to add a table as an Inline Text. 2.Step: Configuration See also Document Template Content for a description of adding content. Dialog DONE Domtrac 5 provides a very efficient way to execute data inquiry and decisions, called Dialog. Instead of examining a document after correctness line by line, a Dialog proofs simply multi-page Documents without a huge effort. Usually, a programmer needs every time about 3 - 5 days to implement some Features which a Dialog provides and because of implementing every time manually the features, the programmer can't guarantee always properness. Hence, a Dialog ensure input and process efficiency. Thereby, the end user should often just print his document and proceed with it. If desired, the end user gets the permission to modify some data in a Dialog or can be asked to decide what is important to show in a Letter end user view and in PDF. The fact is that more and more B2B use digitalized processes, so that the use of documents is currently very rarely. B2C is still using documents during their processes often but the use will also decrease in the future. Dialogs in Domtrac 5, which commands at fine tuning, are therefore a very useful and future-oriented feature. It can replace the Document respectively Letter feature in Domtrac 5. A Dialog provides even much more features than a Letter in Domtrac 5 and avoids the complex use of it. Dialogs are used to input and modify properties. The configuration of the dialog consists of four steps: Configuration Content Rule Action 1.Step: Configuration The general settings for the dialog. Category Select the category to which this dialog will be added. Name The name of the dialog configuration. Property Set Select the Property Set from the list of available Property Sets. The property set determines the data that will be available to be used in the dialog. Description Optional description of the dialog. 2.Step: Content The layout of the dialog, this defines what is shown in the dialog. Palette Items You can drag and drop the Section component from the Palette to the content area. Sections cannot be dragged into other sections. You can drag and drop any other component to the section component into one of the available cells of the section. The following components are available from the palette: Section Field Text Area Note Label Check Box Date Combo Box Option Group Web Service Table Document Selection When configuring the settings for the component, you specify the property or properties to be used. Not all components can work with every available property type. With which type a component can work depends mainly on the complexity of the property type and if the property is a collection or not. Section The section is the container for all other dialog elements. Therefore you need to first add a section to be able to add any other elements to the dialog. You can add multiple sections to a dialog. Marker Optional marker name that can be used in rules for operation on the whole section. This is especially useful to hide or show a section. Caption The caption for the section shown in the dialog. Columns The number of columns for the section. Rows The number of rows for the section. Bold When checked the caption text is formatted in bold. Italic When checked the caption text is formatted in italic. Underlined When checked the caption text is formatted underlined. Font Size Define the font size of the caption text. Field Use the field to input or change a property. Caption Caption for the item shown in the dialog. Select from list if caption is: System Text Tables Static Property The property bound to the field. Optional The default is set depending on the Existence setting on the property: Receive Mandatory; optional is false and cannot be changed Mandatory; optional is false and cannot be changed Receive Optional; optional is true and cannot be changed Optional; optional defaults to true, can be changed (this also applies if Existence is not specified) Editable The default is set depending on the Existence setting on the property: Receive Mandatory; editable is false and cannot be changed Mandatory; editable defaults to false, can be changed Receive Optional; editable defaults to true, can be changed Optional; editable defaults to true, can be changed (this also applies if Existence is not specified) Input Prompt Text shown into the text field. Select from list if caption is: System Text Tables Static Text Area Use the text area to input or change a property. Caption Caption for the item shown in the dialog. Select from list if caption is: System Text Tables Static Property The property bound to the field. Optional The default is set depending on the Existence setting on the property: Receive Mandatory; optional is false and cannot be changed Mandatory; optional is false and cannot be changed Receive Optional; optional is true and cannot be changed Optional; optional defaults to true, can be changed (this also applies if Existence is not specified) Editable The default is set depending on the Existence setting on the property: Receive Mandatory; editable is false and cannot be changed Mandatory; editable defaults to false, can be changed Receive Optional; editable defaults to true, can be changed Optional; editable defaults to true, can be changed (this also applies if Existence is not specified) Input Prompt Text shown into the text field. Select from list if caption is: System Text Tables Static Note There is a palette item to add notes to a dialog: the note is a text area to give instructions and/or description to the end user display only multilingual allow having different styles of combobox, default = "Note" which should show as a yellow post it With this notes you can add long descriptive text in dialogs which contains page breaks and different styles like a colored back- or foreground, sizes and fonts. You have three possibilities for this notes: Normal note, with lines or grey backgrounded. The difference is the style that is applied. Note is just a yellow background and note with lines is like a page from a notebook. Grey notes have the same style like the Domtrac dialogs and do not differ from then. The style is applied when you close the configuration dialog and in the workflow execution. Style Select the style: Grey Note Note Note with Lines Configuration Configure the notes multilingual. Each language has its own space to configure the note. Use this palette to configure: Label Use a label to show values non editable to the end user. Marker Optional marker name that can be used in rules for operation on the whole section. This is especially useful to hide or show a section. Caption Caption for the item shown in the dialog. Select from list if caption is: System Text Tables Static Value Set an initial value f.e. a global property to fill it with this value or use the statement editor to define a new initial value. Bold When checked the caption text is formatted in bold. Italic When checked the caption text is formatted in italic. Underlined When checked the caption text is formatted underlined. Font Size Define the font size of the caption text. Check Box Define checkboxes for the end user. Caption Caption for the item shown in the dialog. Select from list if caption is: System Text Tables Static Property The property bound to the field. Editable The default is set depending on the Existence setting on the property: Receive Mandatory; editable is false and cannot be changed Mandatory; editable defaults to false, can be changed Receive Optional; editable defaults to true, can be changed Optional; editable defaults to true, can be changed (this also applies if Existence is not specified) Date Caption Caption for the item shown in the dialog. Select from list if caption is: System Text Tables Static Property The property bound to the field. Optional The default is set depending on the Existence setting on the property: Receive Mandatory; optional is false and cannot be changed Mandatory; optional is false and cannot be changed Receive Optional; optional is true and cannot be changed Optional; optional defaults to true, can be changed (this also applies if Existence is not specified) Editable The default is set depending on the Existence setting on the property: Receive Mandatory; editable is false and cannot be changed Mandatory; editable defaults to false, can be changed Receive Optional; editable defaults to true, can be changed Optional; editable defaults to true, can be changed (this also applies if Existence is not specified) Combo Box Define a combobox where the end user can select some values. Caption Caption for the item shown in the dialog. Select from list if caption is: System Text Tables Static Property The property bound to the field. Optional The default is set depending on the Existence setting on the property: Receive Mandatory; optional is false and cannot be changed Mandatory; optional is false and cannot be changed Receive Optional; optional is true and cannot be changed Optional; optional defaults to true, can be changed (this also applies if Existence is not specified) Editable The default is set depending on the Existence setting on the property: Receive Mandatory; editable is false and cannot be changed Mandatory; editable defaults to false, can be changed Receive Optional; editable defaults to true, can be changed Optional; editable defaults to true, can be changed (this also applies if Existence is not specified) Sort Alphabetically Sort the values in the combobox alphabetically. Option Group Give the end user an option. Also during the workflow execution the End User might want to decide which Document should be shown in Letter End User View and as PDF. Dialogs in Domtrac 5 provide such a selection with a Document Selection Component. There are two additional components providing a Document Selection within a Dialog: Option Group Document Selection The option group provides two ways to define the source of the document templates: Values from input Values from property By choosing the values from Property, Domtrac displays the right Documents predefined by Business admin, for example via XML. By choosing the values from Input, the Business admin select some predefined Letters within the Dialog. Caption Caption for the item shown in the dialog. Select from list if caption is: System Text Tables Static Property The property bound to the field. Optional The default is set depending on the Existence setting on the property: Receive Mandatory; optional is false and cannot be changed Mandatory; optional is false and cannot be changed Receive Optional; optional is true and cannot be changed Optional; optional defaults to true, can be changed (this also applies if Existence is not specified) Editable The default is set depending on the Existence setting on the property: Receive Mandatory; editable is false and cannot be changed Mandatory; editable defaults to false, can be changed Receive Optional; editable defaults to true, can be changed Optional; editable defaults to true, can be changed (this also applies if Existence is not specified) Sort Alphabetically Sort the values from the option group alphabetically. Horizontal Align the option group horizontal instead of vertical. Web Service If external data are needed in the dialog use the web service element. Caption Caption for the item shown in the dialog. Property The property bound to the field. Optional The default is set depending on the Existence setting on the property: Receive Mandatory; optional is false and cannot be changed Mandatory; optional is false and cannot be changed Receive Optional; optional is true and cannot be changed Optional; optional defaults to true, can be changed (this also applies if Existence is not specified) Editable The default is set depending on the Existence setting on the property: Receive Mandatory; editable is false and cannot be changed Mandatory; editable defaults to false, can be changed Receive Optional; editable defaults to true, can be changed Optional; editable defaults to true, can be changed (this also applies if Existence is not specified) Input prompt Text shown into the text field. Select from list if caption is: System Text Tables Static Web Service Select the web service from the list. Method Select the used method. Map Result Define your map result. In the first drop down select the property and assign it in the second property. Table When a table with data are needed where an end user can select. Marker Optional marker name that can be used in rules for operation on the whole section. This is especially useful to hide or show a section. Caption Caption for the item shown in the dialog. Select from list if caption is: System Text Tables Static Number of Rows Define the number of rows of the table which are shown. Data Source Select the data source: Object Properties Web Service Web Service Object Object Only available if the object is your data source. Select the needed object. Mode Only available if the web service and web service object is your data source. Select the mode of the web service: Find Find&Retrieve Load Load&Retrieve Web Service Only available if the web service is your data source. Select the needed web service from the configuration list. Object source Only available if the web service object is your data source. Select the needed object. Multiselect Not available if the data source is a web service object. If checked, the end user has the possibility to select more than one row of the table. Make at least one selection If checked, the end user has to make at least one selection before leaving the dialog. Columns 1) Select the needed label type: System Text Tables Static 2) Define the label text 3) Select the used property for this column 4) Define the position of the column in the table. 5) Assign the property where your selected property should map. 6) When checked this column is a reference value. So the end user select a row and navigates through the workflow and comes back to this dialog, Domtrac knows which row is selected. This is important if the data source is a web service which do not enter the values always in the same order. Example: A table, where the data source is a web service, so the data comes every time in a different order to the table. Name Firstname Customer Number Meier Fritz 1 Müller Paul 2 Meier Peter 3 Key is checked at Customer Number When the end user select the third row. Normally Domtrac remembers that the end user selected the third row but if he comes back to this dialog and still the third row is selected, it might be the wrong row now because the data has other order. But with the Key checked, Domtrac references on the value of this column so the right row will be selected again. Document Selection During the workflow execution the End User might want to decide which Document should be shown in Letter End User View and as PDF. Dialogs in Domtrac 5 provide such a selection with a Document Selection Component. There are two additional components providing a Document Selection within a Dialog: Document Selection Option Group Caption Caption for the item shown in the dialog. Property The property bound to the field. Optional The default is set depending on the Existence setting on the property: Receive Mandatory; optional is false and cannot be changed Mandatory; optional is false and cannot be changed Receive Optional; optional is true and cannot be changed Optional; optional defaults to true, can be changed (this also applies if Existence is not specified) Editable The default is set depending on the Existence setting on the property: Receive Mandatory; editable is false and cannot be changed Mandatory; editable defaults to false, can be changed Receive Optional; editable defaults to true, can be changed Optional; editable defaults to true, can be changed (this also applies if Existence is not specified) Document Templates 1) Select the document templates which are needed in this document selection. You have the possibility to add: Category Document Template Selection Document Templates 2) Select the configuration from the list. 3) Define if this template(s) are already selected for the end user. 4) Decide if this template(s) are optional or mandatory to select for the end user. Multiselect When checked the end user is aible to select more than one document template. This flag can only get set if the property is a collection. View Select the display mode for the end user: Tree View Radio Button Thumbnail Number of Rows Preview Only necessary if thumbnails are used. Define the number of rows which the end user sees. Number of Columns Only necessary if thumbnails are used. Define the number of columns which the end user sees. 3.Step: Rule Definition of rules that control what is shown and the validation of the dialog. Type The type of the rule defines what the rule actually does: Add Optional Value; add a value to the list of optional values shown in a option group or combo box. Assign; assign a value to a property. Mandatory; if property is set to mandatory, it will be tested that it is not empty. Read-Only; sed a property to read only, value cannot be changed. Remove Optional Value; remove a value from the list of optional values shown in a option group or combo box. Show Dialog; show dialog if condition is met, otherwise skip dialog. Show Property; show or hide a property. Show by Marker; show or hide a marker. Skip Completed Dialog; do not show the dialog if it is complete and the validation passes. Validate; validate the dialog. Message This field is only available for type Validate. The message to be shown when the validation fails. Property This field is not available for types Validate, Show by Marker, “Skip Completed Dialog” Marker This field is only available for type Show by Marker. Show when validation fails This field is only available for type Show Dialog. Condition The meaning of the condition depends on the Type of the rule: Validate; if condition is met, the Message is shown in the error panel when the dialog is validated. Mandatory; if condition is met, the property is set to mandatory, otherwise the property is set to optional. Show Property; if condition is met, the property is shown in the dialog, otherwise the property is hidden. Show by Marker; if condition is met, the marker is shown in the dialog, otherwise the marker is hidden. Markers can be defined for Sections, Notes and Tables. Description Optional description of the rule. 4.Step: Action Actions provide additional buttons for the end user and can be handled in the workflow for conditional processing. Style Domtrac differs between character and paragraph style. Character Name The Name of the character style configuration. External Name Name which is used at the formatter for the character style. Default TBD https://svn.docucom.ch/youtrack/issue/domtrac5-4796 Client Select the client, which owns this character style. If no client is set, it is a general character style, which every client can use. Font Family Select the font family. Font Style Select the font style. You can choose from: Bold Bold Italic Italic Regular Decoration Select the decoration for the characters: Linethrough Normal Overline Underline Font Size Select the font size. Color Select the color of the font. Superscript When checked, the font is superscripted. Description Optional description of the character style. Paragraph Name The Name of the paragraph style configuration. External Name Name which is used at the formatter for the paragraph style. Default TBD https://svn.docucom.ch/youtrack/issue/domtrac5-4796 Client Select the client, which owns this paragraph style. If no client is set, it is a general paragraph style, which every client can use. Character Style Select the character style from the list. Alignment Select the alignment of the paragraph from the list: Center Justify Left Right Spacing Define the spacing of the paragraph. Before Paragraph Define the space before the paragraph. There are several units to choose. After Paragraph Define the space after the paragraph. There are several units to choose. Bullet Symbol When define a listing, select a bullet symbol. Text Indent Define the text indent. There are several units to choose. Indent Bullet Define the bullet indent. There are several units to choose. Description Optional description of the paragraph style. Counter DONE In a document template there are several paragraphs/sections with arbitrary subsections. The sections and subsections shall have a consecutive numbering matching their level. Name The name of the counter configuration. Description Optional description of the counter. Counter Configure the counter: 1) Prefix of list 2) List 3) Suffix of list 4) Separator Preview The preview of the counter configuration is shown. 6.4 Data What is Data in Domtrac 5? Data is called Properties in Domtrac. To reduce complexity for the template author the data is NOT stored as an XML DOM tree. The data is stored in a simple table structure. For collections, the structure does not exist several times like an XML DOM tree, collections are solved object-oriented. This means, we create one object and use it several times. Data Types, Collections, and Aggregations How do we use Data in Domtrac 5? We can use incoming data in Domtrac internal data-structure or we create our own data holder in Domtrac. We have the following XML structure: 2015-11-03 111 Giacomo Guilizzoni Unterstrasse 1 Nebenstrasse 2 Hintenstrasse 1 1111 Einsingen 23456 Marco Botton Erste 1 Zweite 1 Tieflingen 3272752 Test User Vorne 1 Oben 2 Unten 1 3252 City Bemerkung In Domtrac, we call the root-element(in this case 'data-set') 'property set' Sub-elements(for example persons and person) with following elements are called property object in Domtrac. Last but not least, the last element in a XML structure is called property item in Domtrac. Every property object can have again a property object that belongs to the next tree level. root-element = property set subelement with followed elements(node) = property objects last element = property item Property Set with properties ExampleSet Customer.name Customer.persons Global.creationDate Property Set Property Property Objects with properties Customer name Text false persons Object:Person true firstPerson Object:Person false secondPerson Object:Person false Global creationDate Date false Person id Text false firstName Text false lastName Text false street Text true zip Text false city Text false description Text false Property Group Property Type Collection The use of Data(Properties) in Domtrac We define a property sets which are a group of properties. This property set can than be used in data assignment dialog letter other handles in workflow The properties are ordered by groups to allow for better recognition and ease finding them. Also, property groups can be added to another property group to allow to logically group data. Data Assignment Typically Domtrac 5 captures property values from XML data or file during import via Data Assignments. Domtrac 5 provides configurable Data Assignments. With the configurable Data Assignments, Domtrac 5 offers the possibility to manually configure simple and complex data mappings. Also the input types are configurable during the import of the XML files (Text, Boolean, Integer, Decimal and Date). Some of the properties are single values whereas others can have multiple values. Data Assignment has tree structure and the tree structure allows a huge possibilities. Example of a tree structures data assignment: Assignment of PowerOfAttorneysAll.authorityTakerGivenname: Tree structure of property: PowerOfAttorneysAll authorityTakerGivenname Tree structure of XML file: indivout document payload KD_STAMM REC_KD_STAMM VT_STAMM REC_VT_STAMM[*] VT_ZUORD REC_VT_ZUORD[*] VT_ZUORD_KD REC_VT_ZUORD_KD[*] VORNAME In this case, mapping look: PowerOfAttorneysAll = /indivout/document/payload/KD_STAMM/REC_KD_STAMM/VT_STAMM/REC_VT_STAMM[*] authorityTakerGivenname = $[PowerOfAttorneysAll]/VT_ZUORD/REC_VT_ZUORD[*]/VT_ZUORD_KD/REC_VT_ZUORD_KD[*]/VORNAME In each root property 'PowerOfAttorneysAll'(REC_VT_STAMM[*]) the propertyitem 'authorityTakerGivenname'(VORNAME) will be mapped. It is also possible to map with relative path. For example the condition can be configured with relative path. For Example: indivout document payload KD_STAMM REC_KD_STAMM XXX Relative path for condition: If $[PowerOfAttorneysAll]/../../XXX Then $[PowerOfAttorneysAll]/VT_ZUORD/REC_VT_ZUORD[*]/VT_ZUORD_KD/REC_VT_ZUORD_KD[*]/VORNAME There are three steps for the configuration of the data assignment: Configuration File Mapping 1.Step: Configuration Name The name of the data assignment configuration. Assignment Type TBD Document Object Set Object Available if Object is selected for Assignment Type. The object to be used for the assignment. Only the chosen object can be mapped. Property Set Available if Set is selected for Assignment Type. The property set to be used for the assignment. Only properties that exist in the property set can be mapped. Type The type of the file. Encoding The encoding used to read the data. Data Transform An option data transformation that will be executed before the assignment. Mapping has to be done on the basis of the transformed file. Description Optional description of the data assignment. 2.Step: File Upload You can upload a file by pressing the upload button. The previous file definition will be replaced. You should be careful not to upload a file with real data as the values will be visible as example data. Download You can download the file. This will give you a version of the xml with all the changes you made. If for any reason you prefer to make changes to the the xml, you are able to do so by downloading and uploading the file. Add Element Select an element in the xml view and press the add button in the right top to add an element as the child of the selected element. You can set the values in the popup. Parent The parent node for the element you are adding. Name The name of the element. Value An example of actual data for the node. When you uploaded real data, you should change the data here to avoid having real data shown unintentionally to users. Type The type of data, default is Text. When importing, the value will be transformed to the type. In the mapping the type must be compatible with the type of the target property. Text Integer Number Boolean Date Format The format is available when the type is set to Date. The format is used to read the date value and convert it to the date type. dmy mdy ymd Repeat Record; the xml has data for multiple orders. For each occurrence of the node an instruction is generated in the order. The resulting order will consist of 1-n instructions. Collection; repeated elements are treated as collections and can be mapped to properties of type collection. Delete Element You can use the add and remove buttons to add or remove an element from the xml. Select an element in the xml view and press add to add an element as the child of the selected element. Y Change Element When selecting a node from the view, you are able to edit the values. Node The name of the node or element. Value See Add Element above. Type See Add Element above. Format See Add Element above. Repeat See Add Element above. Maximum When you specify Collection for Repeat, you can specify the maximum number of elements here. When the maximum number of elements are specified, each element can be directly referenced in the mapping. Merge Merging works as follows: At least two XML elements at the same level must be selected for merge. After merging , and , these elements disappear and the combined tag appears Child elements of , and all appear under the new combined tag. If there are multiple child elements with the same tag name, only the first one is shown under the combined tag. When mapping, the merged tag matches any of of the merged tag names. Merged elements can be unmerged by unchecking the box. 3.Step: Mapping TBD Property In the terminology of Domtrac properties are variables that can be used in the definition of letters, dialogs, rules, etc. Properties are stored in the Domtrac database and can be configured by the client according to business requirements. If there exist multiple instances of a value Domtrac stores them in Collections. Properties can be added manually in the Domtrac User Interface or automatically using an importer which requires an XML file with appropriate data structures and syntax. To structure properties Property Sets and Property Groups are used. Typically Domtrac captures property values from XML-data or files during import via configurable Data Assignments. Property Types Values are usually stored in properties of simple types. One type that could hold any value is Text. It is recommended to store all values in properties of type Text. Only in the following situations you should use the specialized other simple types: The value should be printed in a special formatting. Samples are special output formats of a date or a number. The value is needed in a calculation like sum. The value is a boolean and should be used as a condition in a statement or directly as a condition in a letter. List of simple types: Text Boolean Integer Decimal Date Next to the simple properties, Domtrac provides linked properties which are based on features of Domtrac. The use of those properties is the same as with the Single Properties, which means that one can use them in interactive Dialogs and Letters. List of linked types: Client Currency Country Document Class Document Template Environment File Reference Form Type Language Printer User Service Level Text Table Collection Collections store and manipulate a group of Property Objects or a group of Property Items. They are defined as Object Collection as Definition in a Property Group. As Definition in a Property Item, you select Collection as Definition Type. The Collections are mapped with a star ( *). You can use the Collections within a Table, Dropdown and / or in Option Groups/ Checkboxes. Aggregation Aggregation for Calculation As a Domtrac User I would like to calculate Properties, change the value of the Properties and count the Properties. In Domtrac, there are different kinds of Aggregations Duration Duration in Words Date Integer Decimal String Count Distinct Values Sum Max and Min Distinct Values Decision Table An Aggregation behaves like a Single Property Item or a Property Collection and can be used in interactive Dialogs and Document Templates. Aggregations can only be added manually in the Domtrac User Interface and it is impossible to use automatically an importer which requires an XML file. To structure Aggregations, Property Sets and Property Groups are used. Aggregation on Collection Aggregation indicates a special relationship between classes. This type of relationship is referred to as a HAS-A relationship. It's a one-way street. The aggregate class contains a reference to another class and is said to have ownership of that class. Each class referenced is considered to be part of the aggregate class. Join A Join combines data from two sets of data. Take for example a data set that has a list of buildings and a separate list of households. Now you want to create an object collection of buildings including the household information. This combination is technically called a join. Domtrac allows to join from left to right, either all matching objects or all left objects with those entries on the right hand (households) that match. The right object collection could also come as a nested collection that needs some filtering. To explain this way to connect data with Domtrac here is the sample data of 2 tables: The buildings and the housholds. This sample will also be used in the exercise, where the data will come as an XML file. Buildings building address room door cupboard apartment_building Löwenstrasse 2, Zürich bathroom 2 2 apartment_building Löwenstrasse 2, Zürich bedroom 2 2 apartment_building Gotthardstrasse 43, Zürich bathroom 1 3 apartment_building Gotthardstrasse 43, Zürich bedroom 1 4 one_family_house forchstrasse 340, Zürich bathroom 2 2 one_family_house forchstrasse 340, Zürich bedroom 2 2 one_family_house Dufourstrasse 23, Zürich bathroom 3 5 one_family_house Dufourstrasse 23, Zürich bedroom 1 4 Housholds household address nameFirstPerson ageFirstPerson nameSecondPerson ageSecondPerson Single forchstrasse 340, Zürich Hans Muster 43 NULL NULL Couple Gotthardstrasse 4, Zürich Stefan Weil 28 Susann Weil 26 Single Dufourstrasse 23, Zürich Max Muster 31 NULL NULL Couple Löwenstrasse 16, Zürich Sven Tur 34 Maria Tur 30 The Inner Join Returns Objects that Match on Both Sides The join is defined as an object and the resulting object is the data of the two combined object. Name join as "MyObject". Join on buildings with name joinedbuildings and households with name joinedhouseholds would than result in a property MyObject.joinedbuildings.building.address and MyObject.joinedhouseholds.familySize.address. In Domtrac, Join is defined as following: The Condition is used to filter AND join the objects. Only the properties from objects that are joined should be available in condition. The join logic is Buildings -> Households (-> Object3). Example: Request: All households who have the same address like the buildings. SQL: SELECT household.address, nameFirstPerson, ageFirstPerson, nameSecondPerson, ageSecondPerson, room, room.door, room.cupboard, FROM households INNER JOIN buildings ON building.address = household.address Domtrac: Result: address nameFirstPerson nameSecondPerson ageFirstPerson ageSecondPerson room door cupboard forchstrasse 340, Zürich Hans Muster NULL 43 NULL bathroom 2 2 forchstrasse 340, Zürich Hans Muster NULL 43 NULL bedroom 2 2 Dufourstrasse 23, Zürich Max Muster NULL 31 NULL bedroom 1 4 Dufourstrasse 23, Zürich Max Muster NULL 31 NULL bathroom 3 5 The Left Join Returns All Elements from the Left Objects Together with the Matches on the Right Side The Left Join is the same as Join but the Objects from collection "Buildings" should also be added when there is no match found for "Households". Example: Request: All households who have the same addess like the buildings. SELECT household.address, nameFirstPerson, ageFirstPerson, nameSecondPerson, ageSecondPerson, room, room.door, room.cupboard, FROM households LEFT JOIN buildings ON building.address = household.address Result: address nameFirstPerson ageFirstPerson nameSecondPerson ageSecondPerson room door cupboard Löwenstrasse 2, Zürich Hans Muster 43 NULL NULL bathroom 2 2 Löwenstrasse 2, Zürich Hans Muster 43 NULL NULL bedroom 2 2 Gotthardstrasse 43, Zürich NULL NULL NULL NULL bathroom 1 3 Gotthardstrasse 43, Zürich NULL NULL NULL NULL bedroom 1 4 forchstrasse 340, Zürich NULL NULL NULL NULL bathroom 2 2 forchstrasse 340, Zürich NULL NULL NULL NULL bedroom 2 2 Dufourstrasse 23, Zürich Max Muster 31 NULL NULL bathroom 3 5 Dufourstrasse 23, Zürich Max Muster 31 NULL NULL bedroom 1 4 Lookup In Domtrac, Lookups are created as Property Items but they behave like a Property Group. Lookups are defined within a Property Group and takes the Property Items from totally different Property Group which is mandatory a Collection and is in the same Property Set as their Object. So, the Property Group "Account" saves with this Lookup-Object, Property Items, which are from a foreign Object. This creates a relationship between the two objects "Account" and "AddressesAll". The Lookup is often used within a Dialog Table or in a Table within a Document Template. Statement Editor In Domtrac 5, the End User executes his Workflow and sometimes he needs withal doing more complex mappings in Domtrac 5. These mappings include optional assignments filtering of tables mapping from different locations in the input file to one location in the property structure assignment of default values even if there is no corresponding input field handling of different data types (string, date, int, decimal) aggregations (concat, sum) In Dialogs of Domtrac 5 you can use the statement editor for this cases. Statement editor is the modal dialog that comes up if the user clicks on the 3 dots inside a blue circle in a Label element. It allows to assign calculated and conditional values. The rules to calculate the value are: if-then-else / switch-case conditions with various different types of comparison based on the type of the left side operand (includes collection, date, number, string, boolean) Assignment of values Static string property / xml field line breake multiple complex string operations in a popup window (split, regexp replacements, substring, lower/uppercase ...) Configuration of Property Set Name The name of the property set. Description Optional description of the property set. Add Add the objects which are needed for the property set. Configuration of Property Group Name The name of the property group. Definition Select the definition of this group: Object Object Collection Join Left Join Subset Subset with Regular Expression Based On Only available if the property group is defined as object or object collection. Description Optional description of the property group. Add Add the items for the property group. Configuration of Property Item TBD Condition The letter content varies, e.g. with regards to different genders, recipients and customer types (like students, employees, retired persons,etc.). This means that one letter templante will be used to generate several variations of one letter. The business admin of the letter template defines this different content blocks (like variations of paragraphs, words or phrases) in advance. Conditions referred to content units are rules to ensure that the end user can only select the intended content units or the right combination of content in the letter. Conditions also determine which content units are editable and which must not be changed (e.g. due to compliance issues). While executing the workflow the end user decides and selects the needed content units or edits certain sections if needed in order to met the requirement of his specific business transaction. Test Data Data Transformation Formatting In general there are three types of formatting configurations can be applied: Number Date & Time Character Let's assume some identity number should be in the form XX/XXX-XX but usually the input data looks like XXXXXXX. In this case the correct formatting of the incoming data could be set with a formatting rule of type Character and can directly be attached to one or more specific properties. Additionally a single rule can be extended to have one configuration for several document languages as well. Therefore the english delimiter for numbers plus the desired format could be used for english documents only, while the same format could be applied for german documents with german delimiters. 6.5 Communication Message Queue The queue view in the production menu is used to control the queues. Queues can be started or stopped individually or all queues can be started or stopped. When all queues are started, only the queues that have the Auto Start Flag set will be started. Start or Stop all queues You need the appropriate authorization to be able to start and stop queues. To start all queues, press Start All in the top right. Please note that only queues will be started when Autostart is defined for the current environment. For more information see the queue configuration. To stop all queues, press Stop All in the top right. Start or Stop individual queues You need the appropriate authorization to be able to start and stop queues. Find the queue you want to start or stop in the table. You can use the filter in the top to show only queues that match your search. Right click on the queue to show the context actions for the queue. When the queue is already started, you will only have the context action available to stop the queue. When the queue is already stopped, you can only start the queue. Web Service E-mail Simple Network Management Protocol (SNMP) File Transfer 6.6 Devices Printer Inserter 6.7 Stationery Document Class Klassen eines Dokuments. Normales Papier / Deckblatt / Schachtsteuerung / Form Type Envelope 6.8 System Application DONE Application Configuration Name The name of the application configuration. Operating System You can specify the operating system when you input a configuration for an application. Than you can add another configuration for an application specifying another operating system or no operating system. When the configuration is retrieved for execution, it will first check if there is a configuration for the operating system it is running on. If not, it will try to retrieve the configuration where no operating system has been specified. The ability to input configurations for different operating systems is normally used to support development or testing Domtrac on another operating system as where the production is run. Type The type of application. Selecting the right type is important as it will control what variables for parameters are available. Command Base Directory When you select a Directory here, it will be used to compose the path to the Command. The path of the Directory will be the first part of the full path to the executable. Command The executable without any parameters. The parameters are defined in the parameter section. If the Command Base Directory was specified the executable is appended to the path to obtain the full path to the executable, otherwise you need to specify the full path to the executable here. Working Base Directory Optionally you can select the Directory from the list that will be used as the first part when composing the full path to the working directory. See Working Directory. Working Directory The Working Directory can be specified with or without the Working Base Directory to compose a path to the working directory which is made available as a variable in the parameter section. When the Working Base Directory is not specified, the path here is the absolute path to the working directory. Resource Base Directory Optionally you can select the Directory from the list that will be used as the first part when composing the full path to the resource directory. See Working Directory. Resource Directory The Resource Directory can be specified with or without the Resource Base Directory to compose a path to the resource directory which is made available as a variable in the parameter section. When the Resource Base Directory is not specified, the path here is the absolute path to the resource directory. User Id The User Id you input here is available as a variable when defining the parameters. Password The Password you input here is available as a variable when defining the parameters. Description Optional description of the Application. Application Parameter You can define multiple parameter configurations. Name The name for the parameter configuration. Timeout The execution will timeout if not completed before the amount of seconds specified here. Description Optional description of the Application Parameter. Parameter The parameters used when executing the application. Application Return Value You need to at least define the return values returned by the application on successful termination as this will be used to determination if a fatal error is thrown or not. Return Value The return value that the application will return on termination. Type The type of the return value configuration. - Success - Busy - Warning - Error - Unknown If the application returns with a value with a type other than Success or Warning, a fatal exception will be thrown. Description Optional description of the Application Return Value. DirectoryTBD Setting TBD Define the settings. Document Viewer Maxmimum Pages Count Maximum Documents Java Image Renderer PDF Renderer Compression Quality Use cache Format Default Zoom Custom Style Image Reference Alpha Interpolation Anti Aliasing Text Anti Aliasing Color Render Dithering Fractional Metrics Interpolation Renderer Stroke Control Background Enclosure Caption Added Access Key 1 ID 1 for enclosure. Caption Added Access Key 2 ID 2 for enclosure. Caption Added Access Key 3 ID 3 for enclosure. Data Map REST API Select the mapping for the request from the list. Is based on objects and defines how the result should look like. Source Select the source for the enclosures from the list. Type Select the type for the enclosures from the list. Group Select the enclosure group from the list. Region Select the region for the enclosure fom the list. Formatter Maximum Parallel Batch Define the maximum of parallel batch. Maximum File Size Define the maximum file size. Minimum File Count Define the minimum file count. Maximum File Count Define the maximum file count. Number of Retries Define the number of retries. Number of Retries Batch Define the number of retries for batch. Maximum Files in Directory Define the maximum files in directory. Maximum Number Parallel Define the maximum number of parallels. Courier Data Selection Select the data selection from the list: Manual Packed Printed Delivery Select the courier delivery from the list: Directory E-mail Interactive Timeout Receive Define the timeout receive for the courier. Print Folder Select the print folder from the list. Print Folder Registered Select the registered print folder from the list. Workflow Timeout Define the timeout in seconds for the workflows. Skip login for qualified workflow requests When checked, the user can start a workflow in Domtrac from a pseudoSSO without login in Domtrac. The external ID and principal name need to be deposited at the workflow. Error Handling Define the error handling. HTTP redirection on error Enter the redirection on error. HTTP redirection on completed Enter the redirection when completed. IFrame host URL Enter the URL for the IFrame host. Enable iframe server-side valiation When checked, an iframe server-side valiation is enabled. Disable Print Preview When checked, the printer on preview is disabled. Watermark Document Preview Define a watermark with static text for the preview. If a property is needed for the watermark you have to define it at the Document Viewer handle. Output Decentralized Printing Not implemented yet. Immediate The jobs for decentralized printing will processed immediatelly. Suppress Duplex When checked, duplex is disabled. File Header Header for Postscript file. Compart CPMillVersion Select the version for the CPMill from the list. Profile Directory Select the profile directory from the list. The profile directory is available when the directory is defined. Licence File Select your CPMill licence. PDF-Toolbox Enabled When checked, the PDF-Toolbox is enabled. Preview Maximum Wait Interval Delete Files System General Customer Default for Customer is DOCUCOM. Environment Select the environment from the list: All Demonstration Development Education Integration None Production Test Default is development. Theme Select the domtrac Theme. Modules Check additional modules to the basic. Module Description Courier Journals ASK ERICK Development Shows also the functions which are not implemented yet. For example in the Workflow Editor are handles shown, which will be implemented in future but at the moment only the handle is shown. Document Template Adds the Document Template Handle to the Workflow Editor. Security Show Domain at Login When checked the domain is shown at the login. But attention: This is only shown when the 'Is Visible Domain' is checked. (Access -> Authentication) Default Domain Select your default domain from the list. Max logged-in Users When needed, define a maximum number of logged-in users. Maximum Login Attempts Define a maximum attempts to log in on Domtrac. Base url SSO callback External Password Management Allow Creation of Locations Default Client Session Timeout Error Handling Logging Fault Tolerance Serialization Language DONE Define languages for Domtrac UI and documents. Code Enter the language code. UI Language When checked, the language is used for the UI. Default Only available if UI Language is checked. Define if this language is a default for the UI. Document Language When checked the language is used for documents. Default Only available if Document Language is checked. Define this language as default for the documents. When both defaults checked, this language is the default language. Description Translate the language to the others. Translate to Default Translate the language to the default language. 6.9 Other DONE The submenu other contains the formatter file definitons and the mainentance. Formatter Define the formatter files which are used for the document templates. Name Name of the formatter definition. Description Optional description of the formatter definition. Property Set Select your formatter property set from the list. Execute Select the formatter application from the list. This application calls the formatter. Layout Select the layout file from the formatter. The layout file for GMC Inspire is a .wfd file. Configuration Select the configuration file for the call from the formatter. The configuration file for GMC Inspire is a .job file. Template Select another layout file from the formatter. The layout file for GMC Inspire is a .wfd file. This layout file needs to be referenced in the main layout file. This is for example used in finnova batch. The file contains logo's, styles etc. Warnings Select the warnings file from the formatter. The warnings file for GMC Inspire is a .wpr file. This file handles the exceptions. Name Name of the formatter file bundle. Description Optional description of the formatter file bundle. Upload By clicking on add, you can upload the formatter file. Upload Select the formatter file. Name Will automatically filed with the name of the uploaded file. You can rename it when needed. Size Will automatically filed by the size of the uploaded file. Valid From Will automatically filed by the current date. Released When checked, the file will be released. Maintenance Some code changes need a general change, f.e. migrate all dialogs by opening and save or set property sets to the start handles. To simplify, this submenu supports you. Release Locks Objects are locked when a user is working on it. With this button these locked objects get released. Migration... Migration means the selected entities will opened and saved and then are migrated. Select the affected entity and click Update. Wait until the message occurs. The total shows the migrated entities: Set Property Set on workflow Start Handle Not implemented yet. 6.10 Change Management DONE The submenu Change Management contains the import of data in Domtrac 5. Packages is used to import and export Domtrac5 datas / doing back-ups and similar things. The semantics library manager is for example aible to change word files into a structure which matches with the domtrac structure. The business adapter import is a powerful tool to manage the data in Domtrac5. Package Import To import a package select the file. Restore the package with a right click: 1.Step: Restore Name Shows the name of the package which will be imported. Description Shows the optional description of the package. Type Shows the type of the package: Full or selective. Version Shows the number of the version with which this package was made. Number of entities Shows the number of entities included in the package. When importing a package there are three possiblitites how to handle the data of the existing environment and the environment in the importing package. So we have the existing configuration and the importing package: Existing configuration includes: Original Letter A Original Letter B Original Letter C Original Dialog 1 Original Dialog 2 Property Set: BusinessAdapter Country CH with States SG and ZH Importing package includes: Original Letter A Modified Letter B Original Dialog 1 Modified Dialog 2 Dialog 3 Property Set: BusinessAdapter with a new Object Country CH with States BS and GR Delete not included configuration When checked, configurations which are not included in the importing package will get deleted on existing configuration. Result: Existing configuration after import: Original Letter A Modified Letter B Original Dialog 1 Modified Dialog 2 Dialog 3 Property Set: BusinessAdapter with a new Object Country CH with States BS and GR But this only applies to chosen ones (Directories for example will not get deleted). The configurations from the following list will get deleted: CharacterStyleEntity FormatterDefinitionEntity TextModuleEntity PropertySetEntity PropertyGroupEntity DataMapEntity EnvelopeEntity ParagraphStyleEntity PropertyFormattingEntity LetterEntity PropertyConditionEntity QueueEntity WebServiceEntity WorkflowEntity CounterEntity DynamicFormEntity Merge Existing Childern When checked, the data of the importing package and the existing configuration will get merged. Nothing will be deleted. Result: Existing configuration after import: Original Letter A Modified Letter B Original Letter C Original Dialog 1 Modified Dialog 2 Dialog 3 Property Set: BusinessAdapter with a new Object Country CH with States SG, ZH, BS and GR No checkbox selected If neither Delete not included Configuration nor Merge Existing Childern is selected, the existing configuration will stay except the configuration which are modified in the importing package. Result: Existing configuration after import: Original Letter A Modified Letter B Original Letter C Original Dialog 1 Modified Dialog 2 Dialog 3 Property Set: BusinessAdapter with a new Object Country CH with States BS and GR 2.Step: Progress Search Function to search for entities in the package. Message Entities which are incuded in this package. Message Type If there are warnings or errors, they are written in this column. 3.Step: Select In this table you can select which entities should be imported from the importing package. There is also a filter dropdown to select the entities: Filter Criteria Delete Filter the deleted entites. Ignore Filter the ignored entities. Insert Filter the inserted entites. None Filter the entites which are not changed. Reference Filter the referenced entities. Update Filter the updated entities. Search Function to search for entities in the package. Add a new Package Making a new package provide two options: A Full Package or a selective package. The full package generates a ZIP file of the whole configuration of the environment. For doing a selective package there are two possibilities: At the first step Select, the used elements can get selected. On the environment do a right click on the necessary elements and click Export 1.Step: Select Name The name of the package. Description Optional description of the package. Selection As default all elements are selected. If you want to made a selective package, unselect the not used entities. 2. Step: Progress When the package is finished, this step gives you an overview about the content of the package. Search Function to search for entities in the package. Message Entities which are incuded in this package. Message Type If there are warnings or errors, they are written in this column. The created package can get downloaded with a right click. Semantics Library Manager Importer (CML) 1.Step: Import Upload Upload the XML file which is generated from the Semantics Library Manager. Document Template Category. Type the name for the document template category for the imported documents. Confirm with enter. Default is Compound-Documents imported by %s on %s User Group Select the user group. Create Dialogs When checked and dialogs are in the xml, Domtrac will create the new dialogs. Document Viewer Depeding on if your XML file contains a workflow, with this flag you can add a document viewer to the workflow. This handle needs to be configured. Property Group Name Type the name for the property group for the imported properties. Confirm with enter. Default is LMVariable Use Data Assignment Depeding on if your XML file contains a workflow, with this flag you can add a data assignment to the workflow. Property Set Select thr property set in which the property group should add. Language Select the property which contains the languages for the documents. Paragraph Style Select the default paragraph style for the imported document templates. 2. Step: Preview Select Formatter for Type Form Select the formatter for the forms from the list. Document Template Select the formatter for the document templates from the list. Contract Select the formatter for the contracts from the list. Regulation Select the formatter for the regulations from the list. Assign Counters Default Select the default counter from the list. On the right site is an overview about the imported elements. Here an example: Type Select the type of the item from the list: Dialog Document Template External ID Select Item Select the used item. External ID Name of the external ID. Business Adapter Adding properties automatically by importing an XML file. Upload Click on upload button and select the needed XML file. Node Name Root Define the node root from the uploaded XML file. Use Strict Rules This is mostly used when setup Domtrac as a new project. The old system already uses kind of datastructure. This structure maybe contains rules how to map for example. Example: That these complex structures matches with the Domtrac structure, you can checked this box. Add to Property Set When checked, the new properties will added to a property set. Property Set Only available if Add to property set is checked. Select the property set from the list or type the name of a new property set and confirm with enter. So this new property set will be created. Data Assignment Only available if Add to property set is checked. When checked a data assignment will be used or a new one will be created. Name Only available if Data Assignment is checked. Select the data assignment from the list or type the name of a new data assignment and confirm with enter. So this new data assignment will be created. Data Transform Only available if Data Assignment is checked. Select the data transform from the list. Is used to execute an XSL transformation. Sample File Only available if Data Assignment is checked. The name of the sample file will occur in this box when uploaded one. Upload Only available if Data Assignment is checked. Click on second upload button and select the needed XML file.