(ATS4-APP03) Top 10 Things Every Accelrys Electronic Notebook Administrator Should Know

Swati Puri McHale

Lead Technical Support Scientist, Customer Support

swati.mchale@accelrys.com

The information on the roadmap and future software development efforts are intended to outline general product direction and should not be relied on in making

a purchasing decision.

Accelrys ELN Administrators Want to Know About…

10. Key Documentation

• Accelrys Vault Server Administrative Tools Guide

• Accelrys Vault Server Administration Guide

• Accelrys Deployment Manager (ADM) for Notebook

Administrators (NEW in 6.7.x)

• Symyx Notebook Administration Guide

Accelrys Vault Server Middle Tier

Accelrys Electronic Lab Notebook (Client)

Experiment Editor

Framework Platform

Reporting Search Materials & Chemistry

Notebook Platform

Pluggable Services

OpenEye

Services

Query

Index

Workflow

Repository

Oracle Database Tier

Authentication and Authorization (STS)

Windows Communication Foundation

RAS Schema

Database Web Service

Registration

Workflow Designer Client

Symyx Administration

Console

Balance Integration

VAULT Schema Direct

9. Accelrys ELN Architecture (High-Level)

8 a. Key Services for Accelrys Vault Server

Symyx Vault Message Processing Service

Symyx Workflow Service

Symyx Vault Server 1.0

Vault Web Services

Vault Message Processing Service: Monitors Vault

message processor application

Workflow enrollment

RAS (Tomcat): Indexing

Public: Handles client

communication

Vault Message Processor manages asynchronous

processing of Vault objects via MSMQ

Transition processing

STS (Tomcat): Authentication

Private: Communicates with Message Processing and

Workflow services

8 b. Accelrys Vault Server Services

Order of STARTING Symyx services:

1. iisreset /start

2. Symyx Vault Server 1.0

3. Symyx Vault Message Processing Service

4. Symyx Workflow Service

Order of STOPPING Symyx services:

1. Symyx Workflow Service

2. Symyx Vault Message Processing Service

3. Symyx Vault Server 1.0

4. iisreset/stop

7. SSL Certificate Tips for AVS Middle Tier

• SSL certificates secure communication between Client and AVS

• Certificate information is present in:

• IIS Manager

• STS and Tomcat keystores

• Symyx.Vault.Service\web.config

• Contact Accelrys Customer Support for help with updating certificate information on AVS

Middle Tier

6. Best Practices for Workflow

In Progress

To Be Witnessed

Witnessed

Return to author

Approve and Sign

Keep In Progress

Complete

Withdraw

Author Actions Witness Actions

Key:

• Ensure that workflow association name ≠ workflow definition

• Specify the complete VaultPath, including repository name (does not start with “\”), when creating a workflow association

• Test the workflow with all expected transitions

5. Permissions

Permissions for Read/Write Data Permissions for Applications

5 a. Permissions for Applications

ALLOW for ALL USERS and GROUPS:

RunAnalysis and RunProtocol = Used for Pipeline Pilot Protocols in Accelrys ELN DisableUndoMyCheckouts = user cannot undo the checkout of their own checked-out document

MaterialInfoManager = Display structure + information for a chemical from ACD/ChemSeek

Permission Description

Check Out Check-out to lock an object for editing

Read Data View an object’s content

Write Data Change an object’s content

Workflow Transition Change an object’s state in workflow (subject to rules in the specific workflow definition)

Read Properties View an object’s properties (title, description): If this permission is not granted, the object is NOT visible to the user in Notebook Explorer in Accelrys ELN Client

Update Properties Update an object’s properties

Read Permissions Read permissions that are set on an object: useful for Administrators

Rollback Revert an object to a previous version

Traverse Folder Enables browsing a repository hierarchy, if the user does not have permission to see the folder

5 b. Vault Data Security Permissions

• At the Repository level, set:

– ReadData, ReadPermissions, ReadProperties

• At the sub-folder level (or folder where check-in

is ALLOWED), set:

– ReadData, ReadPermissions, ReadProperties

– Checkout, UpdateProperties,

WorkflowTransition, WriteData

• Use Workflow to set permissions as the

documents move through approval stages

5 c. Recommendations for Permissions

Examples:

RequeueVaultObjects -repository Site

RequeueVaultObjects -repository “Chemical Development" –status Unknown

Reference: Accelrys Vault Server Administration Guide, Appendix A

4. How do I Index Objects in Accelrys ELN?

Parameter Description Required Default Value

Repository The repository that will be acted upon Yes N/A

MessageLimit Maximum # of messages that will be created No 100,000

Status The message handling state to be queued No Failed

Queues List of queues to populate No All

Use the RequeueVaultObjects Utility from:

C:\Program Files (x86)\Symyx\Symyx Vault 6.7\Symyx.Vault.Utility\RequeueVaultObjects.exe

4 b. Best Practices for Re-Indexing Vault Objects

• Re-queue items so that their state can become known

• Re-queue items for a specific message handler

• Automate RequeueVaultObjects Utility via task scheduler jobs, for example:

– Process all unknown items on Saturday each week

3. Export/Import

Always promote configuration using Transfer capabilities Fast, Accurate, Repeatable results

Development Test Production

Bu

ild • Build configuration

objects • Templates, Section

Templates, Reports

• PSDs, Forms, Vocabularies, Signature Policies

Test

• Final verification confirming correct transfer from Test

Tran

sfer

• Upon completion of Test approvals, transfer Test configuration to Production

Test

• Validation and User Acceptance testing

Test

• Initial testing

Tran

sfer

• Transfer configuration objects to Test

• Iterate changes through Development

• Restart AVS machine(s) every 30 days

• Archive Vault and Tomcat logs every 30 days

• Restart all Symyx services weekly

For more information about this topic, please attend: (ATS4-APP09) Tips and Tricks for Managing Symyx Notebook Server Performance

2. Best Practices for Managing AVS Middle Tier

Automate via Windows scheduled tasks or your network management platform

1. Location of Log Files (for ELN 6.7.x)

• Accelrys Vault Server Logs = C:\VaultLogs\

• STS, RAS Logs = C:\Program Files (x86)\Symyx\Symyx Vault 6.7\SymyxServer\Tomcat6\logs\

• Logs for Client = C:\ProgramData\Symyx Technologies\LogFiles\

Summary

I hear and I forget. I see and I remember. I do and I understand.

- Confucius

Documentation

3-tier Architecture

Services

Certificate

Workflows

Permissions

Indexing

Export/Import

Manage server

Log Files

…and One More Thing!

• Contact Accelrys Support: support@accelrys.com

• Join the Accelrys Community: https://community.accelrys.com/index.jspa

• Accelrys Technical Summit Sessions on 17-OCT-2012:

– (ATS4-DEV06) Building Morphit Binders within Symyx Notebook

– (ATS4-DEV07) How to Build a Custom Search Panel for Symyx Notebook

– (ATS4-DEV08) Building Widgets for the Symyx Notebook Home Page

– (ATS4-APP08) Managing Notebook Configurations with Accelrys Deployment Manager

– (ATS4-APP09) Tips and Tricks for Managing Symyx Notebook Server Performance