Difference between revisions of "Archiving Records"

From SmartWiki
Jump to: navigation, search
(See Also)
 
(50 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Level 1 records can be archived so they no longer appear in the Level 1 list view.
+
==Overview==
 +
This article outlines the procedures for archiving and unarchiving records within the SmartSimple Cloud system. It covers how to manage records' visibility by toggling their archived status, thereby improving system performance and ensuring data is easily retrievable when needed. Key features include filtering records based on their archival status, detailed steps for using the Batch Update feature for both archiving and unarchiving, and the use of the '''@archived@''' system variable for conditional visibility and editing of records.
  
This is done via [[Batch Update]].  
+
Additionally, the article describes an alternative method for unarchiving records individually through custom JavaScript, offering a solution for a custom control.
:[[Image:ArchiveL1.png]]
 
  
[[Batch Update]] can be used both to Archive records, and remove records from the Archive.
+
==Configuration - Essentials==
 +
'''Important''': You can only access record archiving functionality from UTA L1 record level. When archiving L1 records all associated L2 and L3 activities will be automatically archived.
  
 +
===Archiving Records===
 +
1. In order to archive records, navigate to UTA Level 1 list view with those records.
  
Reports can also be filtered based on whether or not the object has been archived.
+
2. Use the Search / Filter option to return the list of records that are to be archived.
:[[Image:RBArch.png]]
 
:The above image of the Report Builder shows how to filter for only records that have been Archived.
 
:To filter for records that are not archived use a criteria of ''='Not Archived' ''in the report builder.  
 
  
 +
3. Once the search is complete, select desired records to archive using the toggle next to each record or use select all if you wish to archive all records visible in the list view.
  
==Referencing the field==
+
: [[Image:archive1.png|800px]]
You can use the @archived@ variable to reference the archive status of a UTA L1 object, where 1 =  Archived and 0 = Not-Archived.
+
4. Click on the '''Batch Update''' icon.
  
This can be used within conditional statements such as visibility and edit conditions to display/hide fields based on the object's archive status.
+
5. Select '''Archiving''', then from the '''Update Archiving''' select '''Archived''' option.
  
 +
6. To complete the process, press '''Update Applications''' at the bottom of the Batch Update window.
  
==Unarchiving records without using Batch Update==
+
: [[Image:archive2.png|800px]]
An alternative method for unarchiving involves using [[Pandora]] in a custom javascript button. The sample code below is to be used within a [[Custom Field Type: Read Only – System Variables]] field.  
+
7. Click '''Update Applications''' in the pop-up window to confirm your decision.
 +
 
 +
: [[Image:archive3.png]]
 +
8. Selected records are now archived.
 +
 
 +
===Unarchiving Records===
 +
1. In order to unarchive records, navigate to UTA Level 1 list view with those records.<br />2. Use the '''Advanced Search''' to return the list of records that are to be unarchived.
 +
 
 +
'''[[Image:archive4.png|800px]]'''
 +
 
 +
3. In the list of '''Standard Fields''', select '''Archived Applications'''.<br />4. Press '''Search'''.<br />5. A list with all archived records will be displayed in a list view.<br />6. Select desired records to unarchive using the toggle next to each record or use select all if you wish to archive all records visible in the list view.
 +
 
 +
'''[[Image:archive5.png|800px]]'''
 +
 
 +
7. Click on the '''Batch Update''' icon.<br />8. Select '''Archiving''', then from the '''Update Archiving''' select '''Not Archived''' option.<br />9. To complete the process, press '''Update Applications''' at the bottom of the Batch Update window.
 +
 
 +
'''[[Image:archive2.png|800px]]'''
 +
 
 +
10. Click '''Update Applications''' in the popup window to confirm your decision.
 +
 
 +
'''[[Image:archive3.png]]'''
 +
 
 +
11. Select L1 records are now unarchived. They will be listed with all other records in a list view.
 +
 
 +
===Search for Archived Records===
 +
1. In order to find archived records, navigate to UTA Level 1 list view with those records.
 +
 
 +
2. Archived records can be found only by using '''Advanced Search''' (icon located to the right of the filter dropdown).
 +
 
 +
'''[[Image:archive6.png|800px]]'''
 +
 
 +
3. In the advanced search criteria dropdown boxes, select '''Application/ Common Fields''' then in the list of fields select '''Standard Fields / Archived Applications'''.
 +
 
 +
4. Click the '''Search''' button.
 +
 
 +
5. A list of archived records will be returned in the list view.
 +
 
 +
===Variable Processor===
 +
You can use the '''@archived@''' variable to reference the archive status of a UTA L1 record, where 1 = Archived and 0 = Not-Archived.<br />
 +
This can be used within conditional statements such as visibility and edit conditions to display/hide fields based on the record's archive status.
 +
 
 +
==Configuration - Advanced==
 +
===Unarchiving records using Pandora===
 +
An alternative method for unarchiving involves using [[Pandora]] in a custom JavaScript button. The sample code below is to be used within a [[Custom Field Type: Read Only – System Variables]] field.
  
 
This method is best used in combination with a report built to list all archived records, with a hyperlink for each record.
 
This method is best used in combination with a report built to list all archived records, with a hyperlink for each record.
  
 
The process for the user will be:
 
The process for the user will be:
#The report is run where a record can be filtered according to search criteria.
 
#The user will click on a hyperlink into the record where the "Unarchive" button will be exposed.
 
#Upon clicking the button, the record will be unarchived where it will now re-appear when searched within the UTA.
 
  
 +
# The report is run where a record can be filtered according to search criteria.
 +
# The user will click on a hyperlink into the record where the "Unarchive" button will be exposed.
 +
# Upon clicking the button, the record will be unarchived where it will now re-appear when searched within the UTA.
  
<pre>
 
//Displays a button where when clicked will call the "unarchive()" function
 
  
<input type=Button class=Button value="Unarchive Record" onClick="unarchive();">
+
<pre>//Displays a button where when clicked will call the "unarchive()" function
  
<script type="text/javascript">
+
<input class="Button" type="Button" value="Unarchive Record" />
 +
<script type="text/javascript">// <![CDATA[
 
function unarchive(){
 
function unarchive(){
 
updatefields('archived',0);  //Sets Archived flag to 0
 
updatefields('archived',0);  //Sets Archived flag to 0
Line 52: Line 96:
 
var rs=levelone_update(false ,'',gbappid,rset);
 
var rs=levelone_update(false ,'',gbappid,rset);
 
}
 
}
</script>
+
// ]]></script>
 
</pre>
 
</pre>
 
==See Also==
 
==See Also==
 
* [[Batch Update]]
 
* [[Batch Update]]
* [[Searching for Archived Records]]
+
* [[Variable Processor]]
  
 
[[Category:Universal Tracking Application]]
 
[[Category:Universal Tracking Application]]

Latest revision as of 08:23, 5 April 2024

Overview

This article outlines the procedures for archiving and unarchiving records within the SmartSimple Cloud system. It covers how to manage records' visibility by toggling their archived status, thereby improving system performance and ensuring data is easily retrievable when needed. Key features include filtering records based on their archival status, detailed steps for using the Batch Update feature for both archiving and unarchiving, and the use of the @archived@ system variable for conditional visibility and editing of records.

Additionally, the article describes an alternative method for unarchiving records individually through custom JavaScript, offering a solution for a custom control.

Configuration - Essentials

Important: You can only access record archiving functionality from UTA L1 record level. When archiving L1 records all associated L2 and L3 activities will be automatically archived.

Archiving Records

1. In order to archive records, navigate to UTA Level 1 list view with those records.

2. Use the Search / Filter option to return the list of records that are to be archived.

3. Once the search is complete, select desired records to archive using the toggle next to each record or use select all if you wish to archive all records visible in the list view.

Archive1.png

4. Click on the Batch Update icon.

5. Select Archiving, then from the Update Archiving select Archived option.

6. To complete the process, press Update Applications at the bottom of the Batch Update window.

Archive2.png

7. Click Update Applications in the pop-up window to confirm your decision.

Archive3.png

8. Selected records are now archived.

Unarchiving Records

1. In order to unarchive records, navigate to UTA Level 1 list view with those records.
2. Use the Advanced Search to return the list of records that are to be unarchived.

Archive4.png

3. In the list of Standard Fields, select Archived Applications.
4. Press Search.
5. A list with all archived records will be displayed in a list view.
6. Select desired records to unarchive using the toggle next to each record or use select all if you wish to archive all records visible in the list view.

Archive5.png

7. Click on the Batch Update icon.
8. Select Archiving, then from the Update Archiving select Not Archived option.
9. To complete the process, press Update Applications at the bottom of the Batch Update window.

Archive2.png

10. Click Update Applications in the popup window to confirm your decision.

Archive3.png

11. Select L1 records are now unarchived. They will be listed with all other records in a list view.

Search for Archived Records

1. In order to find archived records, navigate to UTA Level 1 list view with those records.

2. Archived records can be found only by using Advanced Search (icon located to the right of the filter dropdown).

Archive6.png

3. In the advanced search criteria dropdown boxes, select Application/ Common Fields then in the list of fields select Standard Fields / Archived Applications.

4. Click the Search button.

5. A list of archived records will be returned in the list view.

Variable Processor

You can use the @archived@ variable to reference the archive status of a UTA L1 record, where 1 = Archived and 0 = Not-Archived.
This can be used within conditional statements such as visibility and edit conditions to display/hide fields based on the record's archive status.

Configuration - Advanced

Unarchiving records using Pandora

An alternative method for unarchiving involves using Pandora in a custom JavaScript button. The sample code below is to be used within a Custom Field Type: Read Only – System Variables field.

This method is best used in combination with a report built to list all archived records, with a hyperlink for each record.

The process for the user will be:

  1. The report is run where a record can be filtered according to search criteria.
  2. The user will click on a hyperlink into the record where the "Unarchive" button will be exposed.
  3. Upon clicking the button, the record will be unarchived where it will now re-appear when searched within the UTA.


//Displays a button where when clicked will call the "unarchive()" function

<input class="Button" type="Button" value="Unarchive Record" />
<script type="text/javascript">// <![CDATA[
function unarchive(){
	updatefields('archived',0);  //Sets Archived flag to 0
}

function updatefields(fieldname,fielddata){
	ss_developer_key="xxxxx";   //Enter Developer Key
	var gbappid=xxxxx;   //Enter application ID
	
	var addfields="opportunityid,"+fieldname;
	var rset=new ssRecordSet(null);
	rset.addfieldnames(addfields);
	var idx=rset.getnewrecnumber();
	rset.addfieldvaluebyname(idx,'opportunityid','@opportunityid@');
	rset.addfieldvaluebyname(idx,fieldname,fielddata);
	var rs=levelone_update(false ,'',gbappid,rset);
}
// ]]></script>

See Also