Internal Errigal Collaboration Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Operations Update Form =====

The Operations Update is one of the most important forms for ScottyPro. It controls most outward communication with the customer via ScottyPro.

As well as, that when the user saves the forms the On-Save groovlet will run and this will preform a number of actions, such as updating the Latest Update field and Emailing the customer.


==== Latest Update ====

The Latest Update field is subject to change. If you are unsure about anything here, please ask the Operations team.

The way the Operations Update will update the latest update field is in two ways. 

== Two Space Update ==
The first way is the explicit method. This is done with two delimiters that are to denote the start and end of an update. The current delimiter is a whitespace. However, we can add more. 

Lets go over some examples. All you have to go is start the update with two spaces and end it with two spaces. Anything in between is used for the update. **The two spaces will be removed from the final Operations Update**, however, the update itself will still exists in the Operations Update. 

Please note for these examples, I'm using ~~ to indicate two spaces.

1. Operations Update
<code>
Hi Dave, 

~~This is my update. This is more of my updates.~~

I ended the last sentence with two spaces. So this section won't be in it

Kind regards,
Ops
</code>

1. Latest Update 
<code>
This is my update. This is more of my updates.
</code>

2. Operations Update
<code>
We are working on a fix that will involve a few tickets from the dev team.~~When we hear from the dev team we will have a better explanation of the cause. Until then we are going to mitigate the problem for now with a workaround. More details to follow.~~
</code>

2. Latest Update 
<code>
When we hear from the dev team we will have a better explanation of the cause. Until then we are going to mitigate the problem for now with a workaround. More details to follow.
</code>

3. Operations Update
<code>
We are ready on our side for the install.
~~Are we still okay for the install on Tuesday at 04:00 PDT? If it doesn't suit we can postpone until next week. 
If we don't hear anything back we will postpone just in case.~~ 
Kind regards
</code>

3. Latest Update 
<code>
Are we still okay for the install on Tuesday at 04:00 PDT? If it doesn't suit we can postpone until next week. 
If we don't hear anything back we will postpone just in case.
</code>

== Executive Summary ==
The next way is the executive summary. This is done by finding the first paragraph in the update, extracting is and setting it as the operations update. This would be in the format of writing the update as if it were an email or letter and you wanted to put a summary or 'abstract' at the time for the first thing to be read. The following sentences with be more detailed and provide a further explanation or clarification on the summary. 

How it works. 
It expects a greeting at the top, ending with a comma and a newline character. Such as "Hi Mary," 
Then it will look for the first sentence below this and continue the search until it is greeted with a grammatically correct sentence ending character with a newline character. 
To the script, this is the end of the paragraph. It will take then first paragraph, neaten it up a bit and then place it as the Latest Update.


1. Operations Update
<code>
Hi Someone, 

This is my update. This is more of my updates.

Since there is a new line and the sentence ends with any normal character for ending a sentence such as . ? ! ] } ), then it will work. 

Kind regards,
The team
</code>

1. Latest Update 
<code>
This is my update. This is more of my updates.
</code>


2. Operations Update
<code>
We are working on a fix that will involve a few tickets from the dev team. 
When we hear from the dev team we will have a better explanation of the cause.
Until then we are going to mitigate the problem for now with a workaround.
More details to follow. 
</code>


2. Latest Update 
None because there isn't a
<code>
</code>

3. Operations Update
<code>
Hi Person, 

We are ready on our side for the install.

Are we still okay for the install on Tuesday at 04:00 PDT? If it doesn't suit we can postpone until next week.

If we don't hear anything back we will postpone just in case. 

Kind regards,
Me
</code>

3. Latest Update 
<code>
We are ready on our side for the install.
</code>


== The No Grammar Method ==
In the original planning there was a final fallback that was if the person who wrote the Operations Update didn't use correct grammer or there wasn't a way to figure what was a paragraph, then the entire Operations Update would go in under the Latest Update. This was later removed. We still have a fallback but it isn't doing anything.

==== Sending the emails ====

When the emails are send there is a slight delay added so that there isn't a database transaction problem with the groovlets running at the same time and blocking one another from saving to the database. This is a side effect of parallelising the scripts, and this is the best way around it. 

To do this, we put the email update in a persistent task which will then send out the email after about 15 seconds. The email is controlled bu a template and doesn't contain any of the update information. It only has a link to the support Request App for the customer and the operations team. The update will be in the Support Request App / SRA.
Sidebar

Internal Errigal Collaboration Wiki

User Tools

Site Tools

Page Tools
