DevHelper Installation and User Documentation

Introduction: The DevHelper is an internal application with the aim of centralizing functionality required by files developers. This includes but is not limited to: gathering file information, deploying patches, providing shortcuts to R drive, aiding in triage process, creating schemas, aiding time entry process etc.

INSTALLATION REQUIREMENTS:

- Google Chrome must be installed (do not download from the app store)- Must have a schema_creation folder (C:\schema_creation\)- Must have a DevHelper folder (C:\DevHelper\)- Must have WebMethods installed and set up- WmFlatFiles package installed in WebMethods- WebMethods localhost must be running- In WebMethods, check out RpAdminServices (this is necessary)

INSTALLATION INSTRUCTIONS:

- Copy DevHelper.jar (found R:\BenIT\Files\All\Tools\DevHelper\DevHelper.jar to your local Desktop

- Copy the DevHelper_lib folder (found @:R:\BenIT\Files\All\Tools\DevHelper\DevHelper_lib to your local Desktop

- Double click the patchProcessor.jar file to open

UPDATE INSTRUCTIONS:

- When an update is released you will see a pop-up the next time you open DevHelper asking if you want to update, click Yes. You can also update manually by clicking the “Update DevHelper” button on the files tab in DevHelper.

DevHelper Instructions:

Double click the DevHelper.jar file to open the program

On initial login you must input your credentials for our various applications: FIST,Sharepoint,Localhost,LAN,Maestro etc. Note: Not required on subsequent log in.

Initial Log In Screen:

If you enter the incorrect localhost credentials you will receive the below notification. You must re-enter the correct login credentials and click “Submit” again to confirm.

Upon successful log in, you will see the following screen. The program will default to the Files tab. To start you can press the Maestro sync button, which will pull tickets from your maestro queue

(note: new files may not pull if service details have not been entered). You can also add files manually by entering the fileID in the text field and hitting the enter key or pressing the “Add” button as shown below:

Once you do this an instance of the patchProcessor (shown in blue) will be created, in addition helpful file information will be displayed (shown in orange) you can also view the lookup table keys by clicking the Lookup Table tab (shown in green) and the Desc/Comments tab will show the associated Description/Most recent comment from the maestro ticket (shown in red) (note: only available from maestro sync, not manual file add). The patchProcessor defaults to the New CR tab, a New CR is one which has not yet had a patch deployed to it (otherwise you would use the Existing

CR tab. See image below.

There is also one more piece of functionality on the Files tab that is note-worthy. If you right click the FileID in the window there will be several functions you can do (remove file from list, open FIST QC/PROD page, open sharepoint page, open QC/PROD R drive folder, open Maestro ticket (only available with Maestro sync) See image below.

Deploying a patch (New CR/Existing CR):

To deploy a patch enter in all the fields (shown in pink) and click the deploy patch botton. The first field (Package.Folder.Service) can be obtained by right clicking the HA service of your file in WebMethods and clicking copy. You can then paste into the first field in the patchProcessor. See image below.

Once you click the Deploy patch button you will see the progress bars move to 50% (shown in red). The timers to the left of the progress bars (shown in orange) show when the patch(zip) will be picked up from the R drive by robocopy. See image below.

DevHelper will constantly monitor the R drive, as soon as all the progress bars are at 100% (the patch has cleared the R drive) the program will automatically deploy a chrome browser and perform the necessary actions to install the patch to FIST. (Note: the blue labels for lccwepap835, lccwepap882 etc are actual links that you can click which will take you to the associated R drive folder.) Follow the same steps to deploy a patch on the Existing CR tab, only difference is that there are only 3 required fields (file ID, hours, and patch reason).

ALL FIELDS ARE REQUIRED. If you leave a field blank you will be notified. Just click OK, and make sure all fields are entered before continuing.

Note: There is a chance that when the chrome browser automatically opens and tries to deploy to FIST that it could get stuck loading, if this happens you can close the chrome browser that was opened and click the “Retry FIST Deployment” button. This is located on the New CR and Existing CR tabs. If you were working on a new CR, click the button on the New CR tab and if you were working on an existing CR, click the button on the Existing CR tab.

Migrating a file to production:

When a ticket is in status of “Ready for Deployment/Migration” go to the “Migration tab and simply enter the corresponding CR Number, and hit the “Migrate to Production” button. This will automatically deploy to FIST in a new chrome browser (do not close this window, you can minimize if you like).

Creating a new package:

To create a new package, click on the “New Package” tab. You will then be instructed to go to WebMethods and create your package and subfolder (both package and subfolder should be the same name.

Then enter your package name in the textfield and hit the Next button (shown by the red arrow).

When you click this button an email will automatically be sent out to hvfilesdevelopment@hewitt.com notifying everyone that you are creating this package, the program will also verify that you indeed create the package and subfolder in WebMethods. If you didn’t create them it will notify you (you can’t go on to the next step until you do this). The program will also open up a chrome browser and automatically enter fist config package details.

You will then be looking at the following screen:

The program instructs you to ask your CTC to add production details before continuing. Once you have done so you can hit the Next button (shown by the red arrow). When you hit this button the program will run the service: RpAdminServices.PatchAndPackageServices:convertNewPackageToCurrentVersion_RYou will see a popup indicating that the service ran successfully, hit “Ok”. You will then see the next screen:

The program will show instructions on how to commit the package to SVN. Follow all of these steps before continuing.

Below the instructions is a checkbox selection asking how many packages you have deployed that day (shown in the orange box). By default it is 0. If you have already made a package that day select “1”, this will make the program append a “1” at the end of your auto-generated CR number. Likewise selecting “2” will append a “2” at the end of your auto-generated CR number. These checkboxes will allow one person to deploy up to 3 new packages on the same day.

Once you have made your checkbox selection click the next button(shown by the red arrow). When you do this a chrome browser will open up and go to the SVN to confirm that you did indeed commit this package to the SVN. If you didn’t you will see a warning telling you so, just follow steps ( a-g ), shown on the screen before hitting the next button. If the program confirms you have successfully added the package to the SVN, it will go to the localhost webpage to create release. It will then take the zip file generated from this process and run a batch file to send it to the patchExchange on the R drive, the program screen will then change to reveal progress bars which monitor the zip file on the R drive. The screen will look like this :

Once all the progress bars on the left side get to 100%, the program will automatically open a chrome browser and deploy the patch to FIST, once it has finished, the 3 progress bars on the right will all be 100% and your new package process will be complete.

Triage Tabs:

When you are part of the test/production triage team, part of your duties will be to look into file failures, long running extractions etc. We have 2 tabs on the DevHelper to assist in the triage process.

See images below:

Schedule:

The person on duty will be shown at the top of the screen (turquoise arrow)To alter the schedule displayed by the program click the schedule botton (yellow arrow)

Once you click the schedule botton you will see the following screen shown below. To alter the schedule (example: Marty wants to swap his 8/24 morning shift with Ian’s 8/26 afternoon shift) click on the corresponding cells, change the name the name where necessary and press the enter key when you are finished editing the cell. Then press the submit button (orange arrow). After a few seconds you should see a popup success message as shown below:

Click Ok. After you have finished editing the schedule, click the “Close” button (next to the “Submit” button, this will take you back to the triage tab.

Understanding and marking error status:

At the left side of the screen you will see a list of errors. The errors are listed in the format: File ID | Time of failure | date of failure (shown in red). Note: If you right click one of the files (in red section) you have similar right click functions as the files tab shown earlier:

The list at the left is color coded based on the current status of an error. White is incomplete, yellow is in progress, and green is completed. All of this information is populated by users of the program, so it is important for you to mark things as in progress or completed as applicable. To do this, simply select the error you want to mark and hit the correct button under the “Triage Status” area. You can also mark multiple items from the list by holding control or shift while clicking on items and then hitting one of the status buttons.

Viewing Errors for current and past days:

When you first start up the program it will only be displaying a list of errors from today. In order to view

past days select a number of days from the “View Past Days” drop down and hit go (shown in brown). This is necessary if you are first person on triage duty for the day so you can view failures from the previous night. When you want to refresh your list to see if there are any new errors or changes in error status, hit the “Go!” (shown in brown).

When you click on an error in the list to the left, you will see the right side of the window populate with information about that error. The section at the top shows information about the file (shown in orange). The section in the middle shows information about the expectation associated with the error (shown in blue). The box at the bottom of the window labeled error information is typically being populated from the server error logs (shown in purple). It often holds useful information about the nature of the failure. Additionally if the “Server Name” field has been populated correctly, you can select to view the server, server log, or error log for the listed server(bottom of the orange section).

If any expectations are found for an error then the “Pick Expectation” drop down box will be filled with expectations.(blue section) They are listed in reverse chronological order, with the most recent expectation be labeled 1, and any others after that populating below it. Any expectations that are an error should have a status of Failed in Customization . This is useful at a glance, because you can tell if something failed, but then later ran successfully. So if expectation 1 is not an error, but expectation 2 is an error then this would be the case. Clicking on an expectation will show you some information about it, such as the expectation ID. You can also click the “Open Expectations Page” button to view the expectations for that error in Fist config.

Replynig to an error:

In order to reply to an error in fist you must select the correct expectation that you want to reply to from the “Pick Expectation” drop down box. If an expectation is not marked as an error it won’t let you reply to it. After the correct expectation is selected you can reply in two ways. At the right side of the window are the options for replying. The “Reply Looking into it…” button (shown in magenta) does just that. It will send out a response to that expectation that you are looking into the error. Hitting that button will also mark that error as in progress, changing the color to yellow in the list.

After you have figured out the issue, you can type your final response in the box at the right side of the window. After you have typed your response, hit “Send Reply” (shown in pink) and a chrome window will open and send your response off in fist. The program will ask if you want to mark the error as completed, turning it green in the list, after the response is sent. You may also click the drop down, “Add a pre-filled response” and select one of the items from that list to fill in the reply box. It is filled with some common responses that come up in triage duty. Note that this won’t actually send that response, giving you a chance to tailor it to your particular error if necessary.

When you reply to an error, your response to that issue will be saved and displayed in the “Previously Submitted Resolution” box at the bottom right side of the window. So if you know of an error that was similar to one you are looking at now, you can go back and see what the response to that error was.

Creating Schemas:

In the DevHelper there is a Schema Creator tab which can be used to create schemas.(NOTE: Before using this tab ensure that you have already entered service details for your file)Start by opening up the mapping doc for your file. Then highlight the field names for the type of record you are creating (detail/header/trailer). If the file is delimited (you would know this from the spec doc) then the field names are the only thing you have to highlight and you can hit “Ctrl + C” to copy. If the file is fixed-width then you also need to highlight the lengths of the fields, then hit “Ctrl + C” to copy.Selecting field names and lengths (necessary for fixed-width files but not delimited files):

Copy contents into the text area (shown in red) and select the appropriated options for File ID(shown in purple), delimiter type(shown in orange), record type (shown in green) and delimiter (only necessary for delimited files) for this example:

(File ID = 64484, delimiter type = fixed width, and record type = detail) see image below:

Click the create button (gray arrow) after a few seconds you should see a success message pop up:

Now if you go into WebMethods and right click the client package you are working on and select refresh you should see the schema that you just created.

Easy Alias Tab:

To use this program, select the checkboxes next to the aliases that you want to create or modify. The clear all button (blue arrow) will clear current alias selections, the select all button (purple arrow) will select all of the check boxes. Then you click the Modify/Create Aliases button (red arrow). A chrome window will launch, log in to localhost, and begin changing your aliases. Before you change any of your aliases it is good to try the quick login to LocalHost at the bottom of the screen to verify that your login is working.

The do JDBC Aliases checkbox (green arrow) will make the program attempt to create your JDBC aliases as well as the regular aliases. It will also ask if you want to enable any of the JDBC aliases that are created or modified. The username and password of the aliases will have to match the login for that environment in order for that alias to be enabled. If any of the JDBC aliases were unable to be enabled the program will ask if you want to view that alias page so you can see what the problem is.

While the program is running, the log at the bottom will write out which aliases are being created or modified. The progress bar will also fill to 100% when the program is complete.

The program automatically creates an alias if it doesn’t exist, and modifies the existing one if it does exist. Changing your Gray aliases will also change the five INTEGRATION aliases and QC_FileConfig.

So a new employee would have to have their local integration server set up, have chrome installed, and have an account for SQL server. Then they would just enter their desired alias password, and click the select all button to select all of the check boxes and then the Modify/Create button. The program will launch and create the aliases for all of the environments automatically. They will still have to log into each environment in MS SQL server to change their password to whatever they set their alias passwords to.

Time Keeping:

The Devhelper has a Time Keeping tab, this tab keeps track of patches you deploy and the hours for the associated clients. You can review on this tab and even add operational hours by clicking the “Add Row” button (red arrow). Once you are finished editing your hours , you can click the “Send To Timesheet” button (purple arrow), this will open a chrome browser and go to the timesheet web application and enter the corresponding hours. It will stop short of actually submitting the timesheet so you have time to review/edit. See image below:

Settings:

There are several settings which can be altered in the DevHelper, this can be done through the Settings tab.

You can select how you want the message of the day displayed in the top section (shown in red). You can choose to have it scroll across the bottom of the program (shown in magenta), as a popup on program load, or both.

You can also select which tabs you want displayed or hidden(shown in orange) (ex : easy alias is only used once, and most people will only use either test OR prod triage tabs but not both). Click the button next to the label to change the value from “Hide” to “Show” or vice versa. Once you have finished making all your adjustments click the “Save Settings” button (blue arrow), there will be a pop up saying that the settings were saved. To make the settings effective close and re-open DevHelper.

There are times when you will need to change your credentials (LAN and Sharepoint passwords expire) so you will have to update your credentials. To do this click the “Change Credentials Button” this will take you to the credentials screen which you saw when you opened DevHelper for the first time. Change the associated passwords and hit submit.

Occasionally you may notice something not working with the program ( bug ) , or maybe you see an opportunity for an improvement (enhancement), to report this you can go to the settings tab and click the “Open Dev2 Maestro” (green arrow) which will open the maestro associated with this program. Just add your note in the comment section and hit save and notify assignee.