Attunity RepliWeb Web UI Guide

Transcription

1 Attunity RepliWeb Web UI Guide Software Version 5.2 June 20, 2012 RepliWeb, Inc., 6441 Lyons Road, Coconut Creek, FL Tel: (954) , Fax: (954) Support:

2 Copyright 2012 RepliWeb Inc., All Rights Reserved The information in this manual has been compiled with care, but RepliWeb, Inc. makes no warranties as to its accuracy or completeness. The software described herein may be changed or enhanced from time to time. This information does not constitute a commitment or representation by RepliWeb and is subject to change without notice. The software described in this document is furnished under license and may be used and/or copied only in accordance with the terms of this license and the End User License Agreement. No part of this manual may be reproduced or transmitted, in any form, by any means (electronic, photocopying, recording or otherwise) without the express written consent of RepliWeb, Inc. Windows, Windows XP and Windows Vista are trademarks of Microsoft Corporation in the US and/or other countries. UNIX is a registered trademark of Bell Laboratories licensed to X/OPEN. Any other product or company names referred to in this document may be the trademarks of their respective owners. Please direct correspondence or inquiries to: RepliWeb, Inc Lyons Road Coconut Creek, Florida USA Telephone: (954) Fax: (954) Sales & General Information: Documentation: Technical Support: Website: info@repliweb.com docs@repliweb.com ii

3 Table of Contents 1. Introduction... 1 Requirements... 1 Supported Browsers:... 1 Terminology Getting Started... 3 Logging In... 3 Selecting a Center... 5 Opening New Tabs... 5 Navigating Between Tabs... 6 Logging Out... 6 Job Information... 6 Viewing Job Information... 9 Viewing Job Reports Job States Performing Actions Actions Toolbar and Context Menu Items Display Options Filtering the List of Jobs Navigating Between Pages Switching between Hierarchical and Flat View Job Refresh Options Clearing Display Preferences Working with Tags Sorting According to Column Showing/Hiding Columns Rearrangind Column Order Changing Column Width Searching for Jobs iii

4 Table of Contents Basic Search Advanced Search Report Types iv

5 1. Introduction RepliWeb R-1 provides multi-stage deployments and multi-farm replication for enterprise environments. R-1 enhances and extends native tools, offering a traditional development-toproduction solution that allows administrators to control, schedule and distribute content, code, visual and functional releases into production or DMZ environments. R-1 addresses the challenges of deploying content across multiple offices, branches and data centers, by ensuring reliable and scalable distribution regardless of content size, structure and complexity. R-1 Multi Center Web UI enables Application Developers and Content Authors to monitor and manage replication jobs created by the R-1 administrator. Requirements Browser - DOM compatible, JavaScript enabled browser (Microsoft IE, Netscape Gecko, Firefox, or other). Supported Browsers: Browser Version Internet Explorer 6.0, 7.0 and 8.0 Firefox 2.0 and above Safari and above Chrome 8.0 and above 1

6 Introduction Terminology The Center is the initiator of any distribution or replication job. Thus, any reference to the direction of data transfer is, by convention, relative to the Center. Center - The Center is the initiator of any R-1 job (distribution or replication) and must therefore be installed on any system that will initiate a job. Edge - The Edge component must be installed on any system that responds to distribution and replication requests initiated by a Center. It is a passive element that runs as a background process, and is awakened by a distribution or replication request originating from a Center. In a distribution process, more than one Edge may take part as the receiver of the distributed data. In a replication process, only one Edge will be involved, either as the receiver or the sender of the data. Upload Job A job that uploads data from the Center to an Edge (a one-to-one operation). Download Job - A job that downloads data from an Edge to the Center (a one-to-one operation). Distribution Job - A job that distributes data from the Center to several Edges (a one-tomany operation). On Demand Job A job configured by the R-1 administrator as needed. On Demand jobs can be configured for any of the available job types: Upload, Download, or Distribution. Source The source is the computer from which the data is copied. In an upload or distribution job, the source is the Center. In a download job, the source is the Edge. Target The target is the machine which the data is copied to. In an upload or distribution job, the target is the Edge (or Edges in the case of a distribution job) to which data is uploaded. In a download job, the target is the Center. Rollback Rollback can be compared to the undo function. It enables content to be returned to its pre-replication or pre-distribution state. Rollbacks can only be performed on the target machine and only on completed or aborted jobs. Scheduled jobs can be rolled back to instances of the job. Replication jobs (Upload/Download) can be rolled back to restore the target to its pre-replication state. Distribution jobs can be rolled back completely (for all Edges) or per Edge. Transactional Deployment Transactional Deployment enables the entire replication process to be defined as one single transaction that replicates all of the files at once. This eliminates content inconsistency when replicating to multiple targets by ensuring that all of the content is published or "committed" at the same time. The R-1 administrator can set conditions that must be met in order for the deployment job to be committed. One of these conditions is Upon user approval (indicated by the icon in the Commit Transaction Condition drop-down menu) which requires you to approve the transaction before it is committed. 2

