relativitydev / relativity-trace-documentation Goto Github PK

to warm up but then it will be fast for other documents

I'm looking at our documentation for Terms, and again, it is sorely lacking. Nowhere do we direct Trace clients to dtSearch pages, the search syntax that Trace Terms is based on. And again, we don't detail the field that is populated for when a Term hits. Or the fact that when you create a Term, it's automatically run. Or the fact that when there's 1 term with bad syntax, that brings the whole Terms Searching task to a halt.

• Update all diagrams
• Update steps
  https://relativitydev.github.io/relativity-trace-documentation/trace_connectors_user_guide#installation-steps

https://relativitydev.github.io/relativity-trace-documentation/docs/administrator_guide/enrichment/data_transforms.html#ai-extracted-text-cleansing-data-transformation

This needs to be fixed ASAP as I have to send the documentation out to various clients since we are turning on this feature for them.

I know this section has been changed multiple times. However, Doug Madsen clearly described this in the page below. So, maybe we should use it?

https://einstein.kcura.com/display/VE/Microsoft+Exchange+Archive+via+EWS

We need to go through documentation and update the following:

• Broken Image links
• Images that aren't in the Aero design (aka old images)
• Images that are not of high enough quality
• Broken Links (and ones that don't go to R1 documentation as some go to old documentation)

ref: https://relativitydev.github.io/relativity-trace-documentation/proactive_ingestion_api_documentation

ref:

This field is automatically provided by Relativity on import. DO NOT MAP this field in integration point profile. This field will be removed from Trace Document Extraction Field in the future release of Trace

Trace Shipper System Requirements mixed a few things:

1. Trace Shipper requirements.
2. Merge1 requirements.

For instance Trace Shipper doesn't require:

1. SQL DB.
2. .Net Framework 3.5.
3. Microsoft Visual C++ 2017 Redistributable.

Please review - pre-requisites -> deployment option A in Word doc:
https://kcura.sharepoint.com/:w:/r/sites/TraceTeam/_layouts/15/Doc.aspx?sourcedoc=%7B0EC71A4F-0D55-4708-9FB1-CB88655A1D81%7D&file=Relativity%20Trace%20Data%20Sources%20Guide.docx&wdLOR=cDD31A502-9A7A-5B4F-8E9A-A3F5E361B166&nav=eyJjIjo2MTA4MzA4NzN9&action=default&mobileredirect=true&cid=2036bfa1-daba-4034-9031-e333b58b3d0a

Also, regarding disk - per doc it is 300GB - this is a way too small. We drop folders are on the same disk than we require at least 1 TB.

Missing the omit from alert rules status.

This will avoid issues when computer restarts.

Same should be applied to Trace Shipper

and what are the ramifications of this action: e.g. Data Batches in progress might get "Thread aborted Error" and might need to be restarted

We should add a note that before installing Trace Shipper, the user MUST do the following connectivity test:

1. Install ROSE on the Shipper VM.
2. Login to RelativityOne with the same user/password which will be then used by Trace Shipper to authenticate.
3. Navigate to Workspace default Fileshare (there might be multiple Fileshares on the instance).
4. Navigate to Files -> EDDS folder.
5. Create a temp folder there.
6. Upload sample file.
7. Download the file.

Potential issues:

1. ROSE cannot connect - probably IP whitelisting / TCP ports issue.
2. ROSE cannot authenticate - user doesn't have enough permission to authenticate.
3. Transfer failed - probably UDP ports issue.

After word doc with Data Source information is merged

We use authorization in this documentation, but then on the data source we call it Credentials. Feels like we could have more consistency here as well as have the data source documentation page where credentials is mention better link to the authorization documentatino page.

Ingestion Profiles - Integration Points - Documentation (relativitydev.github.io)
· When setting up an Ingestion Profile for the O365 email data being read in, the documentation has a link to what appears to be a Relativity v9 app “Create & Map Field Catalog – Full” – we don’t have this in our app library. Is there a current version of this app we are supposed to use for RelOne? For testing purposes, I’ve just manually set up a mapping for DocID
· There is nothing in the documentation for actually setting up Integration Points, so I haven’t done this.
· Although the documentation is also missing Appendix A and B, and just has Appendix C – am I missing anything I need here?
· I noticed I have duplicate values for a lot of items for some reason – eg, Data Mapping has two entries for most values.

This data sources delivered by Trace should no longer be used.

We run this SOP a few times. I think it would be useful to put in in the official doc. See "Upgrade Trace Shipper" for more details
https://einstein.kcura.com/display/RTP/SOP+for+most+common+FoT+incidents

We should have documented special considerations related to Cold Start scenario.

1. How to tweak Collect Data Source parameters?
2. How to avoid throttling issues?
3. How to monitor the system and adjust?
4. How to use "merge data batches during cold start" parameter?
5. How to configure Trace -> Setup -> Data Retrieval -> Run Interval - to not produce too many Data Batches on start and to not kill the 10 collection jobs in parallel queue.

Example:

1. Stop Teams connector.
2. Configure Trace -> Setup -> Data Retrieval -> Run Interval to 1 hour - so, only 1 Data Batch (each type) will be created per 1 hour.
3. Abandon all Data Batches which were previously run (for instance with incorrect setup) - that would cancel all underlying Collect jobs.
4. Reconfigure Data Source.
5. Set Start Date to XYX.
6. Set Frequency in Minutes to 1440.
7. Set Merge Batches During Cold Start to Yes.
8. Set Max Number of Batches To Merge to 30 <<< this means we'll create Data Batches each 30 day long.
9. Reset Data Source.
10. Enable Data Source.

It appears that RIP currently has only one type of Agent ("Integration Points Agent"). The "Integration Points Manager" Agent is no longer available in the RIP rap. Please remove all references to the "Integration Points Manager" Agent in documentation. This RIP Agent is referenced multiple times in this page in the "Agents" and "Setting up Relativity Trace" sections.
This page is linked in a shareable PDF Trace Ops provides Trace Partners (and potentially savvy Relativity Customers) outlining Trace ARM Restore steps.

Currently, we support 3 Google Data Sources: Google Mail, Google Chat and Google Drive. However, per our Data Source documentation - we divided Goggle connectors into 3 parts: Google Suite, Google Chat and Google Drive which is inconsistent. We should either leave one connector - Google Suite or we should have 3: Mail, Chat and Drive.

https://relativitydev.github.io/relativity-trace-documentation/docs/administrator_guide/enrichment/data_transforms.html#ai-extracted-text-cleansing-data-transformation

https://relativitydev.github.io/relativity-trace-documentation/docs/user_guide/review/reviewing_communications.html

This functionality is no longer supported even though it has not yet been removed from the product. Please mark it as deprecated so users understand it's not something necessary for them to use.

Similar to how it is done for Staging Explorer https://help.relativity.com/RelativityOne/Content/Relativity/RelativityOne_Staging_Explorer/RelativityOne_Staging_Explorer.htm#Staging

Update Appendix B: Trace Document Extraction Fields based on Trace_Metadata- a more updated metadata dictionary that we send to clients during pre-sales conversations.

I think only ApplicationImpersonation is needed and NOT ImportExport OR LegalHold

Update required agents for Trace section

Remove the following:
Application Installation Manager
Auto Batch Manager

Page:
https://relativitydev.github.io/relativity-trace-documentation/docs/administrator_guide/setup/getting_started.html

On the Creating a Policy page (https://relativitydev.github.io/relativity-trace-documentation/docs/user_guide/alerting/creating_a_policy.html), the images are missing. This applies to section 1-Creating a Policy, 2-Customizing and Running a Rule, and 3-Validating Results. See attached image for example.

Alert Rules is one page that needs this.

Need to update the PUT statement body to include Load File Path field like this:

{
"Status": {
"Guids": [
"32452D3D-35D2-4FF5-92E6-1DD01D755482"
],
"Artifact Type Name": "Choice"
},
"Load File Path": "DataTransfer\Import\Trace BIST Provider\1041141\1041337_ready\loadfile.dedup.updates.dat",
"DocumentCount_LoadFileGenerated": "500",
"Timestamp_LoadFileGenerated": "3/27/2018 4:15:13 PM",
"Parent Artifact": {
"Artifact ID": 1003663
},
"Artifact Type Name": "Data Batch",
"Artifact ID": 1044380
}

This is not the cleanest documentation. Should fix image and clean up.