H A N D B O O K. Tools. Intrexx 7

Transcription

1 H A N D B O O K Tools Intrexx 7

2 Contents 1. General Service Determine from which portal the message was sent System Monitor Sessions Databases Performance Global Locks Export Search Engine Task Scheduler Settings Execution time Execution Options Subsequent Jobs SystemCare System Check Archive Older Log Files Check Application Tables for Correct Assignments Error Inspection and Maintenance of the System Deletion of Older Portal Exports Check Databases for Characters That Cannot Be Exported Diagnosis Log Files Parser Validate Form and Request Values Menu Extras / Options UNITED PLANET - INTREXX 7 - TOOLS 2

3 Copyright This document is in all its parts protected by copyright. All rights are reserved, especially the right of translation, presentation, reproduction, and duplication. Regardless of the accuracy of the text, images, and programs neither author, publisher nor translator may take judicial or other responsibility for possible errors and their consequences. The naming conventions, trade names, product designations, etc. reproduced in this work may, even without special designation, be trademarks, and as such may be subject to legal regulations. Writing conventions In this handbook, text passages will be displayed in italics when they refer to settings or buttons in the displayed dialogs. Menu items that are available in context menus can, in addition, always be selected from the main menu. Main menu items will only be described if they are not available in the context menu. A description of the general main menu items can be found in the Start handbook. Programming code in the text will be displayed in the Courier font. Context menus can be opened by clicking with the right mouse button on the described element. In the following, installation path refers to your Intrexx installation path. For example, on Windows operating systems, the default path is c:\programs\intrexx, on Linux by default /opt/intrexx/. Portal directory refers to an existing Intrexx portal directory. You can find all files belonging to a portal in this directory, for example, under Windows it would be c:\programdata\intrexx\<portal name>. You can find the portal directory from the portal properties, which is available from the Portal main menu. This symbol will be used for designation of special kinds of information. Background knowledge For this handbook, you require no special training. You can find helpful information in the Intrexx handbook Start. UNITED PLANET - INTREXX 7 - TOOLS 3

4 1. General In the Tools module, you will find a comprehensive collection of tools for the administration and care of portals. You can reach the individual tools by clicking the corresponding link in the left-hand area of the module. With the arrow symbol to the left of the tool name further functions of the tool can be displayed Service With the -Service tool, you can configure Intrexx to send s (see handbook Applications / Chapter Buttons). Please click Configuration here. UNITED PLANET - INTREXX 7 - TOOLS 4

5 Enter the default sender here, to be used if no individual sender is defined in an application or process. Click Next to continue. Enter the name or the IP address of the SMTP Server and the SMTP port (default: 25). If you are unsure of what to enter, please contact your system administrator. The mail server used must not necessarily exist on the local network of the Intrexx Portal Server. The entries under the options for Authentication correspond to the settings required by your mail server. For the connection security, the options None, STARTTLS and SSL/TLS are available. In the Authentication method area you can specify the type of password checking that will be used. The PLAIN setting transfers the password unencrypted as plain text. With LOGIN, the password is taken unencrypted from the user input in the terminal. With CRAM-MD5, the password is encrypted with the CRAM-MD5 algorithm; with NTLM the authentication is performed using NTLM. Below the settings, the user name and password should be entered. Click Next to continue. UNITED PLANET - INTREXX 7 - TOOLS 5

