Getting Started
Submission Integration Configuration Options
Before beginning the submission integration process, clients have several configuration options available to tailor the integration to their specific needs. These options can be enabled or disabled based on the desired workflow and user experience. Below is a list of the available options, along with a brief description of each:
- Hide Author Center for all roles:
This option hides the Author Center from all user roles, ensuring that authors cannot access the Author Center interface. - Suppress all emails to Authors:
When enabled, this option prevents any email notifications from being sent to authors. This is useful for publishers who handle all communication outside ScholarOne. - Lock editing of unsubmitted manuscripts:
This option locks manuscript editing on the ScholarOne side for unsubmitted manuscripts. - Use redirect for invited author after acceptance of invitation:
This option allows for a custom redirect URL to be used after an invited author accepts an invitation, enabling a seamless transition to the external system. - Disable Login Button on Declined/Unavailable Page:
This option disables the login button on the declined/unavailable page, preventing users from logging in after declining an invitation or marking themselves as unavailable. - Allow client to turn on/off submission integration for journals:
This option allows clients to enable or disable submission integration for specific journals using the Client Configuration Center > Add-ons, offering flexibility in managing integrations across multiple journals. - Lock editing of invited manuscripts:
This option locks ingested manuscript editing on the ScholarOne side for invited manuscripts, while allowing edits to be made on the external platform. - Lock editing of final file and first look manuscripts:
This option locks the editing of ingested final files and first-look manuscripts on ScholarOne's side while allowing edits on the external platform. - Ignore submit UAD on ingested manuscripts if no cookie supplied:
This option enables the system to bypass Unusual Activity Detection (UAD) for ingested manuscripts when no cookie is provided. - Lock editing of transferred in manuscripts on ingestion:
This option locks the editing of ingested manuscripts that have been transferred into ScholarOne, while allowing edits on the external platform. - Use redirect for ##CREATE_REVISION_LINK##:
This option allows for a custom redirect URL to be used when creating a revision link, enabling a seamless transition to the external system. - Use redirect for ##CREATE_RESUBMISSION_LINK##:
This option allows for a custom redirect URL to be used when creating a resubmission link, enabling a seamless transition to the external system.
These options should be configured in consultation with your ScholarOne representative to ensure they align with your workflow and integration requirements. Once configured, these settings will be applied to all submissions processed through the integration.
Sending Submissions to Amazon Web Services (AWS) S3
ScholarOne Submission Integration utilizes Amazon Web Services (AWS) S3 cloud storage to receive submission packages. Developers can refer to the links below for general information on PUT requests used for S3 delivery.
- http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUT.html#RESTObjectPUT-description
- http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html
Write access to the Submission Integration S3 bucket is authenticated using a credential pair consisting of an Access Key and a Secret Key. Integrated systems are granted write-only permissions, restricting external systems from deleting, moving, or reading data within the S3 bucket.
To obtain credentials, contact ScholarOne when you are ready to begin development of your submission integration implementation. ScholarOne maintains separate credential sets for different environments: non-production environments (beta, impl) use one Access Key/Secret Key pair, while the production environment uses a distinct set.
ScholarOne Client Key
Integrators will receive a Client key from ScholarOne in addition to the S3 Access Key/Secret Key pair. This Client key specifies the journals within ScholarOne to which the external system can submit manuscripts. While the key is unique to the integrated external system, it is not restricted to a single ScholarOne journal. Therefore, an external system integrated with multiple ScholarOne journals can use the same Client key across those sites.
ScholarOne provides this key, which is used to define the file path for the AWS S3 bucket. Additionally, it must be included as an element in the .go file of the submission package, as detailed in a later section.
To obtain a client key, integrators must submit the following information to ScholarOne. Required fields are marked with an asterisk (*):
- Primary Contact First Name*
- Primary Contact Last Name*
- Primary Email Address*
- Secondary Email Address
- Title
- Organization
- Phone Number
- URL
The "Name" and "Email Address" fields are automatically converted into email tags within ScholarOne, enabling integrators to generate email notifications for successful and failed ingestion attempts. This functionality is particularly useful during testing. In a production environment, ScholarOne offers multiple web service options for monitoring ingestion success and failure. These options will be covered later in this guide.
ScholarOne S3 Bucket Location Information
Integrators can access ScholarOne S3 buckets using the location details provided below.
- Base URL for S3 bucket
- (Test Environments):
http://s3-us-west-2.amazonaws.com/clarivate-scholarone-dev-us-west-2-s1m-submission - (Production Environment):
http://s3-us-west-2.amazonaws.com/clarivate-scholarone-prod-us-west-2-s1m-submission
- (Test Environments):
- The Submission Integration S3 bucket is hosted in the AWS US-WEST-2 region.
- ScholarOne journal sites are distributed across multiple server stacks.
The full S3 URL for a submission deposit is determined by:
- The stack location of the journal within ScholarOne.
- The ScholarOne environment in use.
The unique path for S3 deposits, which must be appended to the base URL, follows this format:
<stack>/incoming/<S1clientkey>/
Example URLs
- Implementation Environment
For a submission in the Implementation environment on Stack 1, where the ScholarOne provided client key is 543-21:
http://s3-us-west-2.amazonaws.com/clarivate-scholarone-dev-us-west-2-s1m-submission/impl1/incoming/543-21/ - Production Environment
For a submission in the Production environment on Stack 4, where the ScholarOne provided client key is 543-21:
http://s3-us-west-2.amazonaws.com/clarivate-scholarone-prod-us-west-2-s1m-submission/prod4/incoming/543-21/
Updated 5 months ago