7 2. Getting Started This chapter describes how to log in to the R-1 Multi-Center Web UI, how to open new tabs and how to log out. Logging In Using R-1 Multi Center Web UI, you can log in to multiple R-1 Centers from a single tabbed interface. To open R-1 Multi Center Web UI: 1. Open a Web browser. 2. Enter the address of the R-1 Web Site in your browser s address bar and press [Enter]. The address should be provided by your system administrator. The login screen is loaded. 3. Fill in the fields as described in the table below. Option/Field Description Center The IP address or host name of the R-1 Center machine. User name Password Your user name for accessing the specified R-1 Center. Your password for accessing the specified R-1 Center. 3

8 Getting Started Option/Field Domain Log me in automatically next time Description The domain to which the R-1 Center belongs. If you select this option, the Center will be added to the Centers List. When you next select the Center from the Centers List, you will be logged in automatically without needing to specify login credentials. Note: Your session is saved for a period of 30 days beginning with your last login, after which it expires. Open tab automatically next time Use Alternative Port Selecting this option will open the tab for the specific Center the next time the R-1 Multi-Center Web UI is opened. If the Log me in automatically next time option was also selected, you will be automatically logged in to the specified center. To display/hide this field, click the Options button in the bottom right of the login screen. Only choose this option if instructed to do so by the R-1 administrator. 4. Click Log In. The R-1 Multi Center Web UI opens. Click the label text for more information about a specific feature. 4

9 Getting Started Centers List Actions Toolbar Filter Toolbar Display Toolbar Job Types Search for Jobs Tags Pane Jobs List Job States Selecting a Center When logging in to a Center you can select the Log me in automatically next time option to access the Center without needing to specify a username and password each time. If you select this option, you will be able to select the Center from the Centers drop-down list located in the top right of the R-1 Web UI. You will be automatically logged into the selected Center. Opening New Tabs You can log in to as many Centers as necessary, simply by opening a new tab for each Center. This option is especially useful if you have jobs running on multiple Centers. Or, you can open multiple tabs for the same Center and set different display preferences for each of the tabs. For example, in one tab you can display completed jobs while in another tab you can display active jobs. To open a new tab: Click the button located in the top right of the R-1 Web UI. 5

10 Getting Started Navigating Between Tabs You can use the tab navigation buttons located in the top right of the R-1 Web UI to easily navigate between open tabs. Tab Navigation Buttons If the number of open tabs exceeds the width of your current display, the button color will change from green to brown. In the example below, the left tab navigation button is brown, indicating that at least one tab is not currently visible on the left side of the screen. Logging Out You can log out of each Center separately or you can log out of all Centers simultaneously (when logged into multiple Centers). To log out of all Centers: Click the Log Out All button in the top-right corner. Note: When you log out of multiple Centers, the Log me in automatically next time option will be cleared in each Center for which it was enabled. To log out of the current Center: Click the Log Out link above the Actions Toolbar. Note: If you log out, the Log me in automatically next time option will be cleared. Job Information The information provided in the job list is divided into columns. You can sort the information in the job list by clicking any of the column headings. A downward-facing triangle indicates that the column is sorted in descending order whereas an upward-facing triangle indicates that the column is sorted in ascending order. For example, jobs sorted by Submit Time would be indicated as follows: Ascending Order - Descending Order 6

11 Getting Started The table below provides a summary of the information displayed. More detailed information can be accessed by opening the Job Details and Job Report windows. For information about changing the column display settings, see the Web UI Setup and Customization Guide. * indicates columns that are hidden by default. Column Heading Type Description Currently, the following job types are possible: Upload represented by the following icon: Download represented by the following icon: Distribution represented by the following icon: For a description of each of the available job types, see Terminology. Name (Optional) The name given to the job by the R-1 administrator. Description Optional) The description given to the job by the R-1 administrator. Edge Submit Time The host name or IP of the machine to which data is being transferred (in the case of an upload/distribution job) or from which data is being transferred (in the case of a download job). The date and time on which the job was submitted. Note: The time reflects the time on the Center machine. State Job Id Completion Time Completion Message Stage Target Source Demanding User Parent ID Scheduled Time Demanding User Domain Chain ID The current state of the job. See Job States. A unique ID automatically assigned to the job for identification purposes. The time at which the job was completed. The job s completion message. The current stage of the job. The job s target (Directory for R-1 and URL for ROSS). The job s source (Directory for R-1 and URL for ROSS). The job s demanding user. The instance s Scheduled job ID. The job s scheduling policy. The domain of the user who demanded this job. The job s chain ID. 7

