Administrator Guide
Get certified by completing our SPORIFY Users Training course which is available via the CorrIT Training Academy. Contact your local SPORIFY administrator for more information.
General Information
System Overview
The features of the system include:
Functions
Provide system and user administration to tenants.
Match preformatted Excel or CSV lists to SPOR Master Data Management Services and G-SRS controlled substance lists.
Provide the ability to create and set a Resolution Status to each term on your uploaded list.
Provide the ability to create and apply Data Tags to your Source or Target Data.
Export each list you have uploaded along with the set Resolution Status and any associated Mapping Data from RMS, OMS or G-SRS, as applicable to your list.
Provide an overview of your activity and Mapping Status via chart-based reports. These reports are known inside SPORIFY as Dashboard, Overview and Data Insight pages.
Provide an overview of the information available in SPOR RMS & OMS and G-SRS services.
Provide notifications to highlight when SPOR information is updated.
Note: Features available are dependent on the subscription plan you have licensed. Not all features are available for all subscription plans.
Browser Compatibility Settings
General Settings
SPORIFY makes use of modern web technology. To experience the system at its best we recommend a modern web browser listed below:
Browser | Supported Version |
---|---|
Chrome | Latest |
Firefox | Latest |
Edge | Latest |
Internet Explorer | 11.70 + |
The system has been tested successfully in Internet Explorer 11.70. However, it is not recommended to run the system in older versions of Internet Explorer due to possible compatibility issues with the angular framework technology used by the system.
Administration Guide
Organisation Units
The Organisation Units area of SPORIFY Administration enables administrators to create and manage groups of individual users. These groups can be used to assign Data Governance roles to multiple users simultaneously (see the Data Governance section of this guide for more information).
Available Actions:
Add Root Unit
Edit
Add Sub Unit
Add Member
Delete Member
Delete
Roles
The Roles area of SPORIFY Administration allows administrators to create and manage user roles by grouping together multiple permissions. These roles can then be assigned to users upon their creation, or via the Users area of the system.
On the Roles screen, Roles can be filtered by permission(s).
Available Actions:
Create New Role
Role Properties:
Role Name
Default?
Permissions
Edit
Edit Role Properties:
Role Name
Default?
Edit Permissions
Delete
Note: The Delete action is not available for Static Roles (Admin and User).
Users
The Users area of SPORIFY Administration enables administrators to create and manage individual users in a variety of ways.
On the Users screen, users can be searched, and filtered by permission.
Available Actions:
Create New User
User Information
Name
Surname
Email Address
Phone Number
Username
Set Random Password
Should Change Password on Next Login
Send Activation Email
Active
Is Lockout Enabled?
Roles
Users can be assigned permissions outside of their provided roles if required.
Note: For a more efficient way to manage user permissions, please review the Roles section of this document. Roles allow permissions to be applied to users in groups to ease the administration overhead.
Login as this user
Note: This feature is helpful when troubleshooting user queries or working on another user's behalf. All actions carried out while an administrator is logged in to another managed user account are clearly labelled in the audit log: “This operation is performed by another user on behalf of this user.”
Edit
Permissions
Available top-level permissions:
Pages: Root level, required for SPORIFY Access.
Access Control: Controls visibility of user data to other users within your tenant (RMS, OMS and SMS lists uploaded by this user will be shared with all users, but if disabled user data is private to their account). Includes API access (Inbound and Outbound) and System Wide access.
Administration: Provides administration features to the user. Options include Audit Logs, Authentication Logs, Change Logs, Data Governance, Integrations, Organisation Units, Resolution Status, Roles, Settings, Source Systems, Tags, and Users.
Organisations: Provides access to the the SPORIFY Organisations area
Referentials: Provides access to the SPORIFY Referentials area.
Substances: Provides access to the SPORIFY Substances area.
Dashboard: Provides access to the SPORIFY main dashboard and navigation bar.
Unlock
Delete
Export to Excel
Audit Logs
The Audit Logs area of SPORIFY Administration allows administrators to view relevant Audit Log entries. Audit Logs record events and activities within the system, providing extensive information about the event or activity that occurred.
Audit Logs can be filtered by Date Range, Username, Service, Duration, Action, Error State, and Browser.
Available Actions:
Export to Excel
Note: SPORIFY support staff may request a copy of the Audit Logs when troubleshooting.
View Audit Log Detail
Audit Log Details contain the following information:
User information:
Username
IP Address
Client
Browser
Action Informations
Service
Action
Time
Duration
Parameters
Custom Data
Error State
Note: Audit Logs show an error state of either Success or Has Error.
Change Logs
The Change Logs area of SPORIFY Administration allows administrators to view relevant Change Log entries. Change Logs record changes made within the system, providing extensive information about the change that occurred.
Change Logs can be filtered by Date Range, User, Action, Entity Type, Entity ID, Field Name, From Value, and To Value.
Available Actions:
Export to Excel
Authentication Logs
The Authentication Logs area of SPORIFY Administration allows administrators to view detailed information about login attempts made by users in their tenant.
Authentication Logs can be filtered by Date Range, Result, Username, Browser, and IP Address.
Available Actions:
Export to Excel
Settings
The Settings area of SPORIFY Administration enables administrators to manage application settings for the following sections of the system: General, Match Settings, EMA Settings, User Management, Security, and External Login Settings.
General
The General section deals with Timezone and Target System Update Preferences settings.
Available Actions:
Timezone
Set your time zone by making a selection from the provided drop-down menu.
Target System Update Preferences
Referential Target System Update Preference
If disabled, system defaults apply. If enabled, the following target data changes will impact Data Governance and Auto Apply Resolution Status: ID, Name (EN), Description (EN), Domain.
Organisation Target System Update Preference
If disabled, system defaults apply. If enabled, the following target data changes will impact Data Governance and Auto Apply Resolution Status. Organisations: ID, Name, Identifiers. Locations: ID, Address, Identifiers.
Substance Target System Update Preference
If disabled, system defaults apply. If enabled, the following target data changes will impact Data Governance and Auto Apply Resolution Status: ID, Name (Preferred Name).
Match Settings
The Match Settings section deals with Matching Preferences (Fuzzy Matching), System to System Preferences, Auto Follow Favourites, and Auto Apply Resolution Status settings.
Please note that Match Settings can increase or decrease the accuracy of system default matching. Please test results with sample data before applying these settings to a production environment.
Available Actions:
Matching Preferences (Fuzzy Matching)
Ignore punctuation and common abbreviations while matching source to target data.
If you enable this, the following punctuation, special characters and character spacing will be ignored while matching your data: < > | # ~ - * . , ? ! ; : ( ) [ ] { } & ^ ' "
SPORIFY will also include common abbreviations in the matching algorithm, e.g. Ltd = Limited.
Automatically match source data to target data when the system performs a sync.
If you disable this, your local data will not be kept in sync with SPOR.
System To System Preferences
Apply manual matches found in any source system when uploading new lists to the same target.
If you disable this, system defaults will apply. If you enable this, any manual matches previously applied to terms in other system lists will be applied to new lists where the source terms are equal.
Apply the Resolution Status found in any source system when uploading new lists to the same target.
If you disable this, system defaults will apply. If you enable this, any Resolution Status applied to terms in other system lists will be applied to new lists where the source terms are equal.
Apply matches based on identical source IDs on the same list.
If you disable this, system defaults will apply. If you enable this, source records will automatically match if they share ID with a matched record.
Auto Follow Favourites
Automatically select all matched Organisations as Favourites.
If you disable this, system defaults will apply. If you enable this, any OMS Organisation you are matched to will be added to your Favourites automatically.
Auto Apply Resolution Status
Automatically set Resolution Status to specified value when mapped target data changes.
If you disable this, system defaults will apply. If you enable this, any Resolution Status applied to a record will be updated to the specified value when the mapped target data changes.
Resolution Status
Select the specified value from the provided drop-down menu.
This menu is only made available when the ‘Automatically set Resolution Status to specified value when mapped target data changes’ setting is switched on.
EMA Settings
The EMA Settings section allows administrators to gain access to EMA SPOR API using their EMA Credentials in SPORIFY.
Credentials are required for EMA SPOR API access on behalf of your organisation. One set of EMA credentials is required per tenant account.
Available Actions:
EMA Credentials
Save
Fill in EMA Username.
Fill in associated EMA Password.
Click the Save button to save the inserted EMA credentials.
Test
Fill in EMA Username.
Fill in associated EMA Password.
Click the Test button to confirm that the associated account has API access.
Clear
Click the Clear button to remove the inserted EMA credentials from the system.
User Management
The User Management section allows administrators to manage various settings related to user registration in SPORIFY.
Available Actions:
Form Based Registration
Allow users to register to the system.
If disabled, users will only be added by administrators via the User Management page.
New registered users are active by default.
If disabled, new users will not be active (and cannot login) until an administrator manually activates their account.
Use security image question (captcha) on registration.
Other Settings
Email confirmation required for login.
Note: Email confirmation is not required for users registering via External Login.
Security
The Security section allows administrators to manage security related settings in SPORIFY.
Available Actions:
Password Complexity
Use default settings.
Default settings are as follows:
Minimum password length = 6.
Maximum password length = 12.
Use numbers in password = On.
Use upper case letters in password = On.
Use lower case letters in password = On.
Use punctuation marks in password = Off.
Minimum password length.
Maximum password length.
Use numbers in password.
Use upper case letters in password.
Use lower case letters in password.
Use punctuation marks in password.
Enforce Password History
Limit Password Reuse.
The number of unique passwords that must be associated with a user account before an old password may be reused.
Insert the desired number in the presented field.
This setting is only made available when the ‘Limit Password Reuse’ setting is switched on.
Password Expiration
Enable Password Expiration.
The password will expire after the set number of days.
Insert the desired number in the presented field.
This setting is only made available when the ‘Enable Password Expiration’ setting is switched on.
User Lock Out
Enable user account locking on failed login attempts.
Maximum number of failed attempts before locking the account.
Insert the desired number in the presented field.
This setting is only made available when the ‘Enable user account locking on failed login attempts’ setting is switched on.
Account locking duration (as seconds).
Insert the desired number in the presented field.
This setting is only made available when the ‘Enable user account locking on failed login attempts’ setting is switched on.
Account is locked out until administrator unlocks it.
Insert the desired number in the presented field.
This setting is only made available when the ‘Enable user account locking on failed login attempts’ setting is switched on.
IP Whitelisting
Add trusted IP addresses or IP ranges from which your users can access your tenant account.
Add one entry per line in the format x.x.x.x for a single address or x.x.x.x/y for a range of addresses.
Insert the relevant IP addresses.
This setting is only made available when the ‘Add trusted IP addresses or IP ranges from which your users can access your tenant account’ setting is switched on.
Session Idle Timeout
Automatically log out user after a set period of inactivity.
Duration of inactivity (seconds)
Insert the desired number in the presented field.
This setting is only made available when the ‘Automatically log out user after a set period of inactivity’ setting is switched on.
NCA Settings
The NCA Settings section allows administrators to manage NCA translations settings in SPORIFY.
NCA Settings are only available with the NCA edition of SPORIFY.
Available Settings:
Translation Settings
Default translation status
Choose appropriate status from the drop-down menu.
Translation Languages
Choose appropriate language from the drop-down menu.
External Login Settings
The External Login Settings section allows administrators to add user accounts hosted on an external identity provider to the SPORIFY system. SPORIFY supports OpenID Connect 1.0 with Okta, Microsoft Azure AD, OneLogin, and ForgeRock as identity providers.
External Login Settings can take up to 24 hours to take effect.
Available Settings:
OpenID with Okta
Authority
Client ID
Client Secret
Redirect URI
OpenID with Azure Active Directory
Authority
Client ID
Client Secret
OpenID with OneLogin
Authority
Client ID
Client Secret
OpenID with ForgeRock
Authority
Client ID
Client Secret
Redirect URI
Obtaining OpenID With Okta Credentials:
Login to Okta.
Select Applications on the navigation menu.
Select Applications.
Click the Create App Integration button.
Select the following options:
Sign-in method
OIDC - OpenID Connect
Application type
Web Application
Click the Next button.
Complete the following fields:
General Settings
App integration name
Grant type
Select Authorization Code and Implicit (hybrid)
Sign-in redirect URIs
Insert URI.
For production, use https://sporify.eu/authorization-code/callback
For validation, use https://v.sporify.eu/authorization-code/callback
Note that no port number is needed for this URI
Sign-out redirect URIs
Insert URI.
For production, use https://sporify.eu/logout
For validation, use https://v.sporify.eu/logout
Assignments
Controlled access
Select the relevant option.
Enable immediate access
Check the ‘Enable immediate access with Federation Broker Mode’ checkbox.
Click the Save button.
View the information provided about the created app, including Client ID and Client Secret.
Select Security on the navigation menu.
View the relevant Issuer URI, which is the required Authority code.
Once the credentials have been obtained:
Login to SPORIFY.
Click Administration on the navigation menu.
Click Settings.
Select External Login Settings.
Check the OpenID with Okta checkbox.
Complete the presented fields.
Click Save All.
Obtaining OpenID With Azure Active Directory Credentials:
Login to aad.portal.azure.com.
Select Azure Active Directory.
Select App Registrations on the navigation menu.
Click New Registration.
Name the application using the Name field.
Select the supported account type ‘Accounts in any organizational directory (Any Azure ID directory - Multitenant).
Under Redirect URI, select Web using the first field.
Set the redirect URI to https://sporify.eu/account/externalLoginCallback for production or https://v.sporify.eu/account/externalLoginCallback for validation.
Click Register.
Under Essentials, click on the Redirect URIS link.
Under Single-Page Application, enter https://sporify.eu in the first field for production or https://v.sporify.eu for validation.
Enter https://sporify.eu/account/login in the second field for production or https://v.sporify.eu/account/login for validation.
Under Front Channel Logout URL, add the following URL: https://sporify.eu/logout.
Under Implicit Grant And Hybrid Flows, select ‘ID tokens (used for implicit and hybrid flows)’.
Click Save.
Navigate to Certificates & Secrets.
Click New Client Secret.
Provide a description in the Description field.
Set an expiry date using the Expires field.
View the Client Secret that has been created.
Copy and save the Secret ID.
Navigate to the Overview tab to view and copy the Client ID.
Select Token Configuration on the navigation menu.
Click Add Optional Claim.
Under Token Type, select ID.
Select the following claims: email and given_name.
Click Add.
Check the ‘Turn on the Microsoft Graph email, profile permission…’ checkbox.
Click Add.
Click Add Optional Claim again.
Under Token Type, select Access.
Check email and given_name.
Click Add.
Once the credentials have been obtained:
Login to SPORIFY.
Click Administration on the navigation menu.
Click Settings.
Select External Login Settings.
Check the OpenID with Azure Active Directory checkbox.
Complete the presented fields.
Click Save All.
Logging In To SPORIFY Using SSO:
Insert the relevant credentials.
Click the Single Sign On button.
The user is redirected to Okta/Azure/OneLogin.
Login via Okta/Azure/OneLogin.
If the user has already signed up, they are redirected to SPORIFY.
If the user has not already signed up, they are redirected to the SPORIFY Sign Up screen.
To sign up, fill in the following fields:
Tenant
First name
Surname
Email
Click the Submit button.
A confirmation email is sent to the user. Via this email, the user is required to confirm their email address.
The user must then wait for their account to be activated by system admin.
Manage Systems
The Manage Systems area allows administrators to create, edit, and delete systems in SPORIFY.
Available Actions:
Create New System
Name
Edit
Name
Delete
Tags
The Tags area allows administrators to create and manage tags. In SPORIFY, tags can be added to Source and Target Referentials, Organisations, Locations, and Substances.
Available Actions:
Create New Tag
Name
Note: A tag’s name must be unique.
Edit Tag
Name
Delete Tag
Confirm the deletion action by clicking Yes.
Note: Deleting a Tag will remove the Tag from any data that it has been associated with. The system will ask if you are sure you wish to proceed with the delete action. A summary of the number of records the Tag will be removed from will be displayed for your information. You must confirm if you wish to proceed or cancel.
Resolution Status
The Resolution Status area enables administrators to manage Resolution Statuses in SPORIFY. Resolution Statuses are applied to records in the system to denote the record’s mapping status.
Administrators can create custom Resolution Statuses. SPORIFY also provides five static Resolution Statuses, which cannot be edited or deleted. These are Matched, Organisations Matched, Multiple Choice, Suggested, and Not Set.
Users cannot delete a Resolution Status if it is already in use.
Available Actions:
Create New Status
Name
Colour
Icon
Maintain mapping record
Edit
Delete
Change Reasons
The Change Reasons area enables administrators to manage Change Reasons in SPORIFY. Change Reasons are utilised as part of e-signature process, which is an optional setting under Data Governance for each data domain. When completing e-signature, a Reasons dropdown is available where approvers can choose from this pre-defined reason list.
Note: By default, no reasons will be automatically created. SPORIFY administrators must create reasons suitable for their internal process.
Available Actions:
Create New Reason
Reason
On/Off: Default
On/Off: Active
Edit
Delete
Data Governance: Settings
Available Actions:
Substances
Governance Required
Switch On to enabled Data Governance for Substances.
Switch Off to disable Data Governance for Substances.
The other Substances settings appear only when this setting is switched On.
Assign Reviewers
Using the provided drop-down menu, select users/groups to permit them to review Substances records.
Assign Approvers
Using the provided drop-down menu, select users/groups to permit them to approve Substances records.
4 Eye Principle
Switch On to prevent approvers from approving Substances records that they have also reviewed.
Switch Off to allow approvers to approve Substances records that they have also reviewed.
Enable Governance Where Record Matched
Switch On to automatically enable governance for all matched Substances target records.
Switch Off if you do not wish governance to be automatically enabled for all matched Substances target records.
E-Signature
Switch On to require users to enter their system credentials and reason for change when saving a Substances record.
Switch Off if you do not wish to require users to enter their system credentials and reason for change when saving a Substances record.
Organisations
Governance Required
Switch On to enabled Data Governance for Organisations.
Switch Off to disable Data Governance for Organisations.
The other Organisations settings appear only when this setting is switched On.
Assign Reviewers
Using the provided drop-down menu, select users/groups to permit them to review Organisations records.
Assign Approvers
Using the provided drop-down menu, select users/groups to permit them to approve Organisations records.
4 Eye Principle
Switch On to prevent approvers from approving Organisations records that they have also reviewed.
Switch Off to allow approvers to approve Organisations records that they have also reviewed.
Enable Governance Where Record Matched
Switch On to automatically enable governance for all matched Organisations target records.
Switch Off if you do not wish governance to be automatically enabled for all matched Organisations target records.
E-Signature
Switch On to require users to enter their system credentials and reason for change when saving an Organisations record.
Switch Off if you do not wish to require users to enter their system credentials and reason for change when saving an Organisations record.
Referentials
Governance Required
Switch On to enabled Data Governance for Referentials.
Switch Off to disable Data Governance for Referentials.
The other Referentials settings appear only when this setting is switched On.
Assign Reviewers
Using the provided drop-down menu, select users/groups to permit them to review Referentials records.
Assign Approvers
Using the provided drop-down menu, select users/groups to permit them to approve Referentials records.
4 Eye Principle
Switch On to prevent approvers from approving Referentials records that they have also reviewed.
Switch Off to allow approvers to approve Referentials records that they have also reviewed.
Enable Governance Where Record Matched
Switch On to automatically enable governance for all matched Referentials target records.
Switch Off if you do not wish governance to be automatically enabled for all matched Referentials target records.
E-Signature
Switch On to require users to enter their system credentials and reason for change when saving an Referentials record.
Switch Off if you do not wish to require users to enter their system credentials and reason for change when saving an Referentials record.
Data Governance: Governance Status
The Governance Status area allows administrators to manage Data Governance Statuses in SPORIFY. Data Governance Statuses are used to denote different stages and outcomes of the Data Governance process.
Available Actions:
Create New Status
Name
Colour
Icon
Publish
Active
Edit (Static Status)
Edit (User Defined Status)
Delete
Note: Only user defined statuses can be deleted. When attempting to delete a status that is already applied to records, the action is denied and the user is presented with a usage count of the given status across Referentials, Organisations, and Substances records.
Integrations: Veeva
SPORIFY’s optional Veeva Integration connects SPORIFY directly with Veeva Vault RIM, and synchronises Controlled Vocabularies and Organisation and Substance records with SPORIFY, enabling the management of your SPOR data with Data Governance and Data Flow control.
Prerequisites
We recommend the use of a service account for SPORIFY to access Veeva Vault RIM. In order to use SPORIFY’S Veeva Vault RIM integration, it is necessary to have access to the following Veeva Vault RIM objects and fields, all of which are required by the SPORIFY service account.
Access is required to the following Veeva Vault RIM objects:
Vault RIM Object Name |
---|
drug_substance_v |
excipient__v |
organization__rim |
country__v |
language__rim |
controlled_vocabulary__rim |
The following fields must be available for import:
Vault RIM Object Name | Vault RIM Field Name |
---|---|
controlled_vocabulary__rim | |
id | |
name__v | |
country__v | |
id | |
name__v | |
language__rim | |
id | |
name__v | |
organization__rim | |
id | |
name__v | |
address__rim | |
city__rim | |
state__rim | |
postcode__rim | |
country__rim.name__v | |
drug_substance__v | |
id | |
name__v | |
ev_code__v | |
spor_substance_code__v | |
us_substance_code__v | |
eudamed_inn__v | |
cas_number__v | |
excipient__v | |
id | |
name__v | |
ev_code__v | |
spor_substance_code__v | |
us_substance_code__v |
The following fields must be available for export:
Vault RIM Object Name | Vault RIM Field Name | SPORIFY Mapped Data |
---|---|---|
controlled_vocabulary__rim | ||
Vault RIM fieldname | SPORIFY Mapping | |
id | N/A | |
spor_list_id__v, | RMS List ID | |
spor_list_name__v | RMS List Name | |
spor_rms_id__v | RMS Term ID | |
spor_term__v | RMS Term Name | |
spor_status__v | RMS Term Status | |
spor_domain__v | RMS Term Domain | |
spor_version__v | RMS Term Version | |
country__v | ||
Vault RIM fieldname | SPORIFY Mapping | |
id | N/A | |
spor_list_id__v, | RMS List ID | |
spor_list_name__v | RMS List Name | |
spor_rms_id__v | RMS Term ID | |
spor_term__v | RMS Term Name | |
spor_status__v | RMS Term Status | |
spor_domain__v | RMS Term Domain | |
spor_version__v | RMS Term Version | |
language__rim | ||
Vault RIM fieldname | SPORIFY Mapping | |
id | N/A | |
spor_list_id__v, | RMS List ID | |
spor_list_name__v | RMS List Name | |
spor_rms_id__v | RMS Term ID | |
spor_term__v | RMS Term Name | |
spor_status__v | RMS Term Status | |
spor_domain__v | RMS Term Domain | |
spor_version__v | RMS Term Version | |
organization__rim | ||
Vault RIM fieldname | SPORIFY Mapping | |
id | N/A | |
spor_oms_id__v | SPOR OMS ID | |
spor_location_id__v | SPOR LOC ID | |
location_status__v | SPOR LOC Status | |
drug_substance__v | ||
Vault RIM fieldname | SPORIFY Mapping | |
id | N/A | |
ev_code__v | ev code (XEVMPD) | |
spor_substance_code__v | EUTCT ID | |
us_substance_code__v | G-SRS UNII | |
spor_term__v | EUTCT Substance Name | |
excipient__v | ||
Vault RIM fieldname | SPORIFY Mapping | |
id | N/A | |
ev_code__v | ev code (XEVMPD) | |
spor_substance_code__v | EUTCT ID | |
us_substance_code__v | G-SRS UNII | |
spor_term__v | EUTCT Substance Name |
Account Permissions
The following account permissions are advised to provide least privilege to the service account used to connect to your Vault RIM tenant.
Permissions Set - Details:
Status: Active
Name: SPORIFYIntegration
Description: Permission set used for SPORIFY sync via Loader API
Created By: [Name]
Created Date: [Date]
Last Modified By: [Name]
Last Modified Date: [Date]
Permissions Set - Application:
API Permissions:
All API
Access API
Events API
Metadata API
File Staging Permissions:
Access
Vault Owner Actions Permissions:
Vault Loader
Permissions Set - Objects:
Read, Create & Edit Permissions:
Base Active Substance
Specified Active Substance
Active Substance
Ingredient
Controlled Vocabulary
Country
Language
Organization
Read Only Permissions:
Base Envelope
All Envelope
Base Envelope Content
Document (Specific Version)
Document (Latest Version)
Object Content
RIM View
User
Profile Setup:
Create a security profile to use the earlier created permissions set.
Create a user profile attached to the earlier created security profile.
Connection
The Connection area enables administrators to connect to the Veeva Integration.
User credentials are authenticated against the Veeva Vault subdomain. If authentication does not occur, the user cannot Save until valid credentials are provided.
Available Actions:
Connect to Veeva
Vault Subdomain
Username and Password
Username
Password
Manual Sync
The Manual Sync area allows administrators to sync SPORIFY with Veeva manually in the application.
It should be noted that Merged IDs are mapped to the surviving record during the Veeva sync. In the relevant scenario, this information is displayed via the record’s Data Insights.
Available Actions:
Sync Now
Full Sync
Referentials Only
Organisations Only
Substances Only
Mapping Configuration
The Mapping Configuration area allows administrators to create new list mappings, and manage existing list mappings.
Available Actions:
New List Mapping
Veeva List
List Type
Mapping Target
Active
Edit
Veeva List
Controlled Vocabulary Type
List Type
Mapping Target
Active
Delete
Sync Configuration
The Sync Configuration area allows the administrator to set configurations for the Veeva synchronisation process in SPORIFY.
When the configurations have been selected, remember to click the Save button.
Available Actions:
Mapped Record Options:
Limit Target Data included in Sync by Governance Status
If enabled, target data included in the sync must be in the Approved stage of data governance and have a data governance status where the associated Publish flag is true. If disabled, target data included in the sync must be in the Approved stage of data governance but can have any data governance status. For domains where Data Governance is turned off, this setting is ignored.
If the data governance functionality and this setting was previously used in the configuration, the tick box remains as previously set, and the value is read-only. If data governance is re-enabled for any domains, the setting is retained as previously set.
Limit Matched Data included in Sync by Resolution Status
If enabled, unmatched data included in the sync can only have the resolution status selected below. If disabled, no unmatched data is included in the sync.
Select Resolution Status from the provided drop-down menu. This setting requires at least one Resolution Status value to be selected.
Unmatched Record Options:
Limit Unmatched Data included In Sync By Resolution Status
If enabled, unmatched data included in the sync can only have the selected resolution status. If disabled, no unmatched data is included in the sync.
Select Resolution Status from the provided drop-down menu. This setting requires at least one Resolution Status value to be selected.
Advanced Vault Loader Options:
Use this section to provide a Criteria VQL expression for each of the Veeva objects listed below. This expression will be included in the API call that SPORIFY makes to the Veeva Vault Loader Extract endpoint and it can be used to limit the amount of data that SPORIFY receives. Veeva provides documentation and an expression validator to help you create this expression.
controlled_vocabulary_rim
country_v
drug_substance_v
excipient_v
language_rim
organization_rim
Scheduled Sync
The Scheduled Sync area enables the administrator to schedule recurring Veeva sync jobs.
When the settings have been selected, remember to click the Save Schedule button.
Available Actions:
Enable
Only when this setting is switched On are the other available settings presented.
Schedule Type
Select one of the following options:
Hourly
Every X hour(s)
Starts at [HH:MM]
Daily
Everyday or Every Weekday
Starts at [HH:MM]
Weekly
Weekdays
Starts at [HH:MM]
Monthly
Day X of every Y months
The [Number] [Day] of every [Number] months(s)
Starts at [HH:MM]
Timezone
Select a time zone from the presented drop-down menu.
Job Log
The Job Log shows previous activity carried out within SPORIFY’s Veeva Integration. For each activity, it presents the following information: Start Time, End Time, Username, Sync Type, Job Start Reason, Sync Status, and Job Status.
Available Actions:
Filter by Date Range
Select a date range via the Date Range drop-down menu.
Click the Refresh button.
Export to Excel
Click the Export to Excel button to download the presented Job Log grid directly to your device.