Difference between revisions of "Assignment Grid"

From SmartWiki
Jump to: navigation, search
(Created page with "=Overview= The Assignment Grid feature provides a more efficient means of adding Users to UTA records when there is a Consumer/Provider relationship. It allows restrict...")
 
 
(23 intermediate revisions by the same user not shown)
Line 6: Line 6:
  
 
It allows restrictions on the roles of the users to be added and the roles that they can be added with.
 
It allows restrictions on the roles of the users to be added and the roles that they can be added with.
 +
 +
It also provides control over how the users can accept or decline the assignments, including buttons used and level two records created.
 +
 +
It also allows up to 3 reminder emails to be sent, and the user to be automatically flipped to a defined role against the Consumer record.
 +
  
 
=Configuration - Essentials=
 
=Configuration - Essentials=
  
 
==Configure Assignment Grid Settings==
 
==Configure Assignment Grid Settings==
 +
 +
[[Image:AssignmentGridSettings.png|1100px|border]]
 +
 +
The Assignment Grid Settings allows restrictions on the type and status of Consumer records that will be listed.
 +
 +
It allows restrictions on the roles of the users to be added and the roles that they can be added with.
  
 
The Assignment Grid Settings are only available to those UTAs configured as [[Configuring_UTA_Provider/Receiver_(Consumer)_Relationships#Enable_Provider_UTA|Providers]].  
 
The Assignment Grid Settings are only available to those UTAs configured as [[Configuring_UTA_Provider/Receiver_(Consumer)_Relationships#Enable_Provider_UTA|Providers]].  
  
−
* Go to UTA Settings - Connectivity.  
+
1. Go to UTA Settings - Connectivity. <br/>
−
* If UTA is configured as a Provider then there will be an '''Assignment Grid Settings''' option.  
+
2. If UTA is configured as a Provider then there will be an '''Assignment Grid Settings''' option. <br/>
−
* Clicking this will take user to the '''Assignment Grid Settings''' list view.  
+
3. Clicking this will take user to the '''Assignment Grid Settings''' list view. <br/>
−
* Click the '''New Assignment Grid''' button at the top of the page.
+
4. Click the '''New Assignment Grid''' button at the top of the page.<br/>
−
* Select the '''Consumer Application''' that the Grid will be configured against and click '''Continue'''.  
+
5. Select the '''Consumer Application''' that the Grid will be configured against and click '''Continue'''.<br/>
−
* The '''Assignment Grid Settings page is displayed with the following options:
+
6. The '''Assignment Grid Settings''' page is displayed with the following options:<br/>
 
:*'''Link Caption''': name that will be displayed when selecting Assignment Grid in Provider record.  
 
:*'''Link Caption''': name that will be displayed when selecting Assignment Grid in Provider record.  
 
:*'''Roles Available to''': roles that will be able to select Assignment Grid option in Provider record.  
 
:*'''Roles Available to''': roles that will be able to select Assignment Grid option in Provider record.  
Line 26: Line 37:
 
:*'''Contact Role Filter''': roles associated with the Provider record contacts section. Used to control which contacts from Provider record can be  assigned to the Consumer record.  
 
:*'''Contact Role Filter''': roles associated with the Provider record contacts section. Used to control which contacts from Provider record can be  assigned to the Consumer record.  
 
:*'''Summary Role''': roles associated with the Consumer record contacts section. Used to control the roles that will be referenced in the Summary section.  
 
:*'''Summary Role''': roles associated with the Consumer record contacts section. Used to control the roles that will be referenced in the Summary section.  
−
:*'''Additional Options - Header Template for Contacts''': define column headers when Contacts are displayed in Assignment Grid
+
:*'''Additional Options - Header Template for Contacts''': define what should appear in the column header for each individual contact displayed in Assignment Grid
−
:*'''Additional Columns''': define any additional column to be be used when Contacts are displayed in Assignment Grid
+
:*'''Additional Columns''': use '''+''' button to add and define any additional columns to be displayed in Assignment Grid section
−
* Click Save at the bottom of the page.  
+
7. Populate as required then click Save at the bottom of the page.  
 +
 
 +
 
  
 
==Configure Assignment Declaration Buttons==
 
==Configure Assignment Declaration Buttons==
 +
 +
[[Image:AssignmentButtonSettings.png|900px|border]]
 +
 +
The Assignment Declaration Buttons section provides control over how the users can accept or decline the assignments, including the buttons used and level two records created.
  
 
The Assignment Declaration Buttons options are only available to those UTAs configured as [[Configuring_UTA_Provider/Receiver_(Consumer)_Relationships#Enable_Provider_UTA|Providers]].  
 
The Assignment Declaration Buttons options are only available to those UTAs configured as [[Configuring_UTA_Provider/Receiver_(Consumer)_Relationships#Enable_Provider_UTA|Providers]].  
  
−
* Go to UTA Settings - Connectivity.  
+
1. Go to UTA Settings - Connectivity. <br/>
−
* If UTA is configured as a Provider then there will be an '''Assignment Declaration Buttons''' option.  
+
2. If UTA is configured as a Provider then there will be an '''Assignment Declaration Buttons''' option.<br/>
−
* Clicking this will take user to the '''Assignment Declaration Buttons''' list view.
+
3. Clicking this will take user to the '''Assignment Declaration Buttons''' list view.<br/>
−
* Click the '''New Declaration Button''' button at the top of the page.
+
4. Click the '''New Declaration Button''' button at the top of the page.<br/>
−
* Select the '''Consumer Application''' that the Grid will be configured against and click '''Continue'''.  
+
5. Select the '''Consumer Application''' that the Grid will be configured against and click '''Continue'''.<br/>
−
* The '''Assignment Declaration Buttons page is displayed with the following options:  
+
6. The '''Assignment Declaration Buttons''' page is displayed with the following options:  
 
:*'''Type''': drop-down listing the Provider record types that the buttons will be available against.  
 
:*'''Type''': drop-down listing the Provider record types that the buttons will be available against.  
−
:*'''Monitored Role''': drop-down listing the roles that the buttons will be used in conjunction with against. Users assigned to Consumer record in the selected role will be presented with the Declaration buttons.
+
:*'''Monitored Role''': drop-down listing the roles that the buttons can be used in conjunction with. Users assigned to Consumer record in the selected role will be presented with the Declaration buttons.
−
:*'''Button Caption''': caption that will appear on the button  
+
:*'''Button Caption''': caption that will appear on the overall button that opens Declaration section.
 
:*'''Header Caption''': header will appear on the Declaration section.  
 
:*'''Header Caption''': header will appear on the Declaration section.  
−
:*'''Template''': QA Rev1 template Committee: @name@ Application Name: @consumer.Name@
+
:*'''Template''': descriptive text that will appear against the Declaration section.  
−
:*'''Comment Field''': select UTA Level 1 Role Custom Field-Global from drop-down
+
:*'''Comment Field''': custom field used to store any comments provided by the Contact
−
:*'''Yes - Button Label''': Accept
+
:*'''Yes - Button Label''': label to appear on button to accept assignment
−
:*'''Yes - Contact Role Change to''': Reviewer Accepted
+
:*'''Yes - Contact Role Change to''': role user is assigned to the Consumer record with after clicking Yes - Button.
−
:*'''Yes - Comment Fields Mandatory''': use toggle to switch on
+
:*'''Yes - Comment Fields Mandatory''': use toggle to switch on / off is user is required to complete Comment field after clicking Yes - Button.
−
:*'''Yes - Create Level 2''': use toggle to switch on
+
:*'''Yes - Create Level 2''': use toggle to switch on if level 2 record should be created after user clicks Yes - Button.
−
:*'''Yes - Level 2 Default Type''': select Provider Type 1 caption from drop-down
+
:*'''Yes - Level 2 Default Type''': select level 2 type if level 2 type should be created after user clicks Yes - Button.
−
:*'''Yes - Level 2 Default Status''': select default
+
:*'''Yes - Level 2 Default Status''': select level 2 status if level 2 type should be created after user clicks Yes - Button.
−
:*'''Yes - Redirect URL''': /s_viewuser.jsp?userid=@me.userid@
+
:*'''Yes - Redirect URL''': enter URL where user should be redirected to after clicking Yes - Button.
−
:*'''No - Button Label''': Declined
+
:*'''No - Button Label''': label to appear on button to decline assignment
−
:*'''No - Contact Role Change to''': select Reviewer Declined from drop-down
+
:*'''No - Contact Role Change to''': role user is assigned to the Consumer record with after clicking No - Button.
 +
7. Populate as required then click Save at the bottom of the page.
 +
8. Once this is complete then you will need to
 +
  
  
−
=Configuration - Advanced=
+
==Expose Assignment Declaration Buttons==
  
−
=Appendix=
+
[[Image:AssignmentButtonSettings2.png|500px|border]]
  
−
==Options and Settings==
+
The Declaration Button needs to be exposed to the Reviewer using [[List Views]].
  
−
<!--Explain all applicable misc options and settings that shouldn't be explained above here...-->
+
If you [[Configuring List Views|configure the list view]] for the Consumer Record after configuring the Declaration buttons for the Consumer UTA then you will see the following additional options . . .
  
−
===General Settings===
+
* Enable Declaration Button: option found under the Properties tab. Toggle on of off as needed
 +
* Declaration Button Application: drop-down listing Provider UTAs found under the Properties tab. Exposed when '''Enable Declaration Button''' is switched on.
 +
* Show Declaration Button: found under the Columns tab when selecting columns.  Will add the Declaration button to the column in the list view. Exposed when '''Enable Declaration Button''' is switched on.
  
−
{| class="wikitable"
 
−
| Option
 
−
| Description
 
−
| Example
 
−
|-
 
−
|
 
−
|
 
−
|
 
−
|}
 
  
−
===Display Settings===
 
  
−
{| class="wikitable"
 
−
| Option
 
−
| Description
 
−
| Example
 
−
|-
 
−
|
 
−
|
 
−
|
 
−
|}
 
  
−
=Examples=
+
==Configure Assignment Reminder Settings==
  
 +
[[Image:AssignmentReminderSettings.png|900px|border]]
  
 +
The Assignment Reminder Settings allows up to 3 reminder emails to be sent, and the user to be automatically flipped to a defined role against the Consumer record.
  
−
<!--
+
The Assignment Reminder Settings options are only available to those UTAs configured as [[Configuring_UTA_Provider/Receiver_(Consumer)_Relationships#Enable_Provider_UTA|Providers]].
  
−
Sample Image Format:
+
1. Go to UTA Settings - Connectivity. <br/>
−
 
+
2. If UTA is configured as a Provider then there will be an '''Assignment Reminder Settings''' option.<br/>
−
[[File:xmlSample.png|thumb|none|middle|500px|Example field configured as a budget sheet.]]
+
3. Clicking this will take user to the '''Assignment Reminder Settings''' list view.<br/>
−
 
+
4. Click the '''New Reminder Settings''' button at the top of the page.<br/>
−
 
+
5. Select the '''Consumer Application''' that the Grid will be configured against and click '''Continue'''.<br/>
−
 
+
6. The '''Assignment Reminder Settings''' page is displayed with the following options: <br/>
−
Sample Table Format:
+
:*'''Type''': drop-down listing the Provider record types that the buttons will be available against.
 +
:*'''Monitored Role''': drop-down listing the roles that the buttons can be used in conjunction with. Users assigned to Consumer record in the selected role will be presented with the Declaration buttons.
 +
:*'''Expired Role''': drop-down listing roles. User will be assigned to Consumer record in the selected role if they have not declared by the Expired date.
 +
:*'''Monitored Status''': statuses associated with the Provider record. Reminders only sent when Provider record has selected status.  
 +
:*'''Reference Date''':
 +
:*'''Expiry Date''': date when user will be flipped to defined role if they have not accepted or declined the assignment request
 +
:*'''Email from Address''': email used for reminder emails.  
 +
:*'''Number of Days before Reminder 1''': number of days prior to the Expiry Date that the first email will be sent
 +
:*'''Reminder 1 Subject''': subject used in the first email
 +
:*'''Reminder 1 Body''': email body for the first email
 +
:*'''Number of Days before Reminder 2''': number of days prior to the Expiry Date that the second email will be sent
 +
:*'''Reminder 2 Subject''': subject used in the second email
 +
:*'''Reminder 2 Body''': email body for the second email
 +
:*'''Number of Days before Reminder 3''': number of days prior to the Expiry Date that the third email will be sent
 +
:*'''Reminder 3 Subject''': subject used in the third email
 +
:*'''Reminder 3 Body''': email body for the third email
 +
7. Populate as required and click Save.
  
−
{| class="wikitable"
+
=Using Assignment Grid feature=
−
| Option
 
−
| Description
 
−
| Example
 
−
|-
 
−
|
 
−
|
 
−
|
 
−
|}
 
  
 +
==Assignment Grid==
  
 +
1. The Assignment Grid is accessed from the Level 1 Provider record in Edit mode by clicking on options.
  
−
Sample Syntax Format:
+
:[[Image:UseAssignmentGrid1.png|500px|border]]
−
Empty space at start of line to highlight the row, italicize any variables that the user would fill in (as opposed to literal words that need to be used in syntax)
 
  
−
@section.''SectionNodeName''@
+
2. The Assignment Grid is comprised of 2 sections.
 +
:* Main Assignment section: lists the Consumer records down along the left hand side and the contacts along the top. The Consumer records listed are those with a Type and Status that corresponds to the Consumer Type / Status Filter configured against the Assignment Grid Settings. The contacts listed are those assigned against Provider record with roles that correspond to the Contact Role Filter configured against the Assignment Grid Settings.
 +
:* Summary section: summary of the number of assignments for those roles configured against the Summary Role section of the Assignment Grid Settings.  
  
 +
:[[Image:UseAssignmentGrid2.png|1000px|border]]
  
 +
3. Select the relevant role in the intersection between the contact and the consumer role. The roles available are those configured against the Consumer Assignment Roles section of the Assignment Grid Settings.
  
−
Sample Code Block:
+
4. Click Save once all assignments are complete. The users will be automatically added to the Consumer records with the selected roles and they should be able to access the Declaration buttons against the configured list view.  
−
When you want to write an example block of code, you should highlight it and also escape any special characters that might be construed as HTML formatting and outputted incorrectly by the Wiki by using a pre (pre-formatted text) tag
 
−
 
 
−
<pre>
 
−
<?xml version="1.0"?>
 
−
<Company>
 
−
<Name>Oranges Inc.</Name>
 
−
<Description>Peel.
 
−
Eat.
 
−
Repeat.</Description>
 
−
</Company>
 
−
<Company>
 
−
<Name>Bananas Ltd.</Name>
 
−
<Description>You're going to go "bananas" over our product!</Description>
 
−
</Company>
 
−
</pre>
 
−
 
 
−
 
−
 
 
−
Unordered list:
 
−
When listing information with bullet points in no order
 
  
−
* Point 1
 
−
* Point 2
 
−
* Point 3
 
  
 +
==Declaration buttons==
  
 +
1. When the assigned individuals access the relevant list view (i.e. the one configured with the Declaration button settings) then they should see the overall Declaration button.
  
−
Ordered list:
+
:[[Image:UseAssignmentButtons1.png|800px|border]]
−
When listing information with numbers to denote ordered steps
 
  
−
# Step 1
+
2. Clicking on this exposes the Declaration screen, with buttons to accept or decline the assignment.
−
# Step 2
 
−
# Step 3
 
  
 +
:[[Image:UseAssignmentButtons2.png|650px|border]]
  
 +
3. When they click on the buttons then there role against the Consumer record will be updated, and a level 2 may be created if appropriate.
  
−
Sample Page Header Banners:
 
−
Deprecated Feature
 
−
{{Deprecated}}
 
−
Deprecated Page
 
−
{{DeprecatedPage}}
 
−
Professional Services
 
−
{{ProfessionalServices}}
 
−
Page Under Construction
 
−
{{UnderConstruction}}
 
  
−
-->
+
[[Category:Universal Tracking Application]][[Category:Applications]][[Category:Contacts]][[Category:Consumer/Provider]]

Latest revision as of 13:26, 20 October 2017

Overview

The Assignment Grid feature provides a more efficient means of adding Users to UTA records when there is a Consumer/Provider relationship.

It allows restrictions on the type and status of Consumer records that will be listed.

It allows restrictions on the roles of the users to be added and the roles that they can be added with.

It also provides control over how the users can accept or decline the assignments, including buttons used and level two records created.

It also allows up to 3 reminder emails to be sent, and the user to be automatically flipped to a defined role against the Consumer record.


Configuration - Essentials

Configure Assignment Grid Settings

AssignmentGridSettings.png

The Assignment Grid Settings allows restrictions on the type and status of Consumer records that will be listed.

It allows restrictions on the roles of the users to be added and the roles that they can be added with.

The Assignment Grid Settings are only available to those UTAs configured as Providers.

1. Go to UTA Settings - Connectivity.
2. If UTA is configured as a Provider then there will be an Assignment Grid Settings option.
3. Clicking this will take user to the Assignment Grid Settings list view.
4. Click the New Assignment Grid button at the top of the page.
5. Select the Consumer Application that the Grid will be configured against and click Continue.
6. The Assignment Grid Settings page is displayed with the following options:

  • Link Caption: name that will be displayed when selecting Assignment Grid in Provider record.
  • Roles Available to: roles that will be able to select Assignment Grid option in Provider record.
  • Consumer Assignment Roles: roles associated with the Consumer record contacts section. Used when assigning users to the Consumer record.
  • Consumer Status Filter: statuses associated with the Consumer record. Used to control which Consumer records will be available when assigning users.
  • Consumer Type Filter: types associated with the Consumer record. Used to control which Consumer records will be available when assigning users.
  • Contact Role Filter: roles associated with the Provider record contacts section. Used to control which contacts from Provider record can be assigned to the Consumer record.
  • Summary Role: roles associated with the Consumer record contacts section. Used to control the roles that will be referenced in the Summary section.
  • Additional Options - Header Template for Contacts: define what should appear in the column header for each individual contact displayed in Assignment Grid
  • Additional Columns: use + button to add and define any additional columns to be displayed in Assignment Grid section

7. Populate as required then click Save at the bottom of the page.


Configure Assignment Declaration Buttons

AssignmentButtonSettings.png

The Assignment Declaration Buttons section provides control over how the users can accept or decline the assignments, including the buttons used and level two records created.

The Assignment Declaration Buttons options are only available to those UTAs configured as Providers.

1. Go to UTA Settings - Connectivity.
2. If UTA is configured as a Provider then there will be an Assignment Declaration Buttons option.
3. Clicking this will take user to the Assignment Declaration Buttons list view.
4. Click the New Declaration Button button at the top of the page.
5. Select the Consumer Application that the Grid will be configured against and click Continue.
6. The Assignment Declaration Buttons page is displayed with the following options:

  • Type: drop-down listing the Provider record types that the buttons will be available against.
  • Monitored Role: drop-down listing the roles that the buttons can be used in conjunction with. Users assigned to Consumer record in the selected role will be presented with the Declaration buttons.
  • Button Caption: caption that will appear on the overall button that opens Declaration section.
  • Header Caption: header will appear on the Declaration section.
  • Template: descriptive text that will appear against the Declaration section.
  • Comment Field: custom field used to store any comments provided by the Contact
  • Yes - Button Label: label to appear on button to accept assignment
  • Yes - Contact Role Change to: role user is assigned to the Consumer record with after clicking Yes - Button.
  • Yes - Comment Fields Mandatory: use toggle to switch on / off is user is required to complete Comment field after clicking Yes - Button.
  • Yes - Create Level 2: use toggle to switch on if level 2 record should be created after user clicks Yes - Button.
  • Yes - Level 2 Default Type: select level 2 type if level 2 type should be created after user clicks Yes - Button.
  • Yes - Level 2 Default Status: select level 2 status if level 2 type should be created after user clicks Yes - Button.
  • Yes - Redirect URL: enter URL where user should be redirected to after clicking Yes - Button.
  • No - Button Label: label to appear on button to decline assignment
  • No - Contact Role Change to: role user is assigned to the Consumer record with after clicking No - Button.

7. Populate as required then click Save at the bottom of the page. 8. Once this is complete then you will need to


Expose Assignment Declaration Buttons

AssignmentButtonSettings2.png

The Declaration Button needs to be exposed to the Reviewer using List Views.

If you configure the list view for the Consumer Record after configuring the Declaration buttons for the Consumer UTA then you will see the following additional options . . .

  • Enable Declaration Button: option found under the Properties tab. Toggle on of off as needed
  • Declaration Button Application: drop-down listing Provider UTAs found under the Properties tab. Exposed when Enable Declaration Button is switched on.
  • Show Declaration Button: found under the Columns tab when selecting columns. Will add the Declaration button to the column in the list view. Exposed when Enable Declaration Button is switched on.



Configure Assignment Reminder Settings

AssignmentReminderSettings.png

The Assignment Reminder Settings allows up to 3 reminder emails to be sent, and the user to be automatically flipped to a defined role against the Consumer record.

The Assignment Reminder Settings options are only available to those UTAs configured as Providers.

1. Go to UTA Settings - Connectivity.
2. If UTA is configured as a Provider then there will be an Assignment Reminder Settings option.
3. Clicking this will take user to the Assignment Reminder Settings list view.
4. Click the New Reminder Settings button at the top of the page.
5. Select the Consumer Application that the Grid will be configured against and click Continue.
6. The Assignment Reminder Settings page is displayed with the following options:

  • Type: drop-down listing the Provider record types that the buttons will be available against.
  • Monitored Role: drop-down listing the roles that the buttons can be used in conjunction with. Users assigned to Consumer record in the selected role will be presented with the Declaration buttons.
  • Expired Role: drop-down listing roles. User will be assigned to Consumer record in the selected role if they have not declared by the Expired date.
  • Monitored Status: statuses associated with the Provider record. Reminders only sent when Provider record has selected status.
  • Reference Date:
  • Expiry Date: date when user will be flipped to defined role if they have not accepted or declined the assignment request
  • Email from Address: email used for reminder emails.
  • Number of Days before Reminder 1: number of days prior to the Expiry Date that the first email will be sent
  • Reminder 1 Subject: subject used in the first email
  • Reminder 1 Body: email body for the first email
  • Number of Days before Reminder 2: number of days prior to the Expiry Date that the second email will be sent
  • Reminder 2 Subject: subject used in the second email
  • Reminder 2 Body: email body for the second email
  • Number of Days before Reminder 3: number of days prior to the Expiry Date that the third email will be sent
  • Reminder 3 Subject: subject used in the third email
  • Reminder 3 Body: email body for the third email

7. Populate as required and click Save.

Using Assignment Grid feature

Assignment Grid

1. The Assignment Grid is accessed from the Level 1 Provider record in Edit mode by clicking on options.

UseAssignmentGrid1.png

2. The Assignment Grid is comprised of 2 sections.

  • Main Assignment section: lists the Consumer records down along the left hand side and the contacts along the top. The Consumer records listed are those with a Type and Status that corresponds to the Consumer Type / Status Filter configured against the Assignment Grid Settings. The contacts listed are those assigned against Provider record with roles that correspond to the Contact Role Filter configured against the Assignment Grid Settings.
  • Summary section: summary of the number of assignments for those roles configured against the Summary Role section of the Assignment Grid Settings.
UseAssignmentGrid2.png

3. Select the relevant role in the intersection between the contact and the consumer role. The roles available are those configured against the Consumer Assignment Roles section of the Assignment Grid Settings.

4. Click Save once all assignments are complete. The users will be automatically added to the Consumer records with the selected roles and they should be able to access the Declaration buttons against the configured list view.


Declaration buttons

1. When the assigned individuals access the relevant list view (i.e. the one configured with the Declaration button settings) then they should see the overall Declaration button.

UseAssignmentButtons1.png

2. Clicking on this exposes the Declaration screen, with buttons to accept or decline the assignment.

UseAssignmentButtons2.png

3. When they click on the buttons then there role against the Consumer record will be updated, and a level 2 may be created if appropriate.

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Assignment_Grid&oldid=31446’