12 Getting Started Column Heading Chain Name Chain Originating Center Demanding Job Name Demanding Center *Last Child ID *Last Child Submit Time Description The job s chain head. The Center of the job s chain head. The name of the job that demanded this job. The Center machine where the demanding job is located. A unique ID automatically assigned to the child job for identification purposes. The date and time on which the child job was submitted. Note: The time reflects the time on the Center machine. *Last Child Name The name of the last child job (determined by the R-1 administrator). *Last Child Completion Time *Last Child Completion State *Last Child Completion Message *Last Child Stage *Last Child Demanding User The completion time of the last child job. The completion state of the last child job (Completed, Failed, etc.) The message displayed at the end of the job, e.g. R-1-E- Aborted by user QA\qa. The current stage of the Last Child Job e.g. Initializing, Checking Licenses, etc. If the R-1 administrator enabled the Run as Demanding User option, this column will display the username of the user who submitted the job. 8

13 Getting Started Viewing Job Information You can view job information by selecting the job and clicking the toolbar button or by rightclicking the job and selecting from the context menu. The information in the Job Information window is refreshed according to the Refresh settings (periodically or manually). 9

14 Getting Started Viewing Job Reports A detailed report is available for completed jobs. Multi-stage jobs may provide several reports, one for each stage of the job. For a full list of available reports, see Report Types. To view a job s report: Either right-click the job and select from the context menu. -OR- Select the job and click the toolbar button. The Job Report window opens: 10

15 Getting Started Job States The State column displays the current job status. The possible states are described in the table below. The state of a particular job determines which actions can be performed on it. State Description A Job that has been submitted to the Center for execution. Running replication (upload/download) job. Aborted replication job. Running distribution job. Aborted distribution job. Scheduled jobs. Aborted Scheduled job. A replication rollback job. Aborted rollback job. Running distribution rollback job. Aborted distribution rollback job. The R-1 administrator can define a timeframe within which a job will be executed. Jobs outside of the execution timeframe enter a holding state which is indicated by this icon. Jobs in-between recovery attempts. A job that is held because a job with higher priority has been submitted. A replication or distribution job being held. A job held by the R-1 administrator. A transactional deployment job waiting to be committed. A successfully completed job. A job that has failed after completing a predefined number of recovery attempts. 11

16 3. Performing Actions You can perform actions on individual jobs or a group of jobs, either using the Actions Toolbar or using the job right-click menu. Available actions are determined by the current state of the job. For example, the Submit option is only available for on-demand jobs. The actions that can be performed for a specific job will only become available once that job is selected. For example: Before the job is selected: After the job is selected: - the Abort, Hold, Hold Until, View Job Information and View Job Report actions become available: To perform an action on a single job using the Actions Toolbar: Select the job and then click the toolbar button. To perform an action on multiple jobs using the Actions Toolbar: Select the jobs and then click the toolbar button. To perform an action on a single job using the right-click menu: Right-click the job and then select the required action from the context menu. To perform an action on multiple jobs using the right-click menu: Select the jobs and then right-click the selection and choose the required action from the context menu. Actions Toolbar and Context Menu Items The following table describes which actions are available. 12

17 Performing Actions Menu Item/ Toolbar Button Click To: Submit the selected job. This option is only available for On Demand Jobs. Schedule a date and time on which the selected job will be submitted. This option is only available for On Demand Jobs. Abort the selected job. Available for running and held jobs. Commit a transactional deployment job that requires user approval. Hold the selected job. Hold the selected job and specify a date on which the job will be resumed automatically. When you click the opens. button, the Choose Date and Time window Click to choose a date. Confirm the snapshot of a job in Preview state and continue with the replication process. Review the snapshots of the target and source trees, including directories, subdirectories, and files. If required, modify the actions to be performed on the target s files/directories before the Transfer stage begins. Note: Snapshot is a mapping of the source and target directories, which lists file sizes, modification times and dates, security permissions, and shares (where applicable). When you click the button, the Job Preview window opens: 13