6 Maximum size The maximum size of sent s can be specified here. If this field is left empty, the size will not be taken into account. Select your required unit using the drop-down list. By default, 10 MB is predefined as the maximum size. This corresponds with the expected computer network norm for the maximum message size (e.g. preset value by Postfix or Microsoft Exchange Server. In general, it should only be modified when you re certain that the potential recipients can receive messages of this size. Maximum number of s per session Here, the Max. number of s per SMTP session can be constrained. If there are several mails to be sent at the same time the smtp session will be terminated after reaching this limit. In the next transit a new smtp session will be created for the sending of the s. The waiting time between the two transits of the sending loop is defined by the de.uplanet.lucy.sendmail.sleepinterval property (default : 1000 ms ). Archive sent s If the setting Archive sent s is selected, then sent s will be stored in an archive file. Create process event, if cannot be sent If this setting is active a de.uplanet.lucy.server.mailservice.workflow.event.ibadmailworkflowevent is created after a final unsuccessful sending to which can be responded via the generic event handler de.uplanet.lucy.server.mailservice.workflow.eventhandler.badmailworkfloweventhandler. In the lower part of the dialog box you can define the time intervals, after which unsuccessful delivery attempts will be retried. We recommend keeping the recommended settings. Maximum number of retries In Maximum number of retries, you can specify the number of times that an undeliverable mail should be re-sent. Subsequent retry intervals Below you can set the duration of the first, second, third and subsequent retry intervals. Each interval will be calculated from the last time the sending was attempted. Click Next to continue. UNITED PLANET - INTREXX 7 - TOOLS 6

7 By clicking Test, the configuration can be tested. If error messages are output, either the configuration must be changed or no mail server that can be used for the SMTP service exists. If you are unsure of how to proceed, please contact your system administrator. The Exchange 2007 mail server does not accept the sending of mail from nonauthenticated users in the standard configuration. If the sending of mail from nonauthenticated users is to be enabled, the following command must be entered in the Exchange shell: Get-ReceiveConnector "CONNECTORNAME" Add-ADPermission -User "NT AUTHORITYANONYMOUS LOGON" -ExtendedRights "ms-exch-smtp-accept-any- Recipient" The placeholder CONNECTORNAME must be adjusted for the infrastructure of the customer in this case. The user NT AUTHORITYANONYMOUS LOGON can also vary, depending on operating system and language. By clicking OK, the configuration will be completed. UNITED PLANET - INTREXX 7 - TOOLS 7

8 If the service has been setup, the individual expert settings will be listed here. The settings can be changed by clicking on Configure. UNITED PLANET - INTREXX 7 - TOOLS 8

9 The value of a setting can be edited with a double click in the Value column. By clicking on Delete setting, the property is removed. Information on the various expert settings can be found here: By clicking on Add setting, new properties can be created. Here JavaMail properties can be selected and defined with a value, or custom properties can be entered directly into the selection list Name. For full details about the settings, see: Click on OK to apply the new properties Determine from which portal the message was sent Starting with version 6 of Intrexx, it is possible to set global headers when sending messages. These are placed in every message sent via the Intrexx service. A UNITED PLANET - INTREXX 7 - TOOLS 9

10 common convention is to the names of custom headers with X- if they are not defined by standards. To define a global header, create a new property in the expert settings described above, named de.uplanet.lucy.sendmail.header. Follow it with an ascending number, such as: de.uplanet.lucy.sendmail.header.1 Enter the prefix X- to the value of the key (see above), followed by the name of the header, a colon, and the name of the portal. For example: X-Intrexx-Portal:MyPortal With it, all s that are sent from the portal My portal can, for example, be filtered in Outlook. In our example above, the message header will be X-Intrexx-Portal:MyPortal. 3. System Monitor The System Monitor will inform you of the current load on the portal Sessions By clicking on Sessions, you will be shown the number of users currently logged onto the portal. The GUID of the user, their name, the login time, the time zone, and the language settings will be shown in the right-hand area. UNITED PLANET - INTREXX 7 - TOOLS 10

11 Via the context menus send (sends to all users of the selected sessions) and send E- Mail to All (sends to all currently logged on users) a dialog for sending a message will be opened. Here you can enter the Subject and Message text of the Databases In the Used column, the number of current database connections will then be shown on the relevant database. In the Poolsize column, the size of the data connection pool will be displayed; the Requested column informs you of the number of requested connections since the portal was started. If a database connection is selected, you can open the pool details by selecting Show details from the context menu or by double-clicking a database connection. UNITED PLANET - INTREXX 7 - TOOLS 11

12 This provides you with information about the time a connection was established, and the start and end of the activity. Select Empty pool from the context menu to empty the currently selected pool. You can generate a pool manager report by selecting the menu item Database / Generate connection pool report. Here you will find information about the connection details regarding the database, such as the number of connection requests, time zone, pool size, and additional properties. The report will be written to the poolreport.log file in the log directory of your portal, from which you can call up the history at any time. UNITED PLANET - INTREXX 7 - TOOLS 12

13 3.3. Performance With the performance monitor, the load on the system will be observed. The current memory usage will be graphically displayed in the lower area of the System Monitor Global Locks Locked objects are listed here. Read and write locks will be designated with differing symbols. UNITED PLANET - INTREXX 7 - TOOLS 13

14 4. Export With the Export tool, time-controlled portal exports can be set up. The complete portal will be exported with all data. Clicking Configure allows settings to be edited (see Handbook Import / Export). In the lower area, all exports will be logged. 5. Search Engine A portal export is no sufficient substitution for a professional backup. Intrexx uses the Lucene open source search engine for the full-text search of the entire portal and for the portal applications. Newly entered and changed data records will be automatically added to or refreshed in the index of the search engine. In this, the settings for the search in the applications are definitive. There the fields will be defined that will be taken into account in the search. The content of these fields will be written to the index. It will also be taken into account there as to, according to the settings in the applications, a word analysis should take place or if HTML is to be interpreted (see handbook Applications II). Data attachments and files that are included through FileWalker connections (see Integration handbook) will also be indexed. Please note that PDF documents can prevent indexing through their security settings. With the context menu of an object, the indexing can also be manually started. UNITED PLANET - INTREXX 7 - TOOLS 14

15 Three menu items can be selected here: Index Directories will be searched for changes (such as new or deleted files) and added to the index. Reindex entries containing errors Indexes and entries, for which the index contains no indexed data, will be reindexed. Recreate the index The complete index will be deleted and recreated. The Edit context menu item allows an execution time that will be regularly run to be set (see handbook Integration). The Messages context menu item will ouptut all messages for an executed task in an additional window. In the Index Browser, all files that have been included with a FileWalker integration will be listed. In Search filter, you can search for individual files and thereby restrict this list. UNITED PLANET - INTREXX 7 - TOOLS 15

16 6. Task Scheduler With this tool, via the context menu Edit Schedulder the schedulers for all tasks in the portal can be edited (see following chapter). Via the context menu Last messages, a log will be opened of the last time a task was run. Via the Details context menu item, you can reach the log of individual runs. Here you will be informed of the starting, ending, and execution status of a task. Via Stop, a task can be ended. By clicking on Delete, the selected entry will be removed from the list. Messages outputs all messages in a new window. A task will be initiated by selecting Start from the context menu. The RDF link maintenance, a standard task, will be automatically started daily at 12 AM and deletes all orphaned links. The context menu item Copy GUID copies the GUID of the task to the clipboard. Delete Job deletes the currently selected task. Deactivate job shuts off the automatic execution of a task. Edit scheduler opens a graphical view of all tasks on the timeline. UNITED PLANET - INTREXX 7 - TOOLS 16

17 In the upper area the starting date, i.e. the date on which the execution plan is to begin, can be set in the Show from field. The duration of the execution time period to be shown in the plan can also be selected from the Range list Settings The context menu settings, which can be reached via a selected task or via the Task Scheduler tool, a dialog opens in which the history of tasks can be set. The Limit maximum length of history per job setting here lets you define how many entries per task are saved in the history. Enter the desired number to Number of entries. With Limit maximum age in the history per job, the age of entries saved to the history can be restricted to the desired time frame. UNITED PLANET - INTREXX 7 - TOOLS 17

18 6.2. Execution time The context menu item Edit Schedule opens the settings dialog for the automatic execution of a corresponding task. You can find a description of the settings in the handbook Integration Execution Options With the setting Run at server startup when schedule has been missed task will be executed that have not been carried out while the server has been stopped. In Maximum history length an integer to which the entries in the history are limited can be entered. Maximum history entry age restricts the milliseconds, seconds, minutes, hours or days entries in the history are shown. Additionaly an address can be entered, to which a message will be sent as soon as the Status occurs that is entered to the selection list below. UNITED PLANET - INTREXX 7 - TOOLS 18

19 The following settings are possible: Never A message will not be sent. Errors A message will be sent if errors occur upon execution. Warnings A message will always be sent. Always A message will be sent when warnings or errors occur Subsequent Jobs You can find a description of the settings and functions in the upper area of the dialog in the Data Transfer chapter of the Integration handbook. In addition, you can enter the GUID here of a process event, which will then run once the job has been completed normally. UNITED PLANET - INTREXX 7 - TOOLS 19

20 7. SystemCare SystemCare provides you a collection of tools for system maintenance at your fingertips. The functions of Systemcare are only available, if you are logged in as a global administrator (menu item Extras/Administrator Login) System Check By clicking Run System Check, the tool will check which of the following tasks should be executed: Archive old log files Check application tables integrity Error inspection and maintenance of the system Deletion of older portal exports Check databases for characters that cannot be exported If the system check has finished, checkboxes will be shown in front of the relevant tasks. UNITED PLANET - INTREXX 7 - TOOLS 20

21 With Execute Tasks, you can start the tasks you have selected with the checkboxes. Mark All Tasks will select all relevant tasks. Tasks whose execution is not required will not be offered for selection after system check. In the Current Status column, you will be informed of the corresponding results of the system check. If a task has been executed, this column will show the date it was last run Archive Older Log Files This module checks directories that contain log files. If you select the task, an additional window will open. Select the older log files to be archived in the Compress log file column. Click OK to continue Check Application Tables for Correct Assignments The portal database will be checked here for data records with missing assignments to a superior data record. Data records without assignments will be listed in their own window if you mark the task Check application tables for correct assignments and then click on Details. You will be informed here about the structure of the applications and the names of the database tables in which data records without assignments were found Error Inspection and Maintenance of the System The software update ensures that your system always remains in the most current version, that any programming errors that may occur will be fixed, and that new features expand the abilities of your system. UNITED PLANET - INTREXX 7 - TOOLS 21

22 Occasionally, for tests or additional actions, like for example updates to the database, it may be necessary to manually start these actions. In this case, the corresponding actions will be added to the SystemCare function for System Inspection and Maintenance, and can then be initiated whenever you wish Deletion of Older Portal Exports The export directory that you have entered in the Export tool for the storage of portal exports will be checked. If the system check finds older portal exports, you will be able to select the task. The portal name and the number of portal exports in the export directory will be shown. If you click the Delete column, a selection list will open, in which you can decide which older exports should be deleted. The checkbox in the Execute column will be automatically marked. Click OK to continue. You can now start the task by clicking Execute Tasks Check Databases for Characters That Cannot Be Exported This check will return characters in the portal database that cannot be exported. Please note that this check can require several minutes and should only be run if portal exports have failed. Mark the checkbox to the left of the title of the task. Select the portal and the repair mode here (Check only, Delete, or Replace with empty character the characters that cannot be exported) for the check, then click OK. The task can now be run. With Details, the results of the check will be shown in their own window. UNITED PLANET - INTREXX 7 - TOOLS 22

23 All database tables of the audited portal will be listed here. If characters are found in a table that cannot be exported, they will be shown formatted in red under the table name Diagnosis In the Diagnosis area, a list of log files or configuration directories can be compressed in a zip file where it can be sent to technical support. Please mark the checkboxes in front of the files or directories that are required to resolve your support case. Also select the Portal for which the information will be saved. Next, click Save Information in order to save the ZIP file in a directory of your choice. UNITED PLANET - INTREXX 7 - TOOLS 23

24 7.3. Log Files Parser Here you can access the content of all log files of your portal. If a log file is selected, the content will be shown in the right upper area. There you can find various filters for the log list. With Type, you can select to restrict the messages between the types Info, Warning, Error, Debug or Startup. In the Filter field, one may additionally search for specific terms. Delete filter text will delete the search text from the input field. Here you can also open any log file from a directory available to the server by clicking logfile. The default directory for Intrexx logfiles can be found under <portal>\log. logfile refreshes the log list. Open Reload If you select an entry the details will be shown in the lower area. You can view detailed information about an entry in an additional dialog box from the context menu for an entry. Via the context menu you have also the ability to Show the complete Log File or to Show only the Entries of this Type. UNITED PLANET - INTREXX 7 - TOOLS 24

25 8. Validate Form and Request Values This tool gives you the ability to inspect forms and request values. If you highlight the tool, you will see a list of the internal parameters in the right-hand area. A filter can be set above the table. Simply enter the search term into the edit field. The filter can be removed by clicking Remove filter. If you deactivate the setting to Show system parameters, only the parameters will be shown that you have defined yourself. Select Edit from the context menu if you wish to edit a parameter. With internal system parameters, you only have the ability to change the Error message that will be output in the logfile. Click OK here. With the context menu item Add, your own parameters can be defined for the check. UNITED PLANET - INTREXX 7 - TOOLS 25

26 Enter the name of the parameter to be checked in Name, such as rq_test, if you want to test a user-defined request parameter with this name. The following areas of validity can be selected: Systemwide Restricted to the application page Restricted to the application area Portalwide Items with greater areas of validity take precedence here. With the Systemwide area of validity, a parameter will always be checked, whereas selecting Restricted to application area will only check the parameter values within an application. If you wish to test, for example, whether your test parameter has the value Hello on the main page of an application, select the Restricted to application page area of validity. Next, select the mode for the error output. Here you have the option of outputting it as a Warning in logfile or Error message in logfile and cancel action. A description of the validator types can be found in the appendix. For our example, the type Test valid values against a predefined list is appropriate. After you have selected an area of validity that refers to an application, you can in the following, by clicking on Search, select the desired application, or if the area of validity Limited to application page is selected, also select the page. Next, click OK. UNITED PLANET - INTREXX 7 - TOOLS 26

27 In Error message, you can enter a text that will be output into the logfile if an error occurs. With Test valid values against a predefined list, the allowed value must also be defined in the lower area of the dialog. Click on Add in order to enter a value. In addition, you must decide whether Empty values are allowed, and whether Capitalization should be taken into account. The logfile portal.log, to which the portal log will be written, can be found in the directory intrexx\org\portal\log. For the parameter type Test against a regular expression (see appendix), you can enter the Pattern that you want to search for. You can recognize a valid pattern with the symbol; an invalid pattern has the symbol. In the Test field, you can enter character strings in order to test your pattern. You can recognize valid entries with the symbol, and invalid entries with the symbol. UNITED PLANET - INTREXX 7 - TOOLS 27

28 9. Menu Extras / Options Here you can activate Expert Options. With this setting the deleting of individual schedules via the context menu will be enabled. UNITED PLANET - INTREXX 7 - TOOLS 28

29 2016 United Planet. All rights reserved. Intrexx and United Planet are registered trademarks of United Planet, Freiburg - Germany. All manufacturers, products and services mentioned in this text are trademarks or registered trademarks of their respective companies in Germany and other countries worldwide.