18 Performing Actions Menu Item/ Toolbar Button Click To: Display all directories and files included in the source and target. Display only files and directories that are directly below the source and target directories. Snapshot display Visual display of the data on the source and target. legend The data elements (files, directories, etc.) used in the snapshot display. legend The actions to be performed by the job on the target. legend The changes that may done to the job. To edit the action to be performed on a data element: Select the appropriate data element s checkbox until the required icon appears, according to the Selection legend. Cancel all changes made in the Preview list. - Cancel all changes made in the Preview list and close the Preview window. The job will remain in Preview state until the job is confirmed. Apply any changes made to the snapshots in the Preview window and continue the job. For more information about the Preview feature, refer to the R-1 User Guide. Resume the selected job. Only available if the selected job is in a holding state. 14

19 Performing Actions Menu Item/ Toolbar Button Click To: Roll back last instance. Only available for scheduled On-Demand jobs. Note: The same job can be rolled back several times. However, you must wait for one rollback instance to complete before submitting another. View additional information about the jobs. See also Viewing Job Information. View a report of the completed job. See also Viewing Job Reports. 15

20 4. Display Options To increase monitoring efficiency, you can use the Filter Toolbar to filter the list of jobs according to state. Filtering the List of Jobs Toolbar Button Click To: Show or hide submitted jobs. Show or hide running jobs. Show or hide successfully completed jobs. Show or hide failed jobs. Show or hide aborted jobs. Show or hide scheduled jobs. Show or hide holding jobs. Show or hide recovering jobs in-between recovery attempts. During a recovery attempt, the job is in a running state. Show or hide jobs waiting for snapshot confirmation. 16

21 Display Options Navigating Between Pages The number of jobs displayed on each page is determined by the R-1 administrator. The number of pages populated with jobs is displayed in the bottom right of the interface. Available navigation options are shown below. Select a page from the drop-down list. Click to go to the first page containing jobs. Click to go to the last page containing jobs. Click to go to the previous page. Total number of pages containing jobs. Click to go to the next page. Switching between Hierarchical and Flat View You can switch between Hierarchical View and Flat View using the Display Toolbar buttons. In Hierarchical View, parent and child jobs are displayed hierarchically as shown below: The applicable toolbar buttons are as follows: Toolbar Button Click To: Switch between hierarchical and flat views. Collapse the current display. Only available in hierarchical view. Expand the current display. Only available in hierarchical view. 17

22 Display Options Job Refresh Options You can refresh the job list manually by clicking the can enable the auto-refresh option. button in the Display Toolbar or you To enable auto-refresh: Click the down arrow to the right of the refresh icon and then select Enable Autorefresh. Clearing Display Preferences The list of jobs that is currently displayed is determined by the following factors: Which filters are currently enabled Whether the currently displayed jobs are the result of a search Whether only jobs associated with a specific tag are being displayed All of the above You can clear all currently active display preferences or select which ones to clear. To clear all display preferences: Click the toolbar button in the Display Toolbar. To clear specific preferences: 1. Click the triangle in the toolbar button. 2. From the drop-down menu, click one of the following as appropriate: o Clear tag o Clear state filters o Clear search 18

23 Display Options Working with Tags The R-1administrator can tag related jobs for easier filtering. Any tags that have been created by the R-1administrator will be displayed in the Tags Pane. When you click a tag only the jobs associated with that tag are displayed. Note: Tags are not available in hierarchical view. To hide/display the Tags Pane: Click the horizontal triangle located on the left side of the interface (about half way down): Tags Pane Hidden Tags Pane Revealed To only show jobs associated with a specific tag: Click the tag name (for example, Upload in the image below). To clear a tag: Click Show all Click the clear button in the toolbar, and choose clear all or clear tags Click the tags link in the message that appears above the jobs grid. 19

24 Display Options Sorting According to Column To sort the job list according to a column: Click the column heading to sort in ascending/descending order. Showing/Hiding Columns To show or hide a column: Hover the mouse cursor over the left side of the column heading and click the dropdown button that appears. Select/unselect as needed, and move the mouse cursor away. Rearrangind Column Order To move a column: Drag the column heading to the desired location. Changing Column Width For more advanced ROSS Web UI customization options, see the Web UI Setup and Customization Guide. To change the width of a column: Drag the column heading s left or right border as needed. 20

25 5. Searching for Jobs You can search for jobs using the Basic Search option or you can fine-tune your search using the Advanced Search options. Note: Search functionality is not available in hierarchical view. Basic Search Use Basic Search to find jobs whose exposed properties match the value specified in the search box. Exposed properties are properties that are visible in the Jobs List such as the job name or job ID. To search for jobs whose properties match the specified search value: Enter the value in the search box in the upper right and click GO. Advanced Search If you were unable to find the jobs you were looking for using Basic Search, use Advanced Search to include non-exposed properties in the search criteria. To use Advanced Search: 1. Click the icon. The Advanced Search dialog box opens. 2. Define a search expression as follows: a. Select a job property from the drop-down list at the beginning of the row. See for a description of the available properties. b. Select an expression from the drop-down list in the middle of the row. c. Type a value in the box at the end of the row. 21

26 Searching for Jobs So, for example, to find all jobs whose source location is you would specify the search expression as follows: 3. To add another search expression, click the button. You can add as many search expressions as you like. So, for example, to find all completed jobs whose source location is you would specify the search expression as follows: 4. To remove a single search expression click next to the search expression that you want to remove. 5. To remove all search expressions added since the last search click Undo. 6. To begin the search click OK. 22

27 Searching for Jobs Advanced Search Properties The following table describes the job properties available in the Advanced Search dialog box. The values for each of the job properties are available in the Job Details report. Property Description ID Each job is allocated a unique ID by the R-1 Center. Name The job name as defined by the R-1 administrator. Type Edge Source Target Stage Scheduled Message Submit Time The job type i.e. Upload, Download, Distribution. The computer(s) from/to which is replicated. The location of the source content before it is replicated. The location to where the source content is replicated. Jobs consist of several stages. Examples of stages include Gather remote info, Check license End and so on. Jobs can be scheduled to run periodically, at a predefined time, or on the arrival of a trigger file. The message will vary according to the job completion status. For example, a failed job may display the following message (indicating the reason for its failure): R1-F-Failed at initialization The job s submit time. End Time Note: You may select the required end date by clicking the calendar icon. The job s end time. Last Child Submit Time Note: You may select the required end date by clicking the calendar icon. The submit time of the job that was last fathered. Note: You may select the required end date by 23

28 Searching for Jobs Property Description clicking the calendar icon. Last Child End Time The end time of the job that was last fathered. Note: You may select the required end date by clicking the calendar icon. 24

29 6. Report Types Each R-1 job generates report files that can be used for monitoring and troubleshooting purposes. Since these reports can consume vast amounts of disk space, they are automatically purged after a predetermined amount of time (set by the R-1 administrator). After a report is purged, it becomes unavailable for viewing. R-1 generates various reports during the different stages of the distribution process. Note that if a stage was not performed (i.e. Post Command was not executed) the corresponding report will not be generated. General - Contains job information and properties (like Source and Target directories), and specifies the stages the replication/distribution process is going through (e.g. license validation, transfer, post command, etc.). Transfer - Provides information about the transfer progress. See below the various styles this report can have. This report is available only if transfer actually took place during the distribution job. Pre Distribution Command - Logs the batch file executed on the Center before the distribution process started. This report is available only if Pre Distribution command was actually executed. Post Distribution Command - Logs the batch file executed on the Center after the distribution process completed. This report is available only if Post Distribution command was actually executed. Pre Center Command - Logs the batch file executed on the Center before the distribution to a specific Edge started. This report is available only if Center Pre command was actually executed. Post Center Command - Logs the batch file executed on the Center after the distribution to a specific Edge completed. This report is available only if Center Post command was actually executed. Pre Edge Command - The pre_replication report logs pre-command information for replication jobs, and Edge Pre-Replication information for Edge pre-commands, for Distribution jobs. Post Edge Command - The post_replication report logs post-command information for replication jobs, and Edge Post-Replication information for Edge post-commands, for Distribution jobs. Pre Commit Command - Logs the batch file executed on the Edge before the transfer phase to this Edge completed. This report is available only if the Edge Pre Commit command was actually executed. Post Commit Command - Logs the batch file executed on the Edge after the transfer phase to this Edge completed. This report is available only if the Edge Post Commit command was actually executed. 25

30 Report Types Deleted Files - Lists the files that were deleted from the target directory during the distribution process (before and after actual transfer took place) Excluded Files - Lists the files excluded from the distribution process when the user selects to ignore inaccessible files these files will be listed in this report. Rollback Recorder - Lists the files recorded in a job that keeps rollback data. This report is available only if the Rollback option was turned on and files were about to delete or change during the transfer stage. Rollback Reloader - Lists the files recovered during a Rollback job. This report is available only in Rollback jobs. IIS 6 Metabase Transfer - Lists the various IIS components that were replicated. This report is available only in jobs replicating IIS 6 Metabase. IIS 7 Configuration Transfer - Lists the changes made to each IIS 7/7.5 item s configuration on the target. This report is available only in jobs replicating IIS 7 configuration. Monitor - The Monitor dialog box opens, displaying the current and previous Continuous Update job instances. For more information, refer to the Monitor Window section. MSI Deployment Provides information about the deployment progress of the job s MSI files on the target. 26