Intralinks Integration Adapter User Guide.book

Intralinks
Integration Adapter
User Guide
Intralinks 24x7x365 support US: + (1) 212 543 7800 UK: +44 (0)20 7623 8500.
See Intralinks login page for other national numbers
Copyright © 2017 Intralinks, Inc. Version 5.4 June 2017
Table of Contents
Click below to navigate to the chapter or section you want.
Chapter 1: Introduction to the Intralinks Integration Adapter ................................. 3
Overview................................................................................................................................... 3
Capabilities ............................................................................................................................... 3
How the Integration Adapter works .......................................................................................... 5
Training..................................................................................................................................... 7
Chapter 2: Installing the Intralinks Integration Adapter.......................................... 8
System requirements................................................................................................................ 8
Administration........................................................................................................................... 8
Cluster mode ............................................................................................................................ 8
Installing the Integration Adapter.............................................................................................. 9
Chapter 3: Configuring the Intralinks Integration Adapter ................................... 14
Using the Configuration Manager........................................................................................... 14
Chapter 4: Getting Started................................................................................... 29
Running the Integration Adapter under a user account .......................................................... 29
Turning the Integration Adapter on and off ............................................................................. 29
Accessing the Configuration Manager to change settings ..................................................... 30
Uninstalling the Integration Adapter ....................................................................................... 30
Updating the Integration Adapter Software ............................................................................ 30
Intralinks Integration Adapter and Intralinks Designer ............................................................ 31
Integration Adapter security assumptions .............................................................................. 31
Chapter 5: Using the Intralinks Integration Adapter............................................. 32
Chapter 6: Sample XML Files.............................................................................. 39
Introduction............................................................................................................................. 39
Sample XML files.................................................................................................................... 39
Chapter 7: Integration Adapter Data Dictionary................................................. 141
Mapping of data types to fields............................................................................................. 143
ILIA schema definition .......................................................................................................... 144
Output report definition (.XSD) ............................................................................................. 230
Common Parameters Charts ................................................................................................ 235
Chapter 8: Troubleshooting ............................................................................... 247
Overview............................................................................................................................... 247
Error messages .................................................................................................................... 248
Appendix A: Performance Guidelines and Limitations ...................................... 302
Intralinks Integration Adapter................................................................................................ 302
Intralinks Exchange .............................................................................................................. 303
Client limitations and guidelines ........................................................................................... 304
Appendix B: Validation Rules ............................................................................ 305
IntraLinks Integration Adapter User Guide
page 2
Chapter 1: Introduction to the Intralinks
Integration Adapter
Overview
This guide explains the procedures for installing, configuring and using the
Intralinks Integration Adapter (ILIA), along with instructions for troubleshooting.
The terms “workspace” and “exchange” are both used interchangeably in this
document. “Workspace” is the terminology used with IL5 while the term
“exchange” is used with Intralinks Platform. The Integration Adapter supports both
platforms.
This guide is intended for:
•
IT personnel who are responsible for implementing the Integration
Adapter.
•
The system administrator, the person within your organization who will be
using the Intralinks Integration Adapter to upload information to Intralinks
exchanges or to download documents and folders from Intralinks
exchanges.
Capabilities
The Integration Adapter can be used to transfer documents and/or contact
information from a back-end system to Intralinks, ensuring that the information in
both systems is up to date and accurate and reducing the amount of time spent on
data entry.
The Integration Adapter can also be used to download documents and associated
metadata from Intralinks exchanges and store it at a location of your choice.
All Integration Adapter functions are configured using an XML file. The same XML
file can be used to perform file upload and/or download functions.
Using ILIA with Intralinks Courier
Integration Adapter users also have the option of using ILIA in conjunction with
Intralinks Courier. Courier offers a secure solution for the ad-hoc sharing of
confidential or sensitive files between individuals and work groups. ILIA users can
configure an XML Input file that automates the process of sending Courier
packages to a large number of recipients. They can also create, update, and
delete Courier accounts.
Note: If you decide to use ILIA in Courier mode, you cannot use it to work to with
non-Courier Intralinks exchanges. The decision is made during installation. See
Installing the Integration Adapter.
Using ILIA with Amendment Voting
Intralinks’ Amendment Voting solution provides tools for initiating and managing
amendment votes for syndicated loan deals. An Amendment Vote exchange must
be configured to support amendment voting.
Consult the Intralinks Platform Amendment Voting Guide for Managers for more
information.
Intralinks Integration Adapter User Guide
page 3
You can use ILIA to:
•
Synchronize Group Tranches
•
Download Deal Reports
Using ILIA with Intralinks Deal Management System
The Intralinks Deal Management System (DMS) allows clients to manage
syndicated loan transactions throughout the deal life cycle. This includes the
ability to track opportunities throughout the pipeline process, manage contacts
and store commentary, perform book building activities, and run reports.
Consult the Intralinks Deal Management System (DMS) User Guide for more
information.
You can use ILIA to import the following data into DMS:
•
Deal, Tranche and Book information
•
Contacts
•
Organizations
•
Comments
File upload
File upload is used to add exchanges, files, custom fields and other metadata to
Intralinks exchanges, permission them to groups, and provide email notification to
group members. The file upload capability facilitates bulk transfers from a backend document management system.
Update
An Update Document operation type allows users to change the content and
metadata of documents.
An Update Folder operation allows users to update the folder attributes as well as
permissions for existing folders on an exchange.
An Update Group operation allows uses to update group metadata for existing
groups on an exchange.
Rollback
Documents and folders that have been uploaded using the Integration Adapter
can be rolled back using an Input XML file command that specifies the relevant
output file that needs to be rolled back.
File download
File download is used to download documents and associated metadata from
Intralinks exchanges and store them in a chosen location.
Intralinks Integration Adapter User Guide
page 4
•
A full download downloads all files, even those that may already exist in
the storage location.
•
An incremental download will compare the requested download with what
already exists in the storage location and download those items that have
not already been downloaded.
•
A timebound download downloads documents that were added,
documents that were modified or both new and modified documents
within a specified time frame.
•
Files will be saved with unique names. Files with the same name will be
assigned a unique suffix.
•
If a path and filename is greater the 256 characters, the middle third of the
name will be replaced with a dash ( - ). If the path and filename are still
too long after truncating the file, ILIA will not download the file.
•
A folder will be created for each exchange using the exchange name and
ID. For example, if the selected destination directory is: C:\My
Documents, ILIA will store the files in C:\My Documents\Workspace
ABC_123456 where “Workspace ABC” is the exchange name, and
123456 is the ID of the exchange.
•
Files are downloaded in a flat file structure (no folder hierarchy) but two
extra files are created to help reconstruct the original file structure on the
exchange.
– XML file with meta-data and file structure
– HTML file to view structure locally
Remove
•
Users can be removed from a specified exchange.
– You can define a custom note that will be included in an email alert to a
user who has been removed from an exchange specifying the reason
•
Empty and non-empty groups can be removed from an exchange.
•
Files and folders can be removed.
Synchronize
•
Ensures that users and groups on Intralinks exchanges match the users
and groups in your organization’s back-end system.
How the Integration Adapter works
In order to add documents, download documents, or add and remove users,
groups, or documents, you must generate an XML-based input file using your
organization’s back-end system. The information in this input file is transferred to
Intralinks using the Integration Adapter. When processing is complete, a report
lists warnings and errors that occurred during the process, as well as notification
of successfully completed tasks. The Integration Adapter can be configured to
send email messages to selected managers when the process is started and
Intralinks Integration Adapter User Guide
page 5
completed, and when errors occur that cause the process to stop. The Integration
Adapter will also send an alert when a user’s password needs to be reset.
The email address associated with each user serves as a unique identifier. If
users being added to Intralinks do not have a record in Intralinks Global User
Directory (that is, they have never been invited to use an Intralinks exchange
using the selected address), they will be added only if the import file includes all
the information needed to add them to the global system and the information is
valid. This includes the person’s first and last names, the name of their
organization, and their phone number, as well as their email address. You can
also provide role information for the exchange the contact belongs to; if you do
not, the default role that was selected during configuration will be used.
The Integration Adapter can be configured to prevent users who have particular
roles within the exchange from being removed. You can prevent all users whose
addresses belong to selected Internet domains from being removed; in addition,
you can prevent newly added users’ records from being removed for a specified
number of days.
Files can be uploaded to specified exchanges and permissions can be assigned
for groups. An input XML file must contain the list of files to be uploaded plus the
necessary exchanges, groups, and individuals required for successful placement
of the files and the assignment of permissions. When uploading files, users with
the proper Intralinks role assignment have the option to add new exchanges, new
groups, new folders, new permissions and custom fields, if they do not currently
exist.
Files can be downloaded using a variety of criteria specified in the XML file. For
example, you can download all documents on a given exchange or all documents
that you have access to.
Reports
You can also download a number of filterable reports:
•
The Document-centric report provides detailed information about your
exchanges, groups, documents and permissions.
•
The Access report provides information about access to documents,
users, and groups, including alert information.
•
The User-centric report provides filterable information about exchanges
(names, IDs, phases, etc.), groups (names, custom fields, etc.), and
users (names, addresses, phone numbers, whether removed, etc.).
•
The User Comparison report compares user profile information in an
Intralinks exchange to user profile information stored on a back-end
system. It reports all differences in profile details (name, phone number,
etc.) and also indicates whether the user:
– could be found.
– was removed from the exchange.
– was assigned a new email address.
– was on the alias list (users who had more than one profile and these
profiles were merged by the system administrator).
Intralinks Integration Adapter User Guide
page 6
Report User IDs
All the ILIA reports listed above generate a unique identifier for each user. All
reports, except the Document-centric report, allow you to enter the report user ID
in the XML Input file to find the user on the Intralinks Platform when it is not
feasible to use an email address.
•
For example, if a user is permissioned to a document and then changes
his email address, you can enter the user’s unique identifier to find the
user, without specifying an email address.
Security
The Integration Adapter provides the system security you expect from Intralinks.
An Intralinks system administrator is required to set up users who are authorized
to perform actions using XML input files. A user ID and password are required.
Once a user is authenticated within Intralinks, a token will be created and saved
on the client machine. This ensures that no passwords are required within the
XML file.
Archiving
Once an XML file has been processed, it is deposited in an archive folder on the
client machine where it can be retrieved at any time for review.
Training
Two short training modules are available for ILIA.
•
Module 1 provides a general overview of the product with general
instructions for installation and configuration.
•
Module 2 defines XML and explains how it works with ILIA.
Linked video training
Click on the training link to watch Module 1.
Click on the training link to watch Module 2.
Intralinks Integration Adapter User Guide
page 7
Chapter 2: Installing the Intralinks
Integration Adapter
System requirements
The following components must be installed on the computer where the
Integration Adapter will be installed:
•
One of the following operating systems:
– Windows 7 or newer
– Windows Server 2012
Note: ILIA can be run on a server OS (recommended) or client OS
•
64-bit, 2.6GHz processor
•
RAM: 8 GB
•
Runtime System: Microsoft Windows .NET Framework version 3.5 or
higher
Other requirements
•
The account used for ILIA installation must be assigned Windows
administration rights.
•
The account used to run ILIA must be assigned Windows administration
rights.
•
Users must have read/write access to the input, output, archive and
reports folders used by the Integration Adapter.
Administration
Multiple administrators are allowed to access ILIA configuration settings, run the
process monitoring tool and perform other administrative tasks, such as starting
and stopping the service.
Any user with an authorized Windows administrator account on a system running
ILIA in either standalone mode or as part of a cluster will be able to act as an
administrator. In order to support multiple administrators.
ILIA must have access to shared Windows resources.
Cluster mode
ILIA can be configured to run on multiple machines that point to the same shared
drive, use the same configuration settings data file, and read and write to the
same directories for input/output/archive files.
Cluster mode is useful for load balancing and enhanced performance when
processing loads are heavy.
Intralinks Integration Adapter User Guide
page 8
When a machine fails, other machines will process the next input file but any files
in process on the failed machine will not be processed. Jobs will be processed
independently, and the order that files are assigned to machines will be arbitrary.
Requirements for Cluster mode
The folders for Input files, Output files, and Archive files must be located on
common drives that all the systems in the cluster are sharing. You will be
prompted to enter the shared configuration path if you select Cluster mode during
installation.
By default, ILIA will be installed to run under the local system account; this
account will not have full read/write/delete access to a shared network path. ILIA
should be configured to run under a user account by following the instructions in
Chapter 4: Getting Started.
If your organization uses a proxy server, you must enter the proxy settings for
each machine in the cluster. See “Proxy Settings.”
Running the installer file as an administrator
When running installer (MSI) files on Windows 7 or Windows Server 2008, the
Cluster mode browse dialog will not show the users mapped drives unless it is run
as an administrator user.
1. Select the Command Prompt from the Windows Start menu.
2. Right-click and select Run as Administrator.
3. Change the directory to the location of the ILIA installer MSI file (for
example, CD C:\Temp)).
4. Enter the installer name (for example, ILIA-2.7.20088-PROD.msi)and
press Enter.
Advisories on Cluster mode
•
Because Cluster mode processors run in parallel, the sequence in which
you enter command files may be disrupted. Don’t submit multiple jobs for
the same exchange at the same time. Put your entries in a single
command file.
•
The same software version of ILIA should be running for all copies in
Cluster mode.
Installing the Integration Adapter
The Integration Adaptor is installed using a standard Windows installer program.
The Integration Adapter should be installed on a Windows-based server.
To begin the installation process:
1. Copy the msi installer file to the drive where the Integration Adapter is
to be installed.
2. Double-click the msi file to launch the installer. The following window
appears.
Intralinks Integration Adapter User Guide
page 9
3. Review its contents, then click Next.
4. In the next window, review the location where the Integration Adapter
will be installed. If you wish to change the default location, click the
Browse button and select the folder in which you want to install the
Integration Adapter. A folder named “Intralinks” will be created to
contain the application and its associated archive and configuration files.
If you use the default location, shown above, an Intralinks folder will
automatically be created at the root level of the selected drive. The
application and its associated files will be installed within this folder.
Next, decide who can use ILIA services:
•
Everyone—All Windows users who have rights to use the ILIA service
and have permission on input, output, archive, download and installer
folders.
Intralinks Integration Adapter User Guide
page 10
•
Just me—Only the user who installs ILIA.
5. Click Next.
6. In the next window, indicate whether you want the application to be
launched automatically at the end of the installation process. If you plan
to configure the adaptors after installation, mark the selection.
•
Mark the check box if you will be installing ILIA in Cluster Mode.
•
Mark the check box if you wish to use ILIA with Courier.
Note: If you select the Courier option, you cannot use ILIA with your
Intralinks non-Courier exchanges.
7. Click Next.
Intralinks Integration Adapter User Guide
page 11
8. Confirm that you’re ready to begin the installation process.Click Next.
Installation begins. If you selected Cluster Mode on the previous screen,
you will see the screen in step 9. Otherwise, you will see the screen
displayed in step 10, below.
Intralinks Integration Adapter User Guide
page 12
9. Enter the file path for Cluster Mode. This will be the path from which
multiple servers will access the application (for example:
\\mypath\mycity01_public\myname). Click OK.
Note: If you selected “Everyone” on the Select Installation Folder
screen, you will need to enter the path manually. You will not be able to
browse and select the mapped network drive.
Figure 1:
10. After final processing, the following window appears to inform you that
the installation is complete. The ILIA Configuration Screen will appear if
you have selected this option on the previous screen.
11. Click Close to exit the installation program.
Intralinks Integration Adapter User Guide
page 13
Chapter 3: Configuring the Intralinks
Integration Adapter
Using the Configuration Manager
During the installation process, you can choose to have the Configuration
Manager launches automatically when installation is complete (see Chapter 2).
This is recommended when you install the Intralinks Integration Adapter for the
first time. If you need to change your settings at a later date, you can launch the
Configuration Manager using the steps below.
 To launch the Configuration Manager
Select Start > All Programs > Intralinks > Intralinks Integration Adapter >
ILIA Configuration Manager.
 Configuring the Integration Adapter
The following section describe the settings that are required on each screen of the
Configuration Manager. Enter the required data on each screen in the
Configuration Manager and then click Apply to save your entries. (Clicking OK
will also register an entry but it will close the Configuration Manager.)
Important! Be sure to make an entry in every field in the Configuration
Manager. If you do not, errors are likely to occur when users attempt to reconcile
your system of record and Intralinks.
Proxy Settings
If your organization uses a proxy server, enter the required information under
Proxy Settings.
Intralinks Integration Adapter User Guide
page 14
1. Select one of the following options:
•
Use Internet Explorer settings (default) — This is the default option
and you can leave it if you are not using a proxy server.
Leave this radio button checked if you want the Intralinks application to
detect and use the proxy settings used by Internet Explorer. No additional
entries are required.
•
Automatic proxy configuration URL — If you select this radio button,
you must provide users with the address for the Proxy Automatic
Configuration (PAC) file (for example, http://proxy.Intralinks.com/
pacfile.pac). No additional entries are required.
When users log in, they select the Automatic proxy configuration
URL option and enter the address for the PAC file in the field that
appears below the option.
•
Manual Proxy Settings — If you select this radio button, you must
provide users with the following information:
– Authentication type — BASIC or NTLM
– The IP address for the Proxy, (for example, 192.192.192.192)
– The Port used for the proxy (for example, 8080)
– The Proxy ID and Password (if the proxy is Authenticated)
Users must enter these values in the appropriate fields in the Manual
Proxy settings section of the login window.
2. Click Apply.
Note: If you are using ILIA in Cluster Mode, you must enter these proxy
settings for each machine in the cluster.
Set up the Local System Account
Use the following procedure to set up the proxy for the Local System Account.
1. From the Command Prompt, type “gpedit.msc”.
The Local Computer Policy Editor screen displays.
2. Select “Computer Configuration”.
3. Select “Administrative Templates”.
4. Select “Windows Components”.
5. Select “Internet Explorer”.
6. Select “Make proxy settings per-machine (rather than per user)”.
7. Select "Enabled".
8. Click OK.
User Management
Use this screen to identify the users who will be able to perform tasks using the
Integration Adapter.
Intralinks Integration Adapter User Guide
page 15
Note: If your organization uses a proxy server, complete proxy server
configuration (above) before you complete user management.
You must authenticate each user using the person’s email address and password.
Once a user is authenticated by the Intralinks service, a token will be created and
saved on your server. As a result, no password will be needed in the XML input
file. You can add users, authenticate them, remove them and update their
password if it has been changed outside of the Integration Adapter.
Note: It is strongly recommended that you create a separate user account for
ILIA, and not use an existing Intralinks account. If you are using multiple servers,
you should use a different account on each one. If you wish to use the same user
account, install ILIA in Cluster Mode.
 To add a user with a password
The User Management view of the ILIA Configuration Manager should be
displayed.
1. In the User ID field, enter the email address the person uses to log into
Intralinks.
2. Click Add. The Validate User window appears.
Intralinks Integration Adapter User Guide
page 16
3. In the Password field, enter the user’s Intralinks password.
4. If the user is a Deal Management System administrator, click the DMS Admin
User check box.
5. Click Validate. If you have entered a user who is active in Intralinks, the
user’s credentials are validated, and a token is created on your server that will
give the user access to the Integration Adapter. Once validation occurs, the
user’s email address will appear in the Users list.
Note: If you are planning to upload documents, the ILIA user ID must be
assigned a Publisher Plus role or a manager role in the target exchange.
 To add a user using Single Sign-On (SSO) or Enterprise Single SignOn (eSSO)
The User Management view of the ILIA Configuration Manager should be
displayed.
1. Mark the Use your company’s single sign on credentials option.
2. In the User ID field, enter the email address that the person uses to log into
Intralinks.
Intralinks Integration Adapter User Guide
page 17
3. Click Add. The Validate User window appears, and the user ID you entered
on the previous screen is displayed.
4. Enter the issuer, certificate path (location of your organization’s SSO login
certificate for Intralinks) and certificate password. The issuer and certificate
are provided by Intralinks.
The Certificate in Use field displays the last certificate used, if any. This
field is informational and cannot be edited.
5. If the user is a Deal Management System administrator, click the DMS Admin
User check box.
6. Click Validate. If you have entered a user who is active in Intralinks, the
user’s credentials are validated, and a token is created on your server that will
give the user access to the Integration Adapter. Once validation occurs, the
user’s email address will appear in the Users list.
Note: If you are planning to upload documents, the ILIA user ID must be
assigned a Publisher Plus role or a manager role in the target exchange.
Password expiration
Your password will reset automatically every 60 days. You don’t need to be
involved in this process, but you should be aware that it will change. If you set up
email notification, you will be alerted automatically when the system changes your
password. If you need to know the new password, contact your IL Administrator or
you can reset and retrieve the password manually from the Intralinks login screen.
If your password has expired, you will have to contact Intralinks to reset it.
Log-on token
ILIA assigns a “log-on token” for each user so that ILIA can log into ILP without
using a password. The logon tokens are created when assigning users in the User
Management tab of the Configuration Manager. This token will expire after 30
days of inactivity, because of this ILIA will automatically reset the token after 15
days of inactivity to prevent the token from expiring.
The token can expire if ILIA was not run for an extended period or if the user
password was changed using ILP. When this happens the token can be reset by
updating the user in the User Management tab in the Configuration Manager UI.
Intralinks Integration Adapter User Guide
page 18
 To remove a user
1. Highlight the user’s email address in the Users list.
2. Click Remove. You will be asked to confirm the removal.
3. Click Yes.
 To update a user’s password
Use this procedure if a user’s Intralinks password has been changed and needs to
be updated in the Integration Adapter. Typically, users are asked to change their
Intralinks passwords every 90 days. When you perform this procedure, the new
password is copied to the Integration Adapter.
1. Highlight the user’s email address in the Users list.
2. Click Update. The Validate User box opens.
3. Enter the new password and click Validate.
Execution Options
Login
Use the arrow keys to indicate the number of times the Integration Adapter should
attempt to establish a connection to Intralinks if a connection cannot be made to
the service. Also specify the number of minutes the system should wait between
each attempt.
Updates
If you wish to be advised when new ILIA software updates are available, click the
Check for new updates check-box and use the arrow keys to select how often
ILIA should search for updates.
Processing Options
Use the following screens to indicate how unsupported characters, users, groups,
and files and folders should be processed.
Unsupported Character Settings Options
When you create your XML Input file, some symbols and special characters are
not supported on the Intralinks service for personal, organization and group
names and for telephone numbers. These characters are listed on the
Unsupported Character Settings configuration screen.
You have the option to:
•
Replace these characters with the default replacement, or one of your
choosing.
•
Remove these characters.
Note: If you don’t select one of these options, the specific command(s) that
contain the unsupported character(s) will fail and an error message will be
generated. Commands in the same XML Input file that don’t contain unsupported
characters will be processed.
Intralinks Integration Adapter User Guide
page 19
Note: If you choose to replace or remove unsupported characters, be aware that
the application will not provide any indication in the XML Output File that
replacement or removal has taken place. If you wish to receive notification that
submitted characters are unsupported, do not select either of the options
presented here.
Replace unsupported characters
1. Select the Replace or Remove Unsupported Characters check box.
2. Either accept the default replacement symbol shown in the Replace with box,
or enter one of your own choosing for any of the following:
3.
•
First and Last Name
•
Organization Name
•
Group
•
Telephone Number
Click Apply.
Remove unsupported characters
1. Select the Replace or Remove Unsupported Characters check box.
2. Select the Remove Unsupported Characters check box next to any of the
following :
3.
•
First and Last Name
•
Organization Name
•
Group
•
Telephone Number
Click Apply.
User Options
•
For the Role to use if none is specified option, select the user role that
will be assigned to new users being added to the exchange if the input
XML file does not indicate a role for the users. Generally speaking, you
should select a role with few rights, such as Reviewer, to ensure that new
users are not given rights to perform tasks that are inappropriate for them.
The role can be changed manually in Intralinks, if necessary.
•
Select a default language preference for new users. The options are:
English, French, German, Japanese, Portuguese, Spanish, Chinese and
International English.
•
If you add a document to the exchange and a user needs to be alerted,
users may have set their profile preferences to not send alerts or send a
summary alert instead of an immediate alert. Mark the Send user alert
immediately for uploaded documents option if you want to override the
user’s alert preferences.
Intralinks Integration Adapter User Guide
page 20
Group Processing Options
•
Mark the Create groups that do not already exist option if you want
user groups to be created automatically in Intralinks if the input XML file
contains group names that do not already exist in Intralinks.
ILIA allows you to remove empty and non-empty groups from an
exchange.
Note: The option “Remove groups if all members have been removed”
(below) will only be applied when using the “Remove” operation type in
the XML file.
•
Mark the Remove groups if all members have been removed option if
you want groups to be removed when all of the members have been
removed.
– Select the types of groups that will be removed: Exchange groups,
Buyer groups and Collaboration groups. Note that not all exchanges
have Buyer and/or Collaboration groups.
– After a remove operation is completed, ILIA will perform a “clean-up”
operation and remove all empty groups that become empty as a result
of the removal of users from the exchange. Only the groups that match
the type(s) you specified under “Remove groups if all members have
been removed” will be removed.
•
The synchronization operation allows you to reconcile users and groups
on an Intralinks exchange with a master list provided by your system of
record. Mark the checkbox if you wish to implement the following option:
For group reconciliation, remove users from an exchange if they
have been removed from all groups. Note that users will not be
removed from the Intralinks Global User Directory, only from the
exchange you specify.
•
Indicate which groups the synchronization (reconciliation) operation will
apply to under When groups are being reconciled, only the following
will be considered.
– All groups
– By Group Types—Select one or more types (Exchange groups,
Buyer groups, Collaboration groups). Note that not all exchanges
have Buyer and/or Collaboration groups.
– Groups with the following attributes—Attribute Label refers to what
are called “Custom Field labels” on the Intralinks platform. This is a
label that can be used to identify a characteristic of a group. For
example “Doctors.” Attribute Value indicates the value of the Attribute
Label. For example, for “Doctors” you might have “Pediatric” or
“Cardiology.”
Please be sure to mark existing groups with the right attribute
labels and values so that they can be reconciled during
synchronization, and so non-related groups will not be affected.
If you choose this option to identify groups, enter one Attribute
Label and one or more Attribute Values. You can enter additional
Attribute Values by clicking Add another value.
Intralinks Integration Adapter User Guide
page 21
File and Folder Processing Options
•
Mark the Create folders that do not already exist option if you want
folders to be created on the IL exchange when you specify a folder name
in your XML input file that does not already exist.
– If you are adding documents using XML and you do not check this box,
you will receive an error message if an existing folder is not specified.
This can be helpful if you don’t wish to create unwanted folders.
•
Mark the Delete local copies of files after they have been uploaded
option if you are uploading files from a temporary local folder and want
them deleted automatically after they have been uploaded to the IL
exchange.
Role Exclusion Options
Use this screen to prevent users with particular roles, such as Manager Plus, from
being removed.
To exclude a role, highlight it in the Available roles list and click the arrow button
to move it to the Protected roles list.
Domain Exclusion Options
Use this screen to prevent users whose email addresses belong to selected
Internet domains from being removed. For example, you can specify that
members of the domain company.com should not be removed.
To protect users within a domain, enter the domain name in the Domain to
exclude field, in the format company.com, then click Add. The name will appear
in the Protected domains box.
To remove a domain name, highlight the name you want to remove in the
Protected domains box, then click Remove.
Protection Period Options
 Newly Added Users
You can prevent newly added users from being removed for a specified number of
days. This can be useful if both your system of record and Intralinks are being
updated at the same time and the information in Intralinks is more up to date than
the system of record.
◊ To specify a protection period for new users, enter or select a number using
the Protection Period (days) pull-down menu.
 Newly Removed Users
You can also protect users who have removed themselves from exchanges or
who have been removed by others from being re-added to an exchange for a
specified period of time.
◊ To specify a protection period for users who have been removed, enter or
select a number using the Protection Period (days) pull-down menu.
Intralinks Integration Adapter User Guide
page 22
File Download Options
Enter a destination directory to store data that you download from Intralinks. Use
the Browse button to select the directory in which the data will be placed.
The ILIA Service requires that all paths used to specify file locations are on a local
drive or specified using a UNC path if on a mapped drive. This includes paths in
the input XML files and in the UI Configuration screens.
When using a UNC path to another computer, the source computer must allow the
account running ILIA to have access to the files on that computer.
If a mapped drive is selected for the Input, Output, Archive and File Download
path in the Configuration Manager, a warning message will be displayed and it will
be converted to a UNC path.
An example of a UNC path: //acomputer123/folder/myfile
File Truncation Rules
The following truncation rules apply when naming files:
•
For most file types, if the full destination path and filename exceed 260
characters, the filename will be truncated. There are some special cases:
– Microsoft Excel document: maximum length = 218
– Microsoft Word document: maximum length = 254
– Microsoft PowerPoint presentation: maximum length = 258
•
The destination path and filename is defined as the Download folder
(specified in the ILIA Configuration Manager), the workspace name and
ID, and the filename.
– For example: Download folder \ workspace name ID \ filename
– The Download folder will never be truncated.
– If the workspace name and ID are greater than 20 characters, the
middle third of the name and ID will be replaced with a dash (“-“).
– Otherwise, the middle third of the filename will replaced with a dash (““).
•
If files truncation does not reduce the size to less than 260 characters, the
file will not be downloaded. An error message will be returned in the
Output file.
Files and Directories
Three screens are used to configure the name and locations of the input, output,
and archives files.
Input Options
First, enter the name of the Input XML file you will be sending. This is the file that
contains the information that will be imported into Intralinks. Use the Browse
button next to the Input File Directory field to select the directory in which the file
will be placed.
Intralinks Integration Adapter User Guide
page 23
•
The Integration Adapter will look in the specified directory for this file
name.
•
If you do not specify a file name, the Integration Adapter will look in the
specified directory for any XML file.
•
The Integration Adapter appends the date and time to your input file when
the file is moved to the archive directory.
•
Files are processed in the order of earliest to latest, determined by the file
modified date.
Second, use the Browse button next to the High Priority Folder field to create a
High Priority folder and select the directory in which the folder will be placed. If a
specific file needs to be processed before other input files already in the input
folder, it can be placed in a High Priority folder.
Note: The ILIA Service requires that all paths used to specify file locations are on
a local drive or specified using a UNC path if on a mapped drive. This includes
paths in the input XML files and in the UI Configuration screens.
When using a UNC path to another computer, the source computer must allow the
account running ILIA to have access to the files on that computer.
If a mapped drive is selected for the Input, Output, Archive and File Download
path in the Configuration Manager, a warning message will be displayed and it will
be converted to a UNC path.
An example of a UNC path: //acomputer123/folder/myfile
Output Options
Use the Browse button to select the location in which the output file will be
placed. Users must have write access to this location.
If you wish to remove files from the Output folder after a specified amount of time,
click the Remove files older than check-box and use the arrow keys to select the
number of days that an Output file should be retained.
Intralinks Integration Adapter User Guide
page 24
Choose the naming convention you want to use for the Output XML file. This file
contains information about all actions performed by the Integration Adapter plus
any errors that may have occurred during processing. A name should be entered
for both valid and invalid Output files or the defaults will be used.
Specify valid Output XML file name
The output filename is defined using any of the following options:
•
ILIA User ID + date/time stamp (the default)
•
Input filename + batch ID + date/time stamp
•
Customizable name + date/time stamp
Specify invalid Output XML file name
When a serious error occurs and the Input file cannot be processed, there are two
options for naming the output file:
•
Input filename + date/time stamp (the default)
•
Customizable name + date/time stamp
Note: The ILIA Service requires that all paths used to specify file locations are on
a local drive or specified using a UNC path if on a mapped drive. This includes
paths in the input XML files and in the UI Configuration screens.
When using a UNC path to another computer, the source computer must allow the
account running ILIA to have access to the files on that computer.
If a mapped drive is selected for the Input, Output, Archive and File Download
path in the Configuration Manager, a warning message will be displayed and it will
be converted to a UNC path.
An example of a UNC path: //acomputer123/folder/myfile
Intralinks Integration Adapter User Guide
page 25
Archive Options
Review the location where the folder that contains copies of input XML files will be
stored following processing and how long they will be retained there. Select
another location if you like. Users must have write access to this location.
If you wish to remove files from the archive folder after a specified amount of time,
click the Please remove old files from archive folder check-box and use the
arrow keys to select the number of days that an archive file should be retained.
Note: The ILIA Service requires that all paths used to specify file locations are on
a local drive or specified using a UNC path if on a mapped drive. This includes
paths in the input XML files and in the UI Configuration screens.
When using a UNC path to another computer, the source computer must allow the
account running ILIA to have access to the files on that computer.
If a mapped drive is selected for the Input, Output, Archive and File Download
path in the Configuration Manager, a warning message will be displayed and it will
be converted to a UNC path.
An example of a UNC path: //acomputer123/folder/myfile
E-Mail Notification
Use the E-Mail Notification screens to specify:
•
Configure the SMTP settings for your server
•
The people who should be notified about selected events.
•
The events that require notification.
•
The contents of the email notifications.
Note: You can also specify email recipients within the XML output file. Settings
within the XML input file will override the settings you enter in the Configuration
Manager.
SMTP Configuration Options
Enter the following information:
•
SMTP Server Address For example: smtp.yourcompany.com This is the
address of your SMTP mail server. This must be set in order for ILIA to
send notifications to the users specified in the Configuration Manager.
•
Server Port For example: 25. This is the port number of the your SMTP
mail server.
•
Send Email From: For example: api@yourcompany.com. The From
address for all mail sent from ILIA. Most SMTP servers will reject the
email request if it does not have a valid email address
•
Credentials User Id and User Password are used for SMTP servers that
require authentication to send email.
Intralinks Integration Adapter User Guide
page 26
Email Notification List
Use this screen to specify the people who should be notified on job initiation, job
success, job failure, or any of these conditions.
 To add a user to the Email Notification List
1. Enter the user’s name in the Name field.
2. Enter the user’s email address in the E-Mail field.
3. If you want the user to be notified when his or her password is updated via the
User Management screen (see the User Management heading above), click
the Receive password change notifications option.
4. Click Add. The user’s information appears in the contacts list.
 To remove a user
◊ Highlight the user’s name in the contacts list and click Remove.
 To update a user’s information
1. Highlight the user’s email address in the contacts list. The user’s information
appears at the bottom of the screen.
2. Make any needed changes.
3. Click Update. The changes you made will appear in the contact list.
E-Mail Notification Options
Indicate when the selected users will receive email notifications:
•
Job Initiation
•
On Error
•
On Success
•
Always
The Job Initiate option is used to send an email when a job begins
The On Error option is used to send an email if a job has any errors.
The On Success option is used when a job completes with no errors.
The Always option will send notifications on successful or unsuccessful
processing of a file.
ILIA will also send out emails for other serious notifications/errors like:
•
Unable to create output file, unable to read input file.
•
Configuration setting could not be found.
•
User could not login.
•
Communication error with server. Socket errors.
•
Invalid XML
Intralinks Integration Adapter User Guide
page 27
•
User not authorized in ILPlatform. User does not have permission in
ILPlatform.
•
Multi-Factor authentication error.
•
Unhandled exceptions within ILIA.
•
Newer version is available.
•
User password reset.
Job Initiation Notification
Enter the subject line and body text that will appear in email notifications when the
Intralinks Integration Adapter processing has begun, or leave the default.
Job Completion Notification
Enter the subject line and body text that will appear in email notifications when the
Integration Adapter processing has completed, or leave the default.
If you want to include a link to the file that contains error messages and other
processing details, click the Include link to output XML file option.
Intralinks Integration Adapter User Guide
page 28
Chapter 4: Getting Started
This chapter includes the following topics:
•
Running the Integration Adapter under a user account
•
Turning the Integration Adapter on and off
•
Accessing the Configuration Manager to change settings
•
Uninstalling the Integration Adapter
•
Updating the Integration Adapter Software
•
Intralinks Integration Adapter and Intralinks Designer
•
Integration Adapter security assumptions
Running the Integration Adapter under a user account
Once you have installed and configured the Integration Adapter you have the
option to install it as a Windows service. If you choose to do so, the Integration
Adapter will be started automatically when you turn on your computer.
 Running the Integration Adapter under a user account
To install the Integration Adapter as a Windows service:
1. Go to Start > Control Panel > Administrative Tools > Services.
2. Highlight the service name Intralinks Integration Adapter Service.
3. Right-click and select Properties.
4. Select Automatic from the Startup type list.
5. Click the Log On tab and select This account.
6. Click Browse and specify a user who has access to network resources.
7. Click OK to save your settings.
Turning the Integration Adapter on and off
If you don’t wish to install the Integration Adapter as a Window service, you can
turn the service on and off manually.
 Turn the Integration Adapter service on
◊ Go to Start > All Programs > Intralinks > Intralinks Integration Adapter >
Start ILIA Service. A Start ILIA Service window will appear briefly on
your desktop.
 Turn the Integration Adapter service off
◊ Go to Start > All Programs > Intralinks > Intralinks Integration Adapter >
Stop ILIA Service. A Stop ILIA Service window will appear briefly in your
task bar.
Intralinks Integration Adapter User Guide
page 29
 How to determine whether the Integration Adapter is on or off
If you have forgotten what state the service is in:
1. Go to Start > Control Panel > Administrative Tools > Services.
2. Locate the service named Intralinks Integration Adapter Service. If the
words “Started” appears next to the service name in the Status column, the
Intralinks Integration Adapter is on. If not, the Intralinks Integration Adapter is
off.
Accessing the Configuration Manager to change settings
The Integration Adapter must be configured during installation for the service to
work. If you wish to change any of your configuration settings once installation is
complete, you will need to open the Configuration Manager.
 Changing the settings in the Configuration Manager
◊ Go to Start > All Programs > Intralinks > Intralinks Integration Adapter >
ILIA Configuration Manager. The Configuration Manager opens. To
review the configuration options, consult Chapter 3 for details.
Uninstalling the Integration Adapter
 Uninstalling
To uninstall the Integration Adapter:
1. Go to Start > All Programs > Intralinks > Intralinks Integration Adapter >
Uninstall ILIA Service.
2. Click Uninstall ILIA Service and a Wizard screen appears.
3. Select Remove Intralinks Integration Adapter Service and click Finish.
The Wizard will display a message indicating when the removal process is
complete.
4. Click Close.
Updating the Integration Adapter Software
 Updating your software
If you wish to update the Integration Adapter software:
1. Go to Start > All Programs > Intralinks > Intralinks Integration Adapter >
Update ILIA. Click on Update ILIA.
The ILIA Version Update screen appears.
2. If a new version is available, press Start to download it. Note that this will stop
the ILIA service and cancel any input files that are currently being processed.
Otherwise, you will see a message: “No newer versions are available.”
Press Close to close the ILIA Version Update screen.
Intralinks Integration Adapter User Guide
page 30
Intralinks Integration Adapter and Intralinks Designer
The Intralinks Integration Adapter (ILIA) and Intralinks Designer (ILD) cannot be
used on the same computer.
Integration Adapter security assumptions
Intralinks is concerned about the security of all client data. The following
conditions are necessary for the secure use of the Integration Adapter within your
enterprise.
•
The Integration Adapter should be hosted on a server inside of a data
center or some such secure facility.
•
Physical security is provided for the host machine.
•
Access to the Integration Adapter input folder location is restricted to:
– The external system integrating with the Integration Adapter – write
access
– The system administrator for the Integration Adapter machine – readonly access
•
The Integration Adapter implicitly trusts the external systems that it is
integrating with; no integrity check is performed on the XML coming in
from the external system.
•
Private information about contacts in the XML file are kept on the
Integration Adapter server (phone number, name, organization).
•
An Intralinks ID (email address) must be associated with the Integration
Adapter in order for it to work.
Intralinks Integration Adapter User Guide
page 31
Chapter 5: Using the Intralinks
Integration Adapter
Capabilities
You can perform the following activities using the Integration Adapter:
•
Create an ILP or IL5 exchange.
•
Add documents to Intralinks exchanges, permission them to groups and
individuals, and provide email notification to a fixed or variable list of
users.
•
Update documents, folders and groups on an exchange.
•
Set the current user’s access to the exchange as public or private.
•
Add groups and users to an exchange, including placeholders for users
without an email address.
•
Assign values to custom fields on exchanges, groups, and documents.
•
Assign, change, and remove permissions to and from documents, folders,
and subfolders
•
Remove users from a specified exchange and send an email alerting
them and providing a reason.
•
Remove groups and members from an exchange.
•
Remove files or folders.
•
Download documents and meta-information from Intralinks to a selected
location.
•
Download deleted files from an Intralinks exchange (not permitted from
an IL5 exchange).
•
Download a Document-centric report showing the contents of requested
ILP exchanges as well as their hierarchies.
•
Download a User-centric report showing information about exchanges,
groups, and users (including removed users)
•
Download a customized Access report providing information about
access to documents, users, and groups, including alert information.
•
Configure settings to clear all content older than a specified number of
days from the Archive and/or Output folders.
•
Configure setting to clear successfully uploaded files from the local folder
specified in the input file.
•
Rollback uploaded documents processed in an Input XML file.
•
Synchronize groups and users on Intralinks exchanges to match the
groups and users in your organization’s back-end system.
•
View the status of files that are currently being processed.
Intralinks Integration Adapter User Guide
page 32
•
Apply or update the sort order of documents and folders on an Intralinks
exchange
•
Update metadata for existing exchanges
– Assign values to exchange custom fields.
– Update the configuration of custom fields at the exchange level, group
level and document level, and publish custom fields.
– Update exchange phase.
Creating an XML file
To use the Integration Adapter effectively, you will need to integrate it with any
back-end systems you are currently using for customer management or for storing
documents. The only requirement is that you generate XML files
programmatically, in the schema required by our system. All of the data can be
output in a single XML file or in multiple XML files, if that is more convenient. The
rules for formatting XML files for use with the Integration Adapter are provided in
the next two chapters, along with some sample files.
The input file
When you configure the Integration Adapter, you must specify the name of the
XML input file you will be using and the directory you will place it in. The name you
assign to the XML file is used by the Integration Adapter to locate and process the
file.
If no input filename is specified in the Configuration Manager, all XML files placed
in the input folder will be processed by ILIA. Otherwise, ILIA will process only input
files whose names match that given in the Configuration Manager. (See Chapter
3: Configuring the Intralinks Integration Adapter.)
Note that If the name you enter in the Configuration Manager and the name of the
XML file you create don’t match, the Integration Adapter will be unable to process
your input file.
Loading the XML
To initiate processing, simply place your XML file in the folder you specified in the
Configuration Manager. The Integration Adapter continually monitors the input
folder for new XML input. When it identifies a new XML file, the Integration
Adapter uploads the contents of the file automatically for processing, removing it
from the folder. Multiple files can be placed in the input folder but the input queue
can process only one file at a time.
You also have the option to use a High Priority folder. If a specific file needs to be
processed before other input files already in the input folder, it can be placed in a
High Priority folder. The High Priority folder is specified in the Input Folder option
of the ILIA Configuration Manager. (See Chapter 3 for details.)
XML Validation
When you submit an input file for processing, ILIA will validate your XML
according to the schema definitions specified in Chapter 7: ILIA Data Dictionary. If
your file is not properly formatted, you will receive an error message indicating the
line(s) and position(s) of the errors. The validation process will proof your input
Intralinks Integration Adapter User Guide
page 33
files before they are submitted for processing, saving time and processing
resources.
Note: XML should be in UTF-8 format.
Using the Process Monitor
The Process Monitor allows you to view the status of files that are currently being
processed by ILIA. Files displayed in the Process Monitor are in one of the
following states:
•
Currently being processed
•
Waiting to be processed
•
Already processed*
* The Process Monitor is not a history log. Processed files are removed once you
close the Process Monitor. The Output file (explained below) is used as a history log.
To access the Process Monitor:
1. Go to Start > All Programs > Intralinks > Intralinks Integration
Adapter and click ILIA Process Status Application. The ILIA Process
Monitor opens.
Figure 2: Process Monitor
Top Window
When you input an XML file for processing its name will appear here. When it is
first submitted it will have an .xml suffix. Once it is ready for processing, the suffix
will change to .log. Highlight a file to see its details, shown in the bottom window.
•
File—Name of file submitted to the input folder or Priority queue.
•
Submitted On—Date and time the file was submitted.
•
Status—Waiting, Initializing, Staging, Staged, In Progress, Completed,
Partially Completed, Failed, Canceled.
Intralinks Integration Adapter User Guide
page 34
•
Progress—Indicates visually how much of the job has been completed.
•
Completed On—The date and time processing was completed.
•
Result—Opens the output file (see Checking the output file).
Bottom window
Shows the details for each operation performed on the file highlighted in the top
window.
•
File—Shows file name selected in the top window.
•
Machine—The name of the computer that is processing the file.
•
User ID—Person who submitted the XML file.
•
Step—Lists a number for each operation performed on the file.
•
Operation—Add, Update, Copy, Move, Delete, Download.
•
Type—Document, Exchange, Folder, Group, User
•
Name—The name of the type shown (document, exchange, etc.)
•
Status—Pending, In Progress, Created, Complete, Partial, Error.
•
Progress—Indicates visually how much of the operation has been
completed.
Awaiting email notification
The Integration Adapter can provide status information on your job at various
stages in the process via email. You specify your notification recipients and
preferences using the Configuration Manager. (You can also send notifications via
you XML input file. These settings will override the settings in the Configuration
Manager.)
The alert options are:
•
On job initiation
•
On error
•
On successful completion
•
Always (on any of the three conditions above).
Sample email notifications
On Job Initiation
A new Input XML file is being processed by the Intralinks Integration Adapter.
User: user@Intralinks.com
Batch ID: 1001
Job ID: 1
Operation Type: Create
Intralinks Integration Adapter User Guide
page 35
Workspace ID: 333434
Workspace Name:
On Error
Unable to login user user@Intralinks.com
Error: Login Failed
On Successful Completion
An Input XML file has been processed by the Intralinks Integration Adapter.
Report Description:
Process Date / Time: Wednesday, October 14, 2009 9:30:43 AM Archive
Input File: C:\Intralinks\Intralinks EIS Service\Archive
Files\NewUsers_input.xml 10.14.2009 9.30.43 AM.xml Batch ID: 1001 Job ID:
1 Job Status: Completed Operation Type: Create Workspace ID: 333434
Workspace Name: User’s workspace
Description:
Status: Completed
Checking the output file
When you configure the Integration Adapter, you must specify the name of the
XML output file and the directory you want it placed in.
After processing, this file will contain information about all the actions performed
by the Integration Adapter, plus any errors that may have occurred during
processing. Users must have write access to the location where the output file will
be created.
Sample output files
On error
<?xml version="1.0" encoding="utf-8"?>
<ProcessReport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
ProcessingDateTime="2011-07-11T12:54:51.8604195-04:00" Description=""
InputFileArchive="C:\ILIA\archive\Archive 7.11.2011 12.54.51 PM.xml"
MachineID="BOSDVLAP218">
<Batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="822531" Name="suraj Arc M_A Exchange FLP ON"
Status="PartiallyCompleted" Description="">
<Command Type="Update" ItemType="Folder" Id="1368166847"
Name="26.0 folder_dev4" Status="Complete" Description="Task successfully
completed." Version="b6589fc6ab0dc82cf12099d1c2d40ab994e8410c"/>
Intralinks Integration Adapter User Guide
page 36
<Command Type="Add" ItemType="Document" Name="123.pdf"
Status="Failed" Description="Document not found on local system."
ErrorCode="103037"/>
<Command Type="Add" ItemType="Document" Name="vbill.pdf"
Status="Failed" Description="Document not found on local system."
ErrorCode="103037"/>
<Command Type="Add" ItemType="Permission" Name="26.0
folder_dev4" Status="Complete" Description="Permission group Col_Gp
successfully set" ErrorCode="101028"/>
</Workspace>
</Job>
<Job Id="2" OperationType="Create">
<Workspace Id="844001" Name="Suaj pha licen 5x exchange"
Status="PartiallyCompleted" Description="">
<Command Type="Update" ItemType="Publication"
Id="urn:Intralinks:PUBLICATION.1849011" Name="pub_folder_dev4"
Status="Complete" Description="Task successfully completed." Version=""/>
<Command Type="Add" ItemType="Permission"
Name="pub_folder_dev4" Status="Warning" Description="Document
protection is not enabled on this exchange. Protection will not be applied."
ErrorCode="103056"/>
<Command Type="Add" ItemType="Permission"
Name="folder_DEV4\pub_folder_dev4" Status="Complete"
Description="Permission group Newgp1 successfully set"
ErrorCode="101028"/>
<Command Type="Add" ItemType="Attachment" Name="123.pdf"
Status="Failed" Description="Attachment not found on local system."
ErrorCode="105006"/>
<Command Type="Add" ItemType="Attachment" Name="vbill.pdf"
Status="Failed" Description="Attachment not found on local system."
ErrorCode="105006"/>
<Command Type="Add" ItemType="Alert" Name="pub_folder_dev4"
Status="Complete" Description="Successfully activated the alerts &#160;for
group Newgp1." ErrorCode="101022"/>
</Workspace>
</Job>
</Batch>
</ProcessReport>
On successful completion
<?xml version="1.0" encoding="utf-8"?>
<ProcessReport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" ProcessingDateTime="2010-1102T17:56:18.500367-04:00" Description=""
InputFileArchive="C:\temp\CSA\Archive\Archive 11.2.2010 5.56.18 PM.xml"
MachineID="BOSDVDSK110">
Intralinks Integration Adapter User Guide
page 37
<Batch>
<Job OperationType="Create">
<Workspace Id="196611" Name="Test Exchange" Status="Completed" Description=""
TemplateId="1234567" Phase="Hold">
<Command Type="Add" ItemType="Folder" Id="25312607" Name="Capital Test"
Status="Complete" Description="Task successfully completed." Version="" />
<Command Type="Add" ItemType="Folder" Id="25312617" Name="2009"
Status="Complete" Description="Task successfully completed." Version="" />
<Command Type="Add" ItemType="Document" Id="25406677" Name="doc2.pdf"
Status="Complete" Description="Task successfully completed."
Version="356a192b7913b04c54574d18c28d46e6395428ab" />
<Command Type="Add" ItemType="Document" Id="25406687" Name="doc3.xls"
Status="Complete" Description="Task successfully completed."
Version="356a192b7913b04c54574d18c28d46e6395428ab" />
<Command Type="Add" ItemType="Document" Id="25406697" Name="doc1.doc"
Status="Complete" Description="Task successfully completed."
Version="356a192b7913b04c54574d18c28d46e6395428ab" />
<Command Type="Add" ItemType="Custom Fields" Name="Test Exchange"
Status="Complete" Description="Successfully published custom fields." />
</Workspace>
</Job>
</Batch>
</ProcessReport>
In the Event of a network disconnection
If you lose your Internet connection while ILIA is processing an XML file, you will
receive an email informing you of the failure, if you have configured email
notification on failure (see above). However, the XML Output file will not indicate
which operations were completed, if any, prior to the network failure. ILIA does not
resume processing your XML file after a network disconnection. You will need to
log in to the Intralinks platform and inspect your exchanges to identify what has
changed.
Checking the Archive folder
After an XML file is processed, successfully or not, it is moved to the Archive
folder. This is your repository for jobs that have been submitted and processed.
The Archive folder location is set using the Configuration Manager. Users must
have write access to this location.
Intralinks Integration Adapter User Guide
page 38
Chapter 6: Sample XML Files
Introduction
The Intralinks Integration Adapter transfers information using XML files. These
files must be formatted using the schema described in this chapter and the next.
XML must be in UTF-8 format.The Integration Adapter supports both IL5 and
Intralinks Platform exchanges.
•
The operation types supported in the input XML file are:
– Create—creates exchanges, users, groups, documents, and folders
specified in that batch.
– Remove—removes documents, folders, users and empty groups from
specified exchanges.
– Update—updates documents or groups and the role of existing users
in that batch.
– Synchronize—ensures that users on Intralinks exchanges match the
users in your organization’s back-end system.
– Rollback—will undo any additions to documents and folders plus any
associated metadata on Intralinks exchanges introduced by the output
file specified in the rollback command.
– Download—downloads documents and folders from exchanges and
saves them on a local system.
A full download downloads all files, even those that may already
exist in the storage location.
An incremental download will compare the requested download
with what already exists in the storage location and download
those items that have not already been downloaded.
A timebound download allows you to download documents that
were added, documents that were modified or both new and
modified documents within a specified time frame.
•
Each input file can have multiple batches.
•
Each batch can have multiple jobs.
•
A job can have only one operation type.
•
A job can have multiple exchanges.
– However, the same exchange should not appear more than once in the
same XML Input file.
•
Each exchange can have multiple groups, users, folders and documents.
Sample XML files
Sample XML files are provided below.
Intralinks Integration Adapter User Guide
page 39
Date format
•
Setting a date format (ILP, IL5)
Exchanges
•
Create an exchange (ILP, IL5)
•
Add groups and users to an exchange (ILP, IL5)
•
Set the public/private content value (ILP, IL5)
•
Change the phase on an existing exchange (ILP)
Working with documents, folders, reports, publications and
attachments
•
Create folders (ILP, IL5)
•
Add folders and documents to an exchange (ILP)
•
Add document with a custom field to an exchange (ILP)
•
Add documents with notes (ILP)
•
Update documents (ILP)
•
Update publications (IL5)
•
Update folder properties (ILP)
•
Add folders, publications and attachments to an exchange (IL5)
•
Add folders, publications, and attachments and upload a report to an
exchange (IL5)
•
Set ownership of a new document (ILP)
•
Change ownership of an existing document (ILP)
•
Set sort order of folders and subfolders (IL5, ILP)
•
Update the existing sort order of folders and subfolder (IL5, ILP)
•
Set sort order for documents (ILP)
•
Update sort order for documents (ILP)
•
Filter a list of documents using the “Submitted By” or “Submitted On”
fields (ILP)
•
Filter a list of documents using the “Effective Date Range” field (ILP)
Removing folders, and subfolders and documents
•
Removal scenarios
•
Remove documents and folders (ILP)
•
Remove documents and leave folder (ILP, IL5)
•
Remove a list of documents and folders by ID (ILP)
Intralinks Integration Adapter User Guide
page 40
•
Remove a list of documents by specified criteria (ILP, IL5)
Folder and document permissions
•
Set permissions for a folder (ILP, IL5)
•
Replace permissions for a folder (ILP)
•
Set permissions for a document (ILP)
•
Replace permissions for a document (ILP)
•
Permission documents to the All Users group (ILP)
Groups and users
•
Synchronize users in an exchange (ILP, IL5)
•
Synchronize groups and users in an exchange (ILP)
•
Update user roles on an exchange (ILP, IL5)
•
Set member roles of new users (ILP)
•
Set member roles of existing users (ILP)
•
Add groups and users to an exchange (ILP, IL5)
•
Remove a user from an exchange (ILP, IL5)
•
Remove all group members from an exchange (ILP, IL5)
•
Remove two users from two different groups (ILP, IL5)
•
Sending custom remove alerts for deleted users (ILP, IL5)
•
Suppress the “Welcome to the Exchange” alert for new users (ILP)
•
Create multiple groups (ILP, IL5)
•
Remove groups from an exchange (ILP, IL5)
•
Change default folder for groups on create or update (ILP)
•
Updating group metadata (ILP)
Custom Fields
•
Assign values to exchange custom fields (ILP)
•
Update values to exchange custom fields (ILP)
•
Assign values to group custom fields (ILP)
•
Change custom fields of an existing document (ILP)
•
Enable/disable custom fields when creating an exchange (ILP)
•
Update the availability of custom fields at the exchange and group levels
and then publish them (ILP)
Intralinks Integration Adapter User Guide
page 41
Reports
•
Access report (ILP)
•
Access reports for an exchange (ILP)
•
Access report using a group filter (ILP)
•
Access report using a group custom field filter (ILP)
•
Access report using a user filter (ILP)
•
Document-centric report (ILP)
•
User-centric report (ILP)
•
User Comparison report (ILP)
Rollback
•
Rollback files (ILP, IL5)
Downloads
•
Download all files from an exchange (ILP, IL5)
•
Download all exchange files using a file title filter (ILP, IL5)
•
Download all files from a folder (ILP, IL5)
•
Download files from a folder using a custom field filter (ILP)
•
Download all exchange files using a custom field filter (ILP)
•
Download all files from all exchanges (ILP, IL5)
Miscellaneous Procedures
•
Use PassThrough fields (ILP, IL5)
•
Set the user protection period in the Input XML file (ILP, IL5)
•
Override email notification (ILP, IL5)
•
Change the name of the Output XML file (ILP, IL5)
•
Question and Answer functionality (ILP)
Working with Courier
•
Send Courier packages
•
Administer Intralinks Courier accounts
– Create Courier accounts
– Update Courier accounts
– Delete Courier accounts
Working with Amendment Voting
•
Synchronize group tranches (ILP)
Intralinks Integration Adapter User Guide
page 42
•
Download Deal Report (ILP)
Working with the Deal Management System
•
Working with DMS
– Add Deal, Tranche, and Book
– Add Deal, Tranche, and Book with Joint Book Runner
– Add Organizations and Contacts
– Add Comments
Date Format
Setting a date format
Because date formats vary from country to country, the DateFormat attribute
should be used to define the format of the date fields used in your input XML files.
If the DateFormat is not specified the date strings will be interpreted using the
local setting of your operating system.
Examples of DateFormat strings
Date Format
Input File Date
MM/dd/yyyy
05/03/2010
dd-MM-yyyy
03-05-2010
dd MMM, yyyy
05 May, 2010
For more information on date format strings, see http://msdn.microsoft.com/en-us/
library/8kb3ddd4.aspx.
DateFormat attribute
The DateFormat attribute allows the customer to tell ILIA what the format of the
date strings are in the input file. For example, in the input file they can provide an
EffectiveDate for a document or publication or they can provide a
ModifiedDateFrom and ModifiedDateTo in the DocumentCriteria. They can write
the date string as “05/06/2010”. Without specifying the DateFormat this can be
interpreted in different ways depending on the current culture setting of the
system running ILIA. In the US this would be May 6, 2010. In most European
countries this would be June 5, 2010. In some countries it may not even convert
properly (they may not recognize the slash separator).
In the US the default date format is “MM.dd.yyyy so the input file would be:
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="MM.dd.yyyy">
<Identity UserId="user@company.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download">
<Workspace Id="131591">
Intralinks Integration Adapter User Guide
page 43
<Folders>
<Folder Name="Test EIS" />
</Folders>
<DocumentCriteria
ModifiedDateFrom="01.01.2009"
ModifiedDateTo="08.13.2010" />
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
In Germany the default date format is “dd.MM.yyyy” so the input file would be:
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="dd.MM.yyyy">
<Identity UserId="user@company.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download">
<Workspace Id="131591">
<Folders>
<Folder Name="Test EIS" />
</Folders>
<DocumentCriteria
ModifiedDateFrom="01.01.2009"
ModifiedDateTo="13.08.2010" />
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Exchanges
Create an exchange
Exchanges are created from a template (identified by an ID number). You will
need to work with your Intralinks representative to get this template ID number.
•
The Workspace “Name” attribute is optional except when creating a new
exchange. The Workspace “ID” attribute is required in all other conditions
to identify the appropriate exchange except when creating a new
exchange.
•
Set the name, description and host.
•
You can set the phase of the exchange when you create it. The default
phase is “Hold”.
•
When you create an exchange using a template that has the Custom
Fields setting enabled, the custom fields will be automatically published.
Intralinks Integration Adapter User Guide
page 44
•
You can't create two exchanges with the same name in the same input
XML file.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="100">
<Job Id="1" OperationType="Create">
<Workspace Name="TestCreate3" Template="105401"
Host="IL Testing" Description="This is a test
exchange" Create="true" Phase="Open”>
<Folders>
<Folder Name="Folder 3" Create="true">
<Documents>
<Document Name="Test.pdf"
LocalPath="C:\temp\Temp.pdf" />
<Document Name="CRA UI Screens.docx"
LocalPath="C:\Temp\CRA UI Screens.docx" />
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Add groups and users to an exchange
•
To create users you should provide the following information:
– Valid email address
– First name
– Last name
– Phone number
– Organization
– Role (optional)
If a role is not provided, the default will be assigned based on your
selection in the configuration settings.
•
Please see Validation Rules in Appendix B before entering the items
above.
•
If a user already exists in the Intralinks Global User Directory, the
information you enter here will not change the existing listing.
•
Updating users is limited to changing a person’s role on the exchange.
<?xml version="1.0" encoding="UTF-8"?>
Intralinks Integration Adapter User Guide
page 45
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///Z:/
ILIA/Schemas/CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1234567" Name="Test Workspace">
<Groups>
<Group Name="P_1">
<Users>
<User EMailId="test_1@intralinks.com"
FirstName="EIS_test1"
LastName="testser_1" Phone="6171111111"
Org="Intralinks"
Role="Publisher" />
</Users>
</Group>
<Group Name="P_2">
<Users>
<User EMailId="Test_2@intralinks.com"
FirstName="EIS_test_2"
LastName="testuser_2" Phone="6171111111"
Org="Intralinks"
Role="Publisher" />
</Users>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Set the public/private content value
These examples will set the public/private content value of an IL5 or ILP
exchange. The value will be set only if the public/private content setting is enabled
for the exchange, otherwise it is ignored.
Note that as the user submitting the XML file, you can declare yourself as public
or private (Pr/Pu) for a specific exchange. If not declaring yourself as public or
private within an exchange, the default value “private” will be assigned. If you are
creating a publication or document, then you should declare the publication or
document as public or private.
 IL5 exchange
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
Intralinks Integration Adapter User Guide
page 46
<Workspace Id="1234567"
PvPDeclaration="PrivateOnly">
<Folders>
<Folder Name="My Root Folder Test A\Folder
Level 1\My Sub Folder">
<Publications>
<Publication Name="Base Publication Name"
Visibility="private">
<Attachments>
<Attachment Name="Overview of ILIA"
LocalPath="C:\Temp\Overview of ILIA.pptx"/>
</Attachments>
</Publication>
</Publications>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
 ILP exchange
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1234567"
PvPDeclaration="PrivateOnly">
<Folders>
<Folder Name="My Root Folder Test A\Folder
Level&#xD;&#xA;1\My Sub Folder">
<Documents>
<Document Name="Base Document Name"
LocalPath="C:\Documents and
Settings\ILIAUser\My&#xD;&#xA;Documents\Base Document
Name.doc" Visibility="private"></Document>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Change the phase on an existing exchange
Phases are used to ensure that no one has access to an exchange until the owner
is ready for them to use it. There are three possible phases: Hold, Open, and
Intralinks Integration Adapter User Guide
page 47
Preparation. Most exchanges are initially created in the Hold phase. You can only
change the phase on an ILP exchange.
You also have the option to suppress the alert that is sent to exchange users who
become active when the phase is changed.
This example changes the phase to “Open” for exchanges 1243581 and 2253599
and suppresses the alert for each exchange.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
Documents%20and%20Settings/msieg/Desktop/
CSAInputXMLSchema.xsd">
<Identity UserId="user@intralinks.com"/>
<batch Id="6R9379HI">
<Job Id="adhoc" OperationType="Update">
<Workspace Id="1243581" Name="ILIA test"
Phase="Open" SuppressWelcomeAlert="true"/>
<Workspace Id="2253599" Name="ILIA test2"
Phase="Open" SuppressWelcomeAlert="true"/>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Working with folders, documents, reports, publications and
attachments
Create folders
This process will create two folders if “InvestorA CoInvestors VII B” and
“LLC\Quarterly Reports” exist on the exchange. If they do not exist, they will be
created.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="aUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="761425" Name="Mega Investment Fund
VII,L.P.">
<Folders>
<Folder Name="InvestorA CoInvestors VII B
LLC\Quarterly Reports\2009" />
<Folder Name="InvestorA CoInvestors VII B
LLC\Quarterly Reports\2010" />
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Intralinks Integration Adapter User Guide
page 48
Return to Sample XML files index.
Add folders and documents to an exchange
•
This process will add a document to a new folder. To add a document to
an existing folder, you do not need to add Create=True, but you need to
make sure that the folder name specified is a folder that already exists in
the exchange.
•
You need to specify a file extension (for example, .doc or .pdf) when
adding a document.
•
If you are creating a new document and a document already existing
within the target folder with the same name, the new document will be
added with the same name plus a suffix. (For example you add a
document K1.pdf and a file with that name already exists within the folder.
The new file will be added with the name K1[2].pdf.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="100">
<Job Id="2" OperationType="Create">
<Workspace Id="647645">
<Folders>
<Folder Name="My Root Folder Test A\Folder
Level 1\My Sub Folder" Create="true">
<Documents>
<Document Name="EIS2.2Document.png"
LocalPath="C:\Documents and Settings\ILIAUser\My
Documents\EIS2.2Document.png" />
<Document Name="EIS2.2InputSchema.png"
LocalPath="C:\Documents and Settings\ILIAUser\My
Documents\EIS2.2InputSchema.png" />
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Add document with a custom field to an exchange
The labels defined in the CustomFields must match labels in fields definitions in
the exchange.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
Intralinks Integration Adapter User Guide
page 49
<batch Id="100">
<Job Id="2" OperationType="Create">
<Workspace Id="647645">
<Folders>
<Folder Name="My Root Folder Test A\Folder
Level 1\My Sub Folder" Create="true">
<Documents>
<Document Name="EIS2.2Document.png"
LocalPath="C:\Documents and Settings\ILIAUser\My
Documents\EIS2.2Document.png">
<CustomFields>
<CustomField Label="Field1"
Value="Test" />
<CustomField Label="Field2"
Value="12345" />
</CustomFields>
</Document>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Add documents with notes
The “NoteRequired” flag means that the note will be displayed when opening the
document form within a browser.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="aUser@YourOrganziation.com" />
<batch Id="2010-05-21 12:28:23Z">
<Job Id="2" OperationType="Create">
<Workspace Id="111111">
<Folders>
<Folder Name="MyTopLevelFolder\RM">
<Documents>
<Document Name="anImportantDocument1.pdf"
LocalPath="C:\Users\MyUserName\Documents\Rating
Project Test\Temp files\cfile.pdf"
NoteRequired="true">
<Note>"This is where your note would
go."</Note>
</Document>
<Document Name="anImportantDocument2.pdf"
LocalPath="C:\Users\MyUserName\Documents\Rating
Project Test\Temp files\afile.pdf"
NoteRequired="true">
<Note>"This is where your note would
go."</Note>
Intralinks Integration Adapter User Guide
page 50
</Document>
</Documents>
</Folder>
<Folder Name="MyTopLevelFolder\ABS">
<Documents>
<Document Name="anImportantDocument3.pdf"
LocalPath="C:\Users\MyUserName\Documents\Rating
Project Test\bfile.pdf" NoteRequired="true">
<Note>"This is where your note would
go." </Note>
</Document>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Update documents
You can make changes to the content and metadata of documents (for example,
rename, sort order, replace attached file, etc.).
To select documents to update, use either the document ID or the full folder path
in the exchange. You must specify the file extension (for example, .doc or .pdf)
when updating documents.
This example shows how to move a document to a new folder, upload a new
document version, and change the name of an existing document.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="MM/dd/yyyy">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="1265631">
<Folders>
<Folder Name="Folder Test 200">
<Documents>
<Document Name="Doc1.doc"
TargetFolder="Folder Test 300"/>
<Document Name="Doc2.pdf"
LocalPath="C:\temp\Doc.pdf"/>
<Document Name="Doc3.xls" NewName="New
Name.xls"/>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
Intralinks Integration Adapter User Guide
page 51
</ExecuteData>
Return to Sample XML files index.
Update publications
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="100">
<Job Id="1" OperationType="Update">
<Workspace Id="12345">
<Folders>
<Folder Name="Folder20">
<Publications>
<Publication Name="Pub Prot">
<Attachments>
<Attachment Name="1.pdf"
NewName="Newname.pdf"/>
</Attachments>
</Publication>
</Publications>
<Permissions>
<Permission GroupName="Onida"
Control="true"/>
</Permissions>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Update folder properties
You can update folder properties on a specified exchang. Updatable properties
include:
•
Folder name
•
Folder location within the exchange
•
Folder note
•
Whether indexing is allowed
•
Display order
This input file will create a new folder and set the folder note
<?xml version="1.0" encoding="UTF-8"?>
Intralinks Integration Adapter User Guide
page 52
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///Z:/
ILIA/Schemas/v1.0/CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1075181" Name="Test Workspace">
<Folders>
<Folder Name="Folder 200">
<Note>"This is a test folder note."</Note>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
This input file will rename an existing folder and move the folder to a new location.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///Z:/
ILIA/Schemas/v1.0/CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="1075181" Name="Test Workspace">
<Folders>
<Folder Name="Folder 200" TargetFolder="Top
Folder" NewName="Sub Folder 200"/>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Add folders, publications and attachments to an exchange
•
If you are creating a new publication and a publication already existing
within the target folder with the same name, the new publication will be
added with the same name plus a suffix. (For example you add a
publication K2.pdf and a publication with that name already exists within
the folder. The new publications will be added with the name K2[2].pdf.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="100">
<Job Id="1" OperationType="Create">
<Workspace Id="708792">
Intralinks Integration Adapter User Guide
page 53
<Folders>
<Folder Name="My Root Folder Test A\Folder
Level 1\My Sub Folder" Create="true">
<Publications>
<Publication Name="Schema Images"
Visibility="public">
<Attachments>
<Attachment Name="EIS2.2Document.png"
LocalPath="C:\Documents and Settings\ILIAUser\My
Documents\EIS2.2Document.png" />
<Attachment
Name="EIS2.2InputSchema.png" LocalPath="C:\Documents
and Settings\ILIAUser\My
Documents\EIS2.2InputSchema.png" />
</Attachments>
</Publication>
</Publications>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Add folders, publications, and attachments and upload a report
to an exchange
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="100">
<Job Id="1" OperationType="Create">
<Workspace Id="106421" Name="Naseem_NewARC">
<Folders>
<Folder Name="Folder" Create="true">
<Publications>
<Publication Name="Test Protection Pub">
<Permissions>
<Permission GroupName="Group1"
Control="true" Protection="ProtectNoPrint" />
</Permissions>
<Attachments>
<Attachment Name="Report.pdf"
LocalPath="C:\temp\Report.pdf" />
</Attachments>
</Publication>
</Publications>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
<Report WorkspaceId="106421" FolderPath="Folder">
Intralinks Integration Adapter User Guide
page 54
<Permissions>
<Permission GroupName="Group1" Control="true"
Protection="Protect" />
</Permissions>
</Report>
</ExecuteData>
Return to Sample XML files index.
Set ownership of a new document
A tag indicating document ownership is supported for groups, users in group, and
users, when adding, removing, downloading, and reporting on documents. This
example will set the ownership of new documents.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1265631">
<Folders>
<Folder Name="Folder Test 100">
<Documents>
<Document Name="Doc1.doc"
OwnerGroup="Test Grp 1"/>
<Document Name="Doc2.pdf"
OwnerUser="testUser01@e-trial.com"/>
<Document Name="Doc3.pdf" OwnerUser="Joe
Smith"/>
<Document Name="Doc4.xls"
OwnerGroup="Test Grp 1" OwnerUser="testUser01@etrial.com"/>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Change ownership of an existing document
A tag indicating document ownership is supported for groups, users in group, and
users, when adding, removing, downloading, and reporting on documents. This
example will change the ownership of existing documents.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
Intralinks Integration Adapter User Guide
page 55
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="1265631">
<Folders>
<Folder Name="Folder Test 100">
<Documents>
<Document Name="Doc1.doc" OwnerGroup="Test Grp
1"/>
<Document Name="Doc2.pdf"
OwnerUser="testUser01@e-trial.com"/>
<Document Name="Doc3.xls" OwnerGroup="Test Grp
1" OwnerUser="testUser01@e-trial.com"/>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Set sort order of folders and subfolders
If you want your exchange folders and/or subfolders to be organized in a specific
order, you must define this order in the XML Input file. Here is an example of how
to do this:
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///Z:/
ILIA/Schemas/v1.0/CSAInputXMLSchema.xsd">
<Identity UserId="user@yourcompany.com"/>
<batch Id="6R9379HI">
<Job Id="adhoc" OperationType="Create">
<Workspace Id="1397421" Name="2.8 most settings
enabled">
<Folders>
<Folder Name="TopPerformers\2012"
SortOrder="5">
<Documents>
<Document Name="First one"
LocalPath="C:\Documents and Settings\lrozin\My
Documents\WSB\File Split\Saved Values Set Entity.doc"/
>
<Document Name="Second one"
LocalPath="C:\Documents and Settings\lrozin\My
Documents\WSB\File Split\UC_FS_3 Create a New
Distribution .doc"/>
</Documents>
</Folder>
<Folder Name="TopPerformers\2010"
SortOrder="2">
<Documents>
Intralinks Integration Adapter User Guide
page 56
<Document Name="Best one"
LocalPath="C:\Documents and Settings\lrozin\My
Documents\WSB\File Split\Saved Values Set Entity.doc"/
>
<Document Name="Second best one"
LocalPath="C:\Documents and Settings\lrozin\My
Documents\WSB\File Split\UC_FS_3 Create a New
Distribution .doc"/>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Update the existing sort order of folders and subfolder
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="user@intralinks.com" />
<batch Id="6R9379HI">
<Job Id="adhoc" OperationType="Update">
<Workspace Id="1243581" Name="ILIA test">
<Folders>
<Folder Name="Legal\2011 Settlements\APAC"
SortOrder="2" TargetFolder="Legal\2011 Settlements"></
Folder>
<Folder Name="Legal\2011 Settlements\Europe"
SortOrder="1" TargetFolder="Legal\2011 Settlements"></
Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Set sort order for documents
This example adds documents and a folder to the exchange and assigns a sort
order to them. It also tracks the folder and documents using PassThrough fields
(these are returned in the Output XML file).
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="MM/dd/yyyy">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1265631">
Intralinks Integration Adapter User Guide
page 57
<Folders>
<Folder Name="Folder Test 200">
<PassThroughFields>
<PassThroughField Name="ProjectID"
Value="4990" />
</PassThroughFields>
<Documents>
<Document Name="Doc2.pdf"
LocalPath="C:\temp\Doc.pdf" SortOrder="2">
<PassThroughFields>
<PassThroughField Name="ArtifactID"
Value="44776625" />
</PassThroughFields>
</Document>
<Document Name="Doc8.pdf"
LocalPath="C:\temp\Doc.pdf" SortOrder="8">
<PassThroughFields>
<PassThroughField Name="ArtifactID"
Value="76882922" />
</PassThroughFields>
</Document>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Update sort order for documents
This example shows how to to update the sort order for existing documents.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="MM/dd/yyyy">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="1265631">
<Folders>
<Folder Name="Folder Test 200">
<Documents>
<Document Name="Doc2.pdf" SortOrder="2" /
>
<Document Name="Doc8.pdf" SortOrder="8" /
>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
Intralinks Integration Adapter User Guide
page 58
</ExecuteData>
Return to Sample XML files index.
Filter a list of documents using the “Submitted By” or
“Submitted On” fields
For the “Submitted By” and “Submitted On” filters to work, you must have
Workflow enabled on the Intralinks exchange you are filtering.
Use this filter to report on and download documents that were submitted to an
exchange via workflow.
You can provide either the email address or the first and last name of the user in
the SubmittedBy tag.
This example shows how to download a list of documents that were submitted by
user testuser01@e-trial.com.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Download">
<Workspace Id="881865">
<DocumentCriteria Submitter="testuser01@etrial.com"/>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Filter a list of documents using the “Effective Date Range” field
Use this filter to to search for documents that fall within the specified dates. The
Effect Date Range filter can be used for downloads,removals, and reporting.
Two attributes, EffectiveDateFrom and EffectiveDateTo will let you specify a
range of dates to be matched. The document filtering mechanism in ILIA will use
the two fields when comparing the exchange documents. All documents whose
EffectiveDate falls within the specified range will be included in the document list.
This input file will download all documents whose EffectiveDate is between Jan
1st, 2011 and April 1st, 2011.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="MM/dd/yyyy"
xsi:noNamespaceSchemaLocation="file:///Z:/ILIA/
Schemas/CSAInputXMLSchema.xsd">
Intralinks Integration Adapter User Guide
page 59
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Download">
<Workspace Id="651041">
<DocumentCriteria EffectiveDateFrom="1/1/2011"
EffectiveDateTo="4/1/2011"/>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Removing folders, subfolders and documents
The chart below provides methods you can use for various removal scenarios.
Several XML examples follow.
Intralinks Integration Adapter User Guide
page 60
Removal scenarios
Condition
Desired result
Input XML and remarks
1
Folder is empty
Remove folder
Remove command with folder name.
2
Folder has a document
plus a subfolders.
Remove folder,
documents, and
subfolders.
Remove command with folder name.
All documents and subfolders will be
removed.
3
Folder has three
documents
Remove documents
Remove command with document names.
Documents are removed, folder remains.
4
Folder has three
documents
Remove documents
and folder
Remove command with folder name.
Folder and documents are removed.
5
Folder has two
documents
Remove one of the
documents
Remove command with folder name and
document name. Folder and other
documents remain.
6
Folder with empty
subfolder
Remove subfolder
Remove command with subfolder name.
Subfolder is removed.
7
Folder and subfolder
with document.
Remove subfolder and
document within it.
Remove command with subfolder name
Folder is left, subfolder and document are
removed.
8
Folder has document
plus subfolder.
Subfolder has
document.
Remove document in
subfolder.
Remove command with subfolder name and
document name. Document is removed but
subfolder remains.
9
Folder has document
plus subfolder.
Subfolder has
document.
Remove subfolder and
its document.
Remove command with subfolder name.
Subfolder and its document are removed.
10
Folder has document
plus subfolder.
Subfolder has two
documents
Remove one document
from subfolder
Remove command with subfolder name and
document name. Document is removed from
subfolder. Other document remains in
subfolder.
11
Folder is empty
Remove folder
Remove command with folder ID. Folder is
removed.
12
Folder has two
documents and
subfolder
Remove folder,
documents and
subfolder
Remove command with folder ID. Folder,
documents, and subfolders are removed.
13
Folder has one
document.
Remove folder and
document.
Remove command with folder ID. Folder,
and document are removed.
14
Folder has two
documents
Remove folder and
documens
Remove command with folder ID. Folder,
and documents are removed.
15
Folder has two
documents
Remove documents,
leave folder
Remove command with folder ID and set
ContentsOnly=true.
Documents are removed, folder remains.
16
Folder has two
documents
Remove one document
Remove command with document ID.
Document removed. Other document and
folder remain.
Intralinks Integration Adapter User Guide
page 61
Remove documents and folders
This example will remove documents and folders from an exchange.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Remove">
<Workspace Id="1234567">
<Folders>
<Folder Name=" Root Folder 1">
<Documents>
<Document Name="EIS2.2Document.png" />
</Documents>
</Folder>
<Folder Name="Root Folder 2\Sub Folder">
</Folder>
<Folder Name="Root Folder 3" />
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Remove documents and leave folder
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Remove">
<Workspace Id="1265631">
<DocumentCriteria>
<FolderList Id="12345678"
ContentsOnly="true"/>
<FolderList Id="11122233" ContentsOnly="true"/>
</DocumentCriteria>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Remove a list of documents and folders by ID
This example will remove a list of documents and folders by Id. Note that folder
"55556660" will not be removed, but its contents (documents and subfolders) will
be removed.
<?xml version="1.0" encoding="utf-8"?>
Intralinks Integration Adapter User Guide
page 62
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Remove">
<Workspace Id="1234567">
<DocumentCriteria>
<FolderList Id="55556660" ContentsOnly="true"
/>
<FolderList Id="55556661" />
<FolderList Id="55556662" />
<FolderList Id="55556663" />
<DocumentList Id="1234567890" />
<DocumentList Id="1234567891" />
<DocumentList Id="1234567892" />
<DocumentList Id="1234567893" />
</DocumentCriteria>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Remove a list of documents by specified criteria
This example will remove PDF documents created by user jsmith@acme.com
between January 1, 2010 and June 30, 2010.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="MM/dd/yyyy">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Remove">
<Workspace Id="1234567">
<DocumentCriteria CreateDateFrom="01/01/2010"
CreateDateTo="06/30/2010" Creator="John Smith"
MIMEType="application/pdf" />
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Permissions
ILIA allows you to set permissions for all the documents in one or more folders.
You can set or change permissions for all the documents in a folder—or for the
documents in multiple folders—at the same time. This is referred to as bulk
permissioning.
Intralinks Integration Adapter User Guide
page 63
Intralinks exchanges can be administered to remember or not remember your
permissioning settings for documents and folders. You cannot use ILIA to change
the exchange setting that governs permissioning; this setting can be changed only
by an Intralinks administrator.
•
If your target exchange is set to remember permissioning selections for
documents and subfolders, your selections will be applied to the
documents and subfolders within the folder at the time of permissioning.
When you set permissions in this way, documents are permissioned
when they are added to the folder.
– Permissions will be assigned automatically to documents and
subfolders added to the folder later.
– You can override these default permissions for individual documents or
subfolders if you like.
– If you move documents or subfolders from one permissioned folder to
another, the permissions are changed automatically. (Any changes you
made to the default permissions are remembered when the items are
moved.)
– You can apply permissions to both the folder and document. Both will
be applied and document permissions will be marked as overrides to
the folder permissions.
– If permissions are already assigned to any folders/documents within
the folder, you have the option to overwrite these permissions with the
new ones or to merge the new permissions with the existing ones.
•
If your target exchange is not set to remember permissioning selections
for documents and subfolders, your selections are applied to whatever
documents are located in the folder at the time of permissioning.
– If you add more documents to a folder after you have set permissions,
they will not be assigned the permissions.
– If you move a folder that has been assigned permissions, it will retain
these permissions.
– You can either assign permissions to each document that needs to be
uploaded or permission the folder they’re in, but not both.
You can use one method of permissioning or the other, but not both at the same
time.
Set permissions for a folder
To set permissions for all documents in a folder:
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="100">
<Job Id="2" OperationType="Create">
<Workspace Id="647645">
<Folders>
Intralinks Integration Adapter User Guide
page 64
<Folder Name="My Root Folder Test A">
<Permissions>
<Permission GroupName="EIS Group"
Control="true" Protection="Protect" />
</Permissions>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Replace permissions for a folder
ILIA provides an option to append or replace existing permissions with newly
assigned ones. This example will replace the current permissions on a folder. if
the replace attribute is not mentioned, or mentioned as false, the new permissions
will be merged with all the existing permissions.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIA@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="1253631">
<Folders>
<Folder Name="Folder 01">
<Permissions Replace="true">
<Permission GroupName="P_3Ally" Control="true"/
>
</Permissions>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Set permissions for a document
<?xml version="1.0" encoding="UTF-8" ?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@test.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="278891">
Intralinks Integration Adapter User Guide
page 65
<Folders>
<Folder Name="Folder Test">
<Documents>
<Document Name="Doc1.doc"
LocalPath="\\TestServer\ILIADocs\Doc1.doc">
<Permissions>
<Permission Protection="ProtectNoPrint"
See="true" GroupName="User Team"/>
<Permission Protection="NoProtect" Control="true"
See="true" GroupName="Admin Team"/>
</Permissions>
</Document>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Replace permissions for a document
ILIA provides an option to append or replace existing permissions with newly
assigned ones.This example will replace the current permissions assigned to a
document.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIA @intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="1253631">
<Folders>
<Folder Name="Folder 01">
<Documents>
<Document Name="Doc2.pdf"
LocalPath="C:\temp\Doc2.pdf">
<CustomFields>
<CustomField Label="Document Type"
Value="Adverse Drug Report">
<CustomField Label="ADE Type" Value="Serious
Adverse Event"/>
</CustomField>
</CustomFields>
<Permissions Replace="true">
<Permission GroupName="Grp1" Control="true"
Protection="ProtectNoPrint"/>
</Permissions>
</Document>
Intralinks Integration Adapter User Guide
page 66
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Permission documents to the All Users group
The All Users Group is a special system group that aggregates all users currently
on the exchange. If you permission a document to the All Users group, the
permissions will be applied to all users on the exchange in addition to any users
who are added to the exchange later. Note that you can only apply “See
Permissions.”
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="user@yourcompany.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1138881">
<Folders>
<Folder Name="Folder Test">
<Documents>
<Document Name="Variable length op2"
LocalPath="C:\2.8 Most settings
enabled_1397421\Variable length op2.pdf">
<Permissions>
<Permission See="true" GroupName="All
Users - Current and Future" />
</Permissions>
<CustomFields>
<CustomField Label="Amount" Value="99"
/>
</CustomFields>
</Document>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Groups and users
•
The Global User Directory (GUD) is the master directory of all users and
members of Intralinks exchanges.
Intralinks Integration Adapter User Guide
page 67
•
The profile information for each person in the GUD is controlled by that
person and in most situations, only that person can make changes to their
own profile information.
•
When adding a person to an Intralinks exchange, you need to define five
primary fields – First Name, Last Name, Email Address, Phone,
Organization. You should also set the user’s role in the exchange he/she
is being added to. For new users, other optional profile information can be
defined.
– If a person is new to Intralinks, his/her initial Intralinks account will be
created using this information.
– For people who are already in the GUD, their existing profile
information will remain unchanged.
– The user will be added to the exchange with his/her assigned role. If no
role is specified in the XML Input file for the user, a default role will be
assigned following the setting in the ILIA Configuration Manager.
•
There are a number of optional profile information fields that users can
define for themselves.
•
A User Difference report is included in the output file when you add
people to an exchange.
– It can be used to see the difference between what users have defined
for the profile information fields versus what your internal systems have
provided.
Synchronize users in an exchange
The synchronize operation is used to ensure that users on Intralinks exchanges
match the users in your organization’s back-end system. Documents, groups,
reports, and folders are not synchronized.
The synchronization process is unidirectional; from your system of record to
Intralinks exchanges. Users are added or removed, or existing user data is
updated. User information includes:
•
Email address
•
First name
•
Last name
•
Organization
•
Phone number
The following table explains the interaction between the synchronization process
and ILIA configuration settings.
ILIA Configuration Settings
User Needs to be Added
User Needs to be Removed
Role Exclusion List is defined
User will be added
Protected user will not be removed
Domain Exclusion List is
defined
User will be added
Protected user will not be removed
Intralinks Integration Adapter User Guide
page 68
ILIA Configuration Settings
User Needs to be Added
User Needs to be Removed
Remove user protection period
defined
User will be added
Protected user will not be removed
Create Groups on
User will be added.
User will be removed
If the group already exists,
a new one will not be
created. If the group is
missing, it will be created in
the exchange.
Create Groups off
User will be added. Group
will not be created.
User will be removed
Protection period for addition
of users is enabled
Removed user may or may
not be added depending on
the protection period.
User will be removed
Protection period for addition
of users is disabled
Removed user will be
added
User will be removed
Remove Empty Groups on
User will be added.
User will be removed.
Any preexisting empty
groups will not be removed.
Empty group that the user belongs to will
be removed as a result of user removal.
Pre-existing empty groups will not be
removed.
User will be added. Groups
will not be removed.
User will be removed.
Remove Empty Groups off
Empty group that the user belonged to
will not be removed as a result of user
removal. The synchronization operation
will only affect users.
The following table explains the interaction between the synchronization process
and synchronization-related XML file content.
ILIA XML Settings
User Needs to be Added
User Needs to be Removed
Only users are mentioned at
the exchange level.
User will be added, unless the
user was previously removed
and the protection period for readdition of removed users is set
to that user..
User removed, unless protected.
Empty groups are not removed.
Only groups are mentioned
Intralinks Integration Adapter User Guide
Groups that become empty are not
removed, unless the “Remove
Empty Groups” is on. Then, the
groups that become empty will be
removed.
Groups will be reconciled together
with group members and users will
be removed from the exchange
based on the Configuration Manager
setting regardings users who remain
without a group.
page 69
ILIA XML Settings
User Needs to be Added
User Needs to be Removed
All the users are mentioned in
the context of groups
Users will be added based on
the Configuration Manager
setting regarding re-addition of
previously removed users. Only
groups that match the defined
criteria will be reconciled.
Users will be removed.
Some users are mentioned in
the context of group and some
are mentioned at the exchange
level.
The operation will be rejected
and an error message will be
generated.
The operation will be rejected and an
error message will be generated.
Synchronizing users in an exchange
This example will add/update three users in the exchange. All other users
currently in the exchange will be removed.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Synchronize">
<Workspace Id="777871" Name="Smoke_B2_WS1">
<Users>
<User EMailId="testuser1@e-trial.com"
FirstName="Arc" LastName="User1" Org="Test" Phone="555
123-4567" Role="Manager+" />
<User EMailId="testuser2@e-trial.com"
FirstName="Arc" LastName="User2" Org="Test" Phone="555
123-4321" Role="Manager" />
<User EMailId="testuser3@e-trial.com"
FirstName="Arc" LastName="User3" Org="Test" Phone="555
123-1234" Role="Reviewer" />
</Users>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Synchronize groups and users in an exchange
This process will synchronize both groups and users to your system of record. Be
aware that the rules specified in the ILIA Configuration Manager under Group
Processing Options wil be applied, when applicable, during this process.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="swati_mahadevpur@mindtree.com" />
<batch Id="1001">
Intralinks Integration Adapter User Guide
page 70
<Job Id="1" OperationType="Synchronize">
<Workspace Id="996952">
<Groups>
<Group Name="Sc7" FTSEnable="false"
DefaultFolder="Folder1">
<CustomFields>
<CustomField Label="Allow this Group to
run advanced reports" Value="Yes" />
<CustomField Label="Group Category"
Value="IRB / EC">
<CustomField Label="Type of IRB / EC"
Value="Local" />
<CustomField Label="Communication
Method" Value="Fax" />
</CustomField>
</CustomFields>
<Note>Synchronizing existing group</Note>
</Group>
<Group Name="Sc34_1" FTSEnable="true"
DefaultFolder="Folder4">
<CustomFields>
<CustomField Label="Allow this Group to
run advanced reports" Value="Yes" />
<CustomField Label="Group Category"
Value="IRB / EC">
<CustomField Label="Type of IRB / EC"
Value="Local" />
<CustomField Label="Communication
Method" Value="Fax" />
</CustomField>
</CustomFields>
<Note>Synchronizing new group with users</
Note>
<Users>
<User EMailId="User1@e-trial.com"
FirstName="ILIA" LastName="User1" Org="Test"
Phone="555 123-1234" Role="Manager" />
<User EMailId="User2@e-trial.com"
FirstName="ILIA" LastName="User2" Org="Test"
Phone="555 123-1234" Role="Manager+" />
<User EMailId="User3@e-trial.com"
FirstName="ILIA" LastName="User3" Org="Test"
Phone="555 123-1234" Role="Manager+" />
</Users>
</Group>
<Group Name="Sc34_3" Type="Collaboration"
FTSEnable="true" DefaultFolder="Folder4">
<CustomFields>
<CustomField Label="Allow this Group to
run advanced reports" Value="Yes" />
<CustomField Label="Group Category"
Value="IRB / EC">
<CustomField Label="Type of IRB / EC"
Value="Local" />
Intralinks Integration Adapter User Guide
page 71
<CustomField Label="Communication
Method" Value="Fax" />
</CustomField>
</CustomFields>
<Note>Synchronizing new group with users</
Note>
<Users>
<User EMailId="User7@e-trial.com"
FirstName="ILIA" LastName="User1" Org="Test"
Phone="555 123-1234" Role="Manager" />
<User EMailId="User8@e-trial.com"
FirstName="ILIA" LastName="User2" Org="Test"
Phone="555 123-1234" Role="Manager+" />
<User EMailId="User9@e-trial.com"
FirstName="ILIA" LastName="User3" Org="Test"
Phone="555 123-1234" Role="Manager+" />
</Users>
</Group>
<Group Name="Sc37_1" FTSEnable="true"
DefaultFolder="Folder4">
<CustomFields>
<CustomField Label="Allow this Group to
run advanced reports" Value="Yes" />
<CustomField Label="Group Category"
Value="IRB / EC">
<CustomField Label="Type of IRB / EC"
Value="Local" />
<CustomField Label="Communication
Method" Value="Fax" />
</CustomField>
</CustomFields>
<Note>Synchronizing new group with users</
Note>
<Users>
<User EMailId="User1@e-trial.com"
FirstName="ILIA" LastName="User1" Org="Test"
Phone="555 123-1234" Role="Manager" City="Boston"
State="MA" Zip="01234" Country="UNITED_STATES"
Mobile="155567777" Title="BOARD_MEMBER"
Industry="FINANCIAL_SERVICES" Address1="1 Main St"
Address2="PO Box 12345" TimeZone="GMT" Fax="1234" />
<User EMailId="User2@e-trial.com"
FirstName="ILIA" LastName="User2" Org="Test"
Phone="555 123-1234" Role="Manager+" City="Boston"
State="MA" Zip="01234" Country="UNITED_STATES"
Mobile="155567777" Title="BOARD_MEMBER"
Industry="FINANCIAL_SERVICES" Address1="1 Main St"
Address2="PO Box 12345" TimeZone="GMT" Fax="1234" />
<User EMailId="User3@e-trial.com"
FirstName="ILIA" LastName="User3" Org="Test"
Phone="555 123-1234" Role="Manager+" City="Boston"
State="MA" Zip="01234" Country="UNITED_STATES"
Mobile="155567777" Title="BOARD_MEMBER"
Industry="FINANCIAL_SERVICES" Address1="1 Main St"
Address2="PO Box 12345" TimeZone="GMT" Fax="1234" />
Intralinks Integration Adapter User Guide
page 72
</Users>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Update user roles on an exchange
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="178621">
<Users>
<User EMailId="ILIAUser@intralinks.com"
FirstName="ILIA" LastName="User" Org="Dev"
Phone="4343526729" Role="Manager" City="Boston"
State="MA" />
<User EMailId="tuser3@test.com"
FirstName="Test" LastName="User3" Org="Intralinks"
Phone="21311234" Role="Reviewer" Title="ASSOCIATE"
City="Paris" Country="FRANCE" />
<User EMailId="tuser4@test.com"
FirstName="Test" LastName="User4" Org="Dev"
Phone="21311235" Role="Reviewer" City="Boston" />
<User EMailId="tuser88@test.com"
FirstName="Test" LastName="User88" Org="Test Org"
Phone="5554443333" Role="Reviewer" City="San Juan"
Country="UNITED_STATES" Address1="1 Main St." />
<User EMailId="tuser89@test.com"
FirstName="Test" LastName="User89" Org="Intralinks"
Phone="5555556666" Role="Previewer" City="London"
Country="UNITED_KINGDOM" Address1="1 Elm St." />
</Users>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Set member roles of new users
Group member roles are supported for identifying the role of a user in a group (for
example, “Senior Auditor”). Group member roles are tags that are useful for
managing or reporting on exchange users. Group member roles can be added,
changed, or removed within the context of a group.
This example will create three new users and set their group member roles. Note
that if users are specified at the exchange level, the member roles will be ignored.
Intralinks Integration Adapter User Guide
page 73
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="188831" Name="Test Workspace">
<Groups>
<Group Name="FL Team">
<Users>
<User EMailId="testuser01@e-trial.com"
FirstName="Test" LastName="User_01" Org="BSIL"
Phone="7776665501" Role="Reviewer+">
<MemberRoles>
<MemberRole Role="Sub Investigator"/>
</MemberRoles>
</User>
<User EMailId="testuser02@e-trial.com"
FirstName="Test" LastName="User_02" Org="BSIL"
Phone="7776665502" Role="Manager+">
<MemberRoles>
<MemberRole Role="Contacts Manager"/>
<MemberRole Role="Principal Investigator"/>
<MemberRole Role="Req Docs Manager"/>
<MemberRole Role="Site Coordinator"/>
<MemberRole Role="Sub Investigator"/>
</MemberRoles>
</User>
<User EMailId="testuser03@e-trial.com"
FirstName="Test" LastName="User_03" Org="BSIL"
Phone="7776665503" Role="Publisher">
<MemberRoles>
<MemberRole Role="Contacts Manager"/>
<MemberRole Role="Req Docs Manager"/>
</MemberRoles>
</User>
</Users>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Set member roles of existing users
Group member roles are supported for identifying the role of a user in a group (for
example, “Senior Auditor”). Group member roles are tags that are useful for
managing or reporting on exchange users. Group member roles can be added,
changed, or removed within the context of a group.
Intralinks Integration Adapter User Guide
page 74
This example will change the member roles of existing users. Note that the
second user in the sample will remove all the member user roles.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="188831" Name="Test Workspace">
<Groups>
<Group Name="FL Team">
<Users>
<User EMailId="testuser01@e-trial.com"
FirstName="Test" LastName="User_01" Org="BSIL"
Phone="7776665501" Role="Reviewer+">
<MemberRoles>
<MemberRole Role="Principal
Investigator"/>
<MemberRole Role="Sub Investigator"/>
</MemberRoles>
</User>
<User EMailId="testuser02@e-trial.com"
FirstName="Test" LastName="User_02" Org="BSIL"
Phone="7776665502" Role="Manager+">
<MemberRoles/>
</User>
</Users>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Add groups and users to an exchange
This file creates two groups and adds a user to both groups.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1234567" Name="Test Workspace">
<Groups>
<Group Name="P_1">
<Users>
<User EMailId="test_1@intralinks.com"
FirstName="EIS_test1" LastName="testser_1"
Intralinks Integration Adapter User Guide
page 75
Phone="6171111111" Org="IntraLinks" Role="Publisher" /
>
</Users>
</Group>
<Group Name="P_2">
<Users>
<User EMailId="Test_2@intralinks.com"
FirstName="EIS_test_2" LastName="testuser_2"
Phone="6171111111" Org="IntraLinks" Role="Publisher" /
>
</Users>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Remove a user from an exchange
•
Note that the Group element is not required if you are removing a user
from an exchange. The user will be removed from all groups and the
exchange.
•
Include the Group element if you wish to remove the user from a specific
group, but not from the exchange.
•
Removal is based on the user’s email address.
•
The Workspace Name is not mandatory. ILIA uses the Workspace Id to
identify an exchange.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="user@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Remove">
<Workspace Id="144631">
<Users>
<User EMailId="user.1243@gmail.com"
FirstName="John" LastName="Smith" Org="IntraLinks"
Phone="14354444442" Role="Publisher" City="" State=""
/>
</Users>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Intralinks Integration Adapter User Guide
page 76
Remove all group members from an exchange
If you want to remove all group members from an exchange without specifying the
users, you can use the RemoveMembersFromExchange attribute for the targeted
group and set it to “true”.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="user@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Remove">
<Workspace Id="1075181">
<Groups>
<Group Name="Grp 1"
RemoveMembersFromExchange="true"/>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Remove two users from two different groups
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="100">
<Job Id="1" OperationType="Remove">
<Workspace Id="1234567" Name="ARC_Tags_Testing">
<Groups>
<Group Name="Group1">
<Users>
<User EMailId="joemanager@trial.com"
FirstName="Joe" LastName="Manager" Org="Acme"
Phone="5556667777" Role="Manager_Plus" />
</Users>
</Group>
<Group Name="Group2">
<Users>
<User EMailId="joereviewer@trial.com"
FirstName="Joe" LastName="Reviewer" Org="Acme"
Phone="5556667778" Role="Reviewer" />
</Users>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Intralinks Integration Adapter User Guide
page 77
Sending custom remove alerts for deleted users
You can send a customized note to users who have been removed from an
exchange by the removal or synchronization operation. This note is included in
the alert email and can be used to specify the reason for removal. Only one note
can be created for each exchange.
In order for this feature to work, the exchange in question must be set to send
alerts on removal. Send alert on removal can only be set by an Intralinks system
administrator.
This example will send a custom remove alert to all users that are removed from
an exchange. Note: Remove alerts will only be sent if the Remove Alert option is
enabled on the exchange.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Synchronize">
<Workspace Id="777871" Name="Smoke_B2_WS1">
<Users>
<User EMailId="testuser1@e-trial.com"
FirstName="Arc" LastName="User1" Org="Test" Phone="555
123-4567" Role="Manager+" />
<User EMailId="testuser2@e-trial.com"
FirstName="Arc" LastName="User2" Org="Test" Phone="555
123-4321" Role="Manager" />
<User EMailId="testuser3@e-trial.com"
FirstName="Arc" LastName="User3" Org="Test" Phone="555
123-1234" Role="Reviewer" />
</Users>
<RemoveUserNote>You have been removed by
ILIA.</RemoveUserNote>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Suppress the “Welcome to the Exchange” alert for new users
This example shows how prevent the "Welcome to the Exchange" alert from being
sent to new users.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
Intralinks Integration Adapter User Guide
page 78
<Job Id="1" OperationType="Create">
<Workspace Id="881865" AddUserProtectPeriod="10">
<Users>
<User EMailId="testuser01@e-trial.com"
FirstName="Test" LastName="User_01" Org="BSIL"
Phone="7776665501" Role="Reviewer+"
SupressWelcomeAlert="true"/>
</Users>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Create multiple groups
This file creates two groups using one Group element and adds the same user to
both. The group names are separated using the back slash ( ‘\’ ).
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1234567" Name="ARC_Tags_Testing">
<Groups>
<Group Name="Group3\Group4">
<Users>
<User EMailId="joereviewer@trial.com"
FirstName="Joe" LastName="Reviewer" Org="Acme"
Phone="5556667778" Role="Reviewer" />
</Users>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Remove groups from an exchange
ILIA allows you to remove empty and non-empty groups from an exchange.
•
To remove groups, specify the group name you wish to remove in the
XML input file.
– ILIA will not attempt to remove groups after a download, create,
update, or synchronize operation.
– If your input file removes all members from a group, the group may or
may not be removed depending on your setting for the Remove
Intralinks Integration Adapter User Guide
page 79
groups if all members have been removed option in the
Configuration Manager.
This input file will remove a group from an exchange. Users who were members of
the group will no longer be associated with the group but will remain on the
exchange.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Remove">
<Workspace Id="1075181">
<Groups>
<Group Name="Grp 1"/>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
This input file will remove a group and its members from an exchange.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Remove">
<Workspace Id="1075181">
<Groups>
<Group Name="Grp 1"
RemoveMembersFromExchange="true"/>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
This input file will remove all groups whose name begins with "Test" and groups
whose Group Category is "Clinical Research Site".
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Remove">
<Workspace Id="1075181">
<GroupUserCriteria>
<GroupList>
<GroupFilter GroupName="Test"/>
Intralinks Integration Adapter User Guide
page 80
<CustomFields>
<CustomField Label="Name" Value="Clinical
Research Site"/>
</CustomFields>
</GroupList>
</GroupUserCriteria>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Change default folder for groups on create or update
You can set or change the default folder for specified groups when performing a
Create or Update operation. On an update, the default folder can be changed or
cleared.
This input file will create a new group and set the default folder.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1075181" Name="Test Workspace">
<Groups>
<Group Name="New Group" Type="Collaboration"
DefaultFolder="Folder 200"/>
<Group Name="Test Group"
DefaultFolder="Folder 300"/>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Updating group metadata
The following metadata can be updated for groups on an exchange:
•
Name
•
Allowing full text search
•
Note
This input file will create a new group and set the note and full text search
capability.
<?xml version="1.0" encoding="UTF-8"?>
Intralinks Integration Adapter User Guide
page 81
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1075181">
<Groups>
<Group Name="Grp 1" FTSEnable="true">
<Note>This is a group note test.</Note>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
This input file will rename an existing group.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="1075181">
<Groups>
<Group Name="Grp 1" NewName=”Grp 2”/>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Custom fields
•
The Intralinks Platform lets you create, populate, and publish custom
fields for documents, groups and exchanges. Custom fields allow users to
describe these elements in greater detail. They can be used to enter
specific pieces of information, such as expiration dates, internal tracking
numbers, and the like.
•
The labels assigned to custom fields are predefined for each exchange.
They cannot be changed using ILIA. However, the values associated with
these labels can be set using ILIA (see below).
•
Once a set of custom fields is defined, some or all of them can be
assigned, as needed, to individual exchanges. These assignments can
be turned on or off using ILIA (see below).
•
Custom fields need to be published to be visible to users on an exchange.
ILIA can be used to publish custom fields when creating new exchanges
or for existing exchanges.
Intralinks Integration Adapter User Guide
page 82
•
Once published, custom field values can be changed using ILIA.
Assign values to exchange custom fields
The labels defined in the custom fields must match labels defined in the field
definitions in the exchange.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAuser@intralinks.com" />
<batch Id="100">
<Job Id="2" OperationType="Create">
<Workspace Id="647645">
<CustomFields>
<CustomField Label="Field1" Value="Test" />
<CustomField Label="Field2" Value="12345" />
</CustomFields>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Update values to exchange custom fields
This example shows how to change the value for an existing exchange-level
custom field.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="user@intralinks.com" />
<batch Id="6R9379HI">
<Job Id="adhoc" OperationType="Update">
<Workspace Id="1243581" Name="ILIA test">
<CustomFields>
<CustomField Label="Project" Value="Alpha KT302" />
<CustomField Label="Status" Value="Analysis"
/>
</CustomFields>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Assign values to group custom fields
The labels defined in the custom fields must match labels defined in the field
definitions in the exchange.
<?xml version="1.0" encoding="utf-8"?>
Intralinks Integration Adapter User Guide
page 83
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId=" ILIAUser @intralinks.com" />
<batch Id="100">
<Job Id="2" OperationType="Create">
<Workspace Id="647645">
<Groups>
<Group Name="TestGroup">
<CustomFields>
<CustomField Label="Allow this group to
run advanced reports" Value="Yes">
<CustomField Label="Group Category"
Value="IRC / EC" />
<CustomField Label="Type of IRC / EC"
Value="Central" />
<CustomField Label="Communication
Method" Value="eMail" />
</CustomField>
</CustomFields>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Change custom fields of an existing document
This example moves a document and changes its effective date and changes the
custom fields on a second document.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="MM/dd/yyyy"
xsi:noNamespaceSchemaLocation="file:///C:/IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="1265631">
<Folders>
<Folder Name="Folder Test 100">
<Documents>
<Document Name="Doc1.doc" TargetFolder="Folder
Test 300" EffectiveDate="11/17/2010"/>
<Document Name="Doc2.pdf">
<CustomFields>
<CustomField Label="Document Type"
Value="Adverse Drug Report">
<CustomField Label="Adverse Event"
Value="Adverse Event"/>
Intralinks Integration Adapter User Guide
page 84
</CustomField>
</CustomFields>
</Document>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Enable/disable custom fields when creating an exchange
You can enable/disable custom fields when you create a new exchange.The
labels defined in the ConfigCustomFields must match labels defined in the field
definitions in the exchange.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="100">
<Job Id="2" OperationType="Create">
<Workspace Name="TestCreate3" Template="105401"
Host="IL Testing" Description="This is a test
exchange" Create="true">
<ConfigCustomFields>
<ConfigCustomField Label="Document Type"
Type="Document">
<ConfigCustomField Label="Additional CCF
#1" Type="Document" Parent="Document Template"
Enable="true" />
</ConfigCustomField>
<ConfigCustomField Label="Group Category"
Type="Group">
<ConfigCustomField Label="Country/Region"
Type="Group" Parent="IRB / EC" Enable="false" />
</ConfigCustomField>
</ConfigCustomFields>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Update the availability of custom fields at the exchange and
group levels and then publish them
This example shows how to update exchange-level and group-level custom fields,
some enabled, some disabled, and how to publish the whole set.
<?xml version="1.0" encoding="utf-8"?>
Intralinks Integration Adapter User Guide
page 85
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="user@intralinks.com" />
<batch Id="6R9379HI">
<Job Id="adhoc" OperationType="Update">
<Workspace Id="1243581" Name="ILIA test"
PublishFields="true">
<ConfigCustomFields>
<ConfigCustomField Label="Project"
Type="Exchange" Enable="true">
<ConfigCustomField Label="Phase"
Type="Exchange" Enable="false" />
</ConfigCustomField>
<ConfigCustomField Label="Location"
Type="Group" Enable="true"></ConfigCustomField>
</ConfigCustomFields>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Reports
Report User IDs
All the ILIA reports listed below generate a unique identifier for each user that can
be entered in the XML Input file to find the user on the Intralinks Platform when it
is not feasible to use an email address.
•
For example, if a user is permissioned to a document and then changes
his email address, you can enter the user’s unique identifier to find the
user, without specifying an email address.
Access report
An Access report provides information about access to documents by users and
groups, including alert information. Report criteria is specified by the user (for
example, “all documents in Folder A”).
You can use filter criteria to report only on targeted documents/users/groups.
One Access report will be created for each targeted document. Access reports will
be stored inside the destination folder specified in the Input XML file in the
following manner:
(Destination folder) / (Exchange ID) (Exchange name) / 'Access Reports'
(Date)(Time) / (Document ID) (Document name).XML
Access reports for an exchange
This example will create Access reports for all the documents that exist on the
exchange.
<?xml version="1.0" encoding="utf-8"?>
Intralinks Integration Adapter User Guide
page 86
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Download"
DownloadReportType="DocumentAccess"
DownloadReportPath="C:\Temp\DocumentAccessReports">
<Workspace Id="881865"/>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Access report using a group filter
This example shows how to create an Access report for an exchange and include
only the access data for the specified groups.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Download"
DownloadReportType="DocumentAccess"
DownloadReportPath="C:\Temp\DocumentAccessReports">
<Workspace Id="881865">
<GroupUserCriteria>
<GroupList>
<GroupFilter GroupName="group 1"/>
<GroupFilter GroupName ="group 2"/>
<GroupFilter GroupId="1234567"/>
</GroupList>
</GroupUserCriteria>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Access report using a group custom field filter
This example shows how to create an Access report for an exchange and include
only the access data for groups with matching custom fields label/value pairs.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
Intralinks Integration Adapter User Guide
page 87
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Download"
DownloadReportType="DocumentAccess"
DownloadReportPath="C:\Temp\DocumentAccessReports">
<Workspace Id="881865">
<GroupUserCriteria>
<GroupList>
<CustomFields>
<CustomField Label="Group Category"
Value="Clinical Research Site">
<CustomField Label="Type of Research
Site" Value="Research Center"/>
</CustomField>
</CustomFields>
</GroupList>
</GroupUserCriteria>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Access report using a user filter
This example show how to create an Access report for an exchange and include
only the access data for the specified users.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Download"
DownloadReportType="DocumentAccess"
DownloadReportPath="C:\Temp\DocumentAccessReports">
<Workspace Id="881865">
<GroupUserCriteria>
<UserList>
<UserFilter UserName="Joe Smith"/>
<UserFilter UserEMailId="testuser@etrial.com"/>
<UserFilter UserEMailId="user001@etrial.com"/>
</UserList>
</GroupUserCriteria>
</Workspace>
</Job>
</batch>
Intralinks Integration Adapter User Guide
page 88
</ExecuteData>
Return to Sample XML files index.
Document-centric report
The Document-centric report is an XML file showing the contents of requested ILP
exchanges as well as their hierarchies.
You can use filter criteria to report only on targeted documents.
The following information is returned:
Exchange-level details:
•
Exchange Name
•
Exchange ID
•
Exchange host
•
Exchange phase
•
Organization that the exchange belongs to
•
Exchange Custom Fields
Folder-level details:
•
Full folder path
•
Folder ID
•
Folder index
•
Sort order
•
ILP folder permissions
– Groups with See/Control permissions/rights to add documents
– Implicit and explicit folder permissions per group
– Implicit and explicit protections per group
– Implicit and explicit document creation rights per group
Document/Attachment level details:
•
Document name
•
Mime type
•
Document ID
•
Attachment name
•
Document index
•
Document sort order
•
Document note
Intralinks Integration Adapter User Guide
page 89
•
Document metadata (size, last accessed, creator, effective date, owner
etc.)
•
Document custom fields
Document permissions details:
•
Permissioned groups or users:
– Group name
– Group ID
– Group type
– Group permissions
– Document protection (None, Protect, Protect and Prevent Print)
– Group custom Fields
– User first and last names
– User ID
– User permission
– User attributes (email address, phone number, organization, primary
contact indication)
•
Non-permissioned groups or users:
– Group name
– Group ID
– Group type
– Group custom Fields
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xsi:noNamespaceSchemaLocation="file:///
C:/IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd" xmlns:xsi="http://www.w3.org/
2001/XMLSchema-instance">
<Identity UserId="ILIA-UserId@intralinks.com"/>
<batch Id="2010-11-15 13:44:14Z">
<Job Id="1" OperationType="Download"
DownloadReportType = "DocumentCentric"
DownloadReportPath="C:\IL-IA Reports\report.xml" >
<Workspace Id="831372">
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
User-centric report
The User-centric report provides filterable information about:
Intralinks Integration Adapter User Guide
page 90
•
Exchanges (names, ID, phase, etc.)
•
Groups (names, custom fields, etc.)
•
Users (names, address, phone numbers, title, etc.)
•
Removed users (names, address, phone numbers, title, etc.)
The report will support the existing filter criteria to filter the report data by users
and groups. The existing "DownloadAllExchanges" can be used to create reports
for all exchanges the user has access to.
The DownloadReportPath attribute in the Workspace element can be used to set
the top-level folder where the User-centric reports will be saved. One report is
produced for each exchange that is found.
The report files will be saved in the following structure:
DownloadReportPath\User Centric Reports {datetime}\{Exchange Id Exchange
Name}.xml
This input file will create a User-centric report for all users in an exchange.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xsi:noNamespaceSchemaLocation="file:///
C:/IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd" xmlns:xsi="http://www.w3.org/
2001/XMLSchema-instance">
IntraLinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Download"
DownloadReportType="UserCentric"
DownloadReportPath="C:\Temp\UserCentricReports">
<Workspace Id="1075181">
</Workspace>
</Job>
</batch>
</ExecuteData>
This input file will create a User-centric report for a specific user in an exchange.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xsi:noNamespaceSchemaLocation="file:///
C:/IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd" xmlns:xsi="http://www.w3.org/
2001/XMLSchema-instance">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Download"
DownloadReportType="UserCentric"
DownloadReportPath="C:\Temp\UserCentricReports">
<Workspace Id="1075181">
<GroupUserCriteria>
<UserList>
Intralinks Integration Adapter User Guide
page 91
<UserFilter
UserEMailId="testuser@intralinks.com"/>
</UserList>
</GroupUserCriteria>
</Workspace>
</Job>
</batch>
</ExecuteData></ExecuteData>
This input file will create a User-centric report for all exchanges the user has
access to.
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xsi:noNamespaceSchemaLocation="file:///
C:/IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd" xmlns:xsi="http://www.w3.org/
2001/XMLSchema-instance">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Download"
DownloadReportType="UserCentric"
DownloadReportPath="C:\Temp\UserCentricReports"
DownloadAllWorkspaces="true"/>
</batch>
</ExecuteData>
Return to Sample XML files index.
User Comparison report
The User Comparison report compares user profile information in an Intralinks
exchange to user profile information stored on a back-end system. It reports all
differences in profile details (name, phone number, etc.) and also indicates
whether the user:
•
could be found.
•
was removed from the exchange.
•
was assigned a new email address.
•
was on the alias list (users who had more than one profile and these
profiles were merged by the system administrator).
When a user is entered for comparison, a pass-through field can be included for
each user, for identification purposes.
•
Example: John Smith is included in the XML Input file with 50 other
individuals, and has an email address of jsmith@corp.com as his main
email address on Intralinks, and has also been identified by a client backend system based on an ID of EmpId787783. This ID can be returned for
the user in the actual report next to the his name and email address, as a
way to find the user in the report. To do this, include a pass-through field
of EmpId787783 in the Input XML file for that user.
Running the User Comparison report
Intralinks Integration Adapter User Guide
page 92
•
You must be assigned an InterLinks role of Publisher Plus or above to
run this report.
•
The XML Input file must contain:
– Operation type = Download
– Report type = User Comparison
– Report folder path (location to store the report)
– One or more exchange names or IDs
– A report target folder path
– At least one email address
•
The report can be requested in either an XML format (default), or in an
CSV format.
•
Only ILP exchanges are supported.
•
ILIA will generate one report file per exchange.
XML Format
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="dd/MM/yyyy">
<Identity UserId="pjohnson@intralinks.com" />
<batch Id="6R9379HI">
<Job Id="adhoc" OperationType="Download"
DownloadReportType="UserComparison"
DownloadReportPath="C:\Users\pjohnson\Documents\">
<Workspace Id="316031">
<Users>
<User EMailId="mroberts@yourcompany.com"
FirstName="Mark" LastName="Roberts" Phone="444"
Country="CHILE" />
<User EMailId="jjones@yourcompany.com"
FirstName="James" LastName="Jones" Phone="55555"
Country="CHILE" />
</Users>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
CSV Format
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="dd/MM/yyyy">
<Identity UserId="lrodgers@yourcompany.com" />
<batch Id="6R9379HI">
Intralinks Integration Adapter User Guide
page 93
<Job Id="adhoc" OperationType="Download"
DownloadReportType="UserComparison"
DownloadReportPath="C:\Users\jsmith\Documents\"
DownloadReportFormat="CSV">
<Workspace Id="316031">
<Users>
<User EMailId="jsmith@yourcompany.com"
FirstName="Liv" LastName="Smith" Phone="444"
Country="CHILE" />
<User EMailId="jjones@yourcompany.com"
FirstName="James" LastName="Jones" Phone="55555"
Country="CHILE" />
</Users>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Rollback files
Rollback files allow the Intralinks Integration Adapter (ILIA) to remove documents
and folders created by a previous batch job. The rollback file is a standard
input.xml file without the workspace elements. The OperationType will be set to
Rollback and the RollbackFile attribute must specify the name (full path) of the
output file created by the previous batch job.
When ILIA processes the rollback file it will search for all successfully added
documents and folders for each workspace and remove them from the
workspace.
Note that permissions applied to a folder cannot be rolled back.
Rollback input XML file
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Rollback"
RollbackFile="c:/temp/csa/reports/
ILIAUser@intralinks.com 1.10.2010 10.06.12 AM.xml" />
</batch>
</ExecuteData>
Return to Sample XML files index.
Download files
•
You can download files from a designated exchange or all exchanges.
– You cannot download protected files.
Intralinks Integration Adapter User Guide
page 94
•
You can download files that have been deleted from an IL Platform
exchange, but not from an IL5 exchange.
– IL Platform exchanges can be set up to keep track of all files that have
been deleted (a copy of each file will be kept in a “deleted” folder).
•
A full download downloads all files, even those that may already exist in
the storage location.
•
An incremental download will compare the requested download with what
already exists in the storage location and download those items that have
not already been downloaded.
•
A timebound download downloads documents that were added,
documents that were modified or both new and modified documents
within a specified time frame.
•
XML file defines:
– Source exchange
– Download filter criteria – the folders and files to be included
– Optional - Include deleted, include previous versions, include
placeholders
•
You can select specific files to be downloaded using filters, such as:
– File name (Title = “Invest*”)
– Custom Field values such as:
Label = “Owner” Value = “Joe Smith”
Creation date range – from + to
Creator name
Modified date range (from and to)
Modified by name
Document owner
•
Files will be downloaded to the location you specified in the Configuration
Manager and a report will be generated.
•
A folder will be created for each exchange using the exchange name and
ID.
•
Files will be saved with unique names. Files with the same name will be
assigned a unique suffix.
– A folder will be created for each exchange using the exchange name
and ID. For example, if the selected destination directory is: C:\My
Documents, ILIA will store the files in C:\My Documents\Workspace
ABC_123456 where “Workspace ABC” is the exchange name, and
123456 is the ID of the exchange.
– Add truncations rules here.
•
Files are downloaded as a flat file (no folder hierarchy) but two extra files
are created to help reconstruct the original file structure on the exchange.
Intralinks Integration Adapter User Guide
page 95
– XML file with meta-data and file structure
– HTML file to view structure locally
Download all files from an exchange
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download"
<Workspace Id="1234567" />
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Download all exchange files using a file title filter
This input file will download all files that begin with "Test".
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download">
<Workspace Id="131591" DownloadType="Full">
<DocumentCriteria Name="Test*" />
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Download all files from a folder
This input file will download all files from folder "Test Folder".
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download">
<Workspace Id="131591" DownloadType="Full">
<Folders>
<Folder Name="Test Folder" />
</Folders>
</Workspace>
</Job>
</batch>
Intralinks Integration Adapter User Guide
page 96
</ExecuteData>
Return to Sample XML files index.
Download files from a folder using a custom field filter
This input file will download all files from folder that have a custom field named
"Status" and Value is "Active".
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download">
<Workspace Id="131591" DownloadType="Full">
<Folders>
<Folder Name="Test Folder" />
</Folders>
<DocumentCriteria>
<CustomField Label="Status" Value="Active" />
</DocumentCriteria>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Download all exchange files using a custom field filter
This input file will download all exchange files that have a custom field named
“Exchange Use Type” and a value of “Clinical Study”.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download">
<Workspace Id="131591" DownloadType="Full">
<DocumentCriteria >
<CustomField Label="Exchange Use Type"
Value="Clinical Study" />
</DocumentCriteria>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Download all files from all exchanges
This input file will download all files in all exchanges that the users has
permissions to access.
Intralinks Integration Adapter User Guide
page 97
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download"
DownloadAllWorkspaces="true" />
</batch>
</ExecuteData>
Return to Sample XML files index.
Download files added to an Intralinks Platform exchange within
a specified time range
This input file will download files that were added to the specified Intralinks
Platform exchange during the specified time range.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat= "dd/MM/yyyy" >
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download" DownloadType
="TimeBound" DocumentType ="Create" FromDate="08/31/
2015" ToDate ="08/31/2015" >
<Workspace Id="4566301" />
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Download files that were modified in an Intralinks Platform
exchange within a specified time range
This input file will download files that were modified in the specified Intralinks
Platform exchange during the specified time range.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat= "dd/MM/yyyy" >
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download" DownloadType
="TimeBound" DocumentType ="Update" FromDate="08/31/
2015" ToDate ="08/31/2015" >
<Workspace Id="4566301" />
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Intralinks Integration Adapter User Guide
page 98
Download both files that were added to and modified in an
Intralinks Platform exchange within a specified time range
This input file will download both files that were added to the specified Intralinks
Platform exchange and files that were modified in the exchange during the
specified time range.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat= "dd/MM/yyyy" >
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download" DownloadType
="TimeBound" DocumentType ="Both" FromDate="08/31/
2015" ToDate ="08/31/2015" >
<Workspace Id="4566301" />
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Miscellaneous
Use PassThrough fields
When performing an action using the Input XML file, optional attributes can be
included for each:
•
user
•
group
•
exchange
•
folder
•
document
These optional attributes are passed through without processing to the Output
XML files for reporting purposes and they can be used for tracking purposes. An
external system that is reading the Output files will be able to use the optional
fields to identify any of those users, groups, exchanges, folders, or documents
that were marked with PassThrough fields in the XML Input file.
PassThrough fields cannot be defined as part of a report generation request.
This example shows how to set pass-through fields for exchanges and users in
the XML Input File.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="881865">
Intralinks Integration Adapter User Guide
page 99
<PassThroughFields>
<PassThroughField Name="dealTrackingNumber"
Value="1234567890"/>
<PassThroughField Name="dealRID" Value="555"/
>
<PassThroughField Name="dealName" Value="Test
Name"/>
</PassThroughFields>
<Users>
<User EMailId="testuser01@e-trial.com"
FirstName="Test" LastName="User_01" Org="BSIL"
Phone="7776665501" Role="Reviewer+">
<PassThroughFields>
<PassThroughField Name="contactRid"
Value="12345"/>
</PassThroughFields>
</User>
</Users>
</Workspace>
</Job>
</batch>
</ExecuteData>
This example shows how to set PassThrough fields for users and groups in the
XML Input File.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="user@intralinks.com" />
<batch Id="6R9379HI">
<Job Id="adhoc" OperationType="Create">
<Workspace Id="265591" Name="Test exchange123">
<PassThroughFields>
<PassThroughField Name="dealTrackingNumber"
Value="#48Y9F1O" />
<PassThroughField Name="dealRID"
Value="#48Y9F1O" />
<PassThroughField Name="dealName"
Value="WHITE BIRCH PAPER COMPANY DIP" />
<PassThroughField Name="dealCUSIP" Value="" /
>
</PassThroughFields>
<Groups>
<Group Name="AlphaGroup">
<PassThroughFields>
<PassThroughField Name="SiteID"
Value="78887277" />
</PassThroughFields>
<Users>
<User EMailId="ajones@company.com"
Role="Reviewer">
Intralinks Integration Adapter User Guide
page 100
<PassThroughFields>
<PassThroughField Name="contactRID"
Value="4B8ZLBJM" />
</PassThroughFields>
</User>
<User EMailId="Lmatalon@company.com">
<PassThroughFields>
<PassThroughField Name="contactRID"
Value="6C8ZLBJP" />
</PassThroughFields>
</User>
<User EMailId="NewMember@company2.com">
<PassThroughFields>
<PassThroughField Name="contactRID"
Value="6B8ZLBJK" />
</PassThroughFields>
</User>
<User EMailId="Jsmith@company2.com"
FirstName="John" LastName="Smith" Org="JMP"
Phone="555-123-1234" Role="Reviewer">
<PassThroughFields>
<PassThroughField Name="contactRID"
Value="7T8ZLBJK" />
</PassThroughFields>
</User>
<User EMailId="user1@email.com"
FirstName="user1" LastName="last1" Org="CS"
Phone="212-123-1234" Role="Manager">
<PassThroughFields>
<PassThroughField Name="contactRID"
Value="8B8Z33JY" />
</PassThroughFields>
</User>
</Users>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
This example shows how to set PassThrough fields for folders and documents in
the XML Input File.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchemainstance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" DateFormat="MM/dd/yyyy">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
Intralinks Integration Adapter User Guide
page 101
<Workspace Id="1265631">
<Folders>
<Folder Name="Folder Test 200">
<PassThroughFields>
<PassThroughField Name="ProjectID"
Value="4990" />
</PassThroughFields>
<Documents>
<Document Name="Doc2.pdf"
LocalPath="C:\temp\Doc.pdf" SortOrder="2">
<PassThroughFields>
<PassThroughField Name="ArtifactID"
Value="44776625" />
</PassThroughFields>
</Document>
<Document Name="Doc8.pdf"
LocalPath="C:\temp\Doc.pdf" SortOrder="8">
<PassThroughFields>
<PassThroughField Name="ArtifactID"
Value="76882922" />
</PassThroughFields>
</Document>
</Documents>
</Folder>
</Folders>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Set the user protection period in the Input XML file
ILIA provides an option to specify a protection period during which users who
have been removed from an exchange will not be re-added. This will prevent a
client’s internal system of record from automatically replacing users who have
been intentionally removed using the web user interface. This value can also be
set in the Configuration Manager.
This example shows how to set the protection period in effect when adding new
users to an exchange. The value specified in the Input XML file overrides the
value entered in the Configuration Manager. This example will set the period to 10
days for this input file.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
Intralinks Integration Adapter User Guide
page 102
<Workspace Id="881865"
AddUserProtectPeriod="10">
<Users>
<User EMailId="testuser01@e-trial.com"
FirstName="Test" LastName="User_01" Org="BSIL"
Phone="7776665501" Role="Reviewer+"/>
</Users>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Override email notification
Email notification is set using the ILIA Configuration Manager but you can override
the recipient(s) of the email for a given job using the procedure below. You must
use the Configuration Manager to change the reason(s) for notification (on error,
on completion, etc.).
<?xml version="1.0" encoding="UTF-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema"
EMailNotification="ILIAUser1@intralinks.com,ILIAUser2@
intralinks.com,ILIAUser3@intralinks.com"
xsi:noNamespaceSchemaLocation="file:///C:/IntraLinks/
IntraLinks%20Integration%20Adapter%20Service/
CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser1@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="278891">
<Users>
<User EMailId="ILIA_TestUser_005@e-trial.com"
FirstName="ILIA" LastName="TestUser_005"
Phone="6171181115" Org="IntraLinks"/>
<User EMailId="ILIA_TestUser_006@e-trial.com"
FirstName="ILIA" LastName="TestUser_006"
Phone="6171181116" Org="IntraLinks"/>
</Users>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Change the name of the Output XML file
You can use the Input XML file to change the name of the Output XML file,
instead of using the ILIA Configuration Manager. This is helpful if you have more
than one person submitting Input files. A setting here will override the setting in
the Configuration Manager.
You can define the following naming conventions in the Configuration Manager:
Intralinks Integration Adapter User Guide
page 103
Valid Output File Naming
The output filename is defined using any of the following options:
•
ILIA User ID + date/time stamp
•
Input filename + batch ID + date/time stamp
•
Customizable name + date/time stamp
Invalid Output File Naming
When a serious error occurs and the Input file cannot be processed, there are two
options for naming the output file:
•
Input filename + date/time stamp
•
Customizable name + date/time stamp
Output XML File location
The XML Output file is stored in the Output Directory you specified in the
Configuration Manager. By default, the adapter will use the 'Output' folder under
the installation folder.
The file below will cause the name of the Output XML file to start with
“myOutputFileName”. The rules for changing the Output file name using the Input
XML file are:
•
ILIA will accept an alpha-numeric string as the requested Output file
name.
•
ILIA will use this string at the beginning of the Output file name and will
append to it the Batch ID from the Input file and a date/time stamp.
– The new name will override the chosen Output file name option from
the Configuration settings.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" OutputFilename="myOutputFileName"
xsi:noNamespaceSchemaLocation="file:///Z:/ILIA/
Schemas/v1.0/CSAInputXMLSchema.xsd">
<Identity UserId="ILIAUser@intralinks.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="16589" Name="Smoke_B2_WS1">
<Users>
<User EMailId="testuser1@e-trial.com"
FirstName="Arc" LastName="User1" Org="Test" Phone="555
123-4567" Role="Manager+" />
<User EMailId="testuser2@e-trial.com"
FirstName="Arc" LastName="User2" Org="Test" Phone="555
123-4321" Role="Manager" />
<User EMailId="testuser3@e-trial.com"
FirstName="Arc" LastName="User3" Org="Test" Phone="555
123-1234" Role="Reviewer" />
Intralinks Integration Adapter User Guide
page 104
</Users>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Question and Answer functionality
Some Intralinks exchanges support Question and Answer (Q&A) functionality. If
the Q&A setting is marked (on), specified users will be able to ask questions and
coordinators in your organization will be able to answer the questions or delegate
them to subject matter experts.
Add user as a question submitter
If Q&A is enabled on an exchange, the following procedure enables a user to
submit questions.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="user@yourcompany.com" />
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Workspace Id="1053545" >
<Groups>
<Group Name="BuyerGroup1" Type="Buyer">
<Users>
<User EMailId="testuser_1@e-trial.com"
FirstName="User1" LastName="EIS-218" Org="EIS218_Org"
Phone="996662299" QuestionSubmitter="true"
Role="Reviewer" />
<User EMailId="testuser_2@e-trial.com"
FirstName="User1" LastName="EIS-218" Org="EIS218_Org"
Phone="996662299" QuestionSubmitter="true"
Role="Previewer" />
</Users>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Revoke a user’s right as a question submitter
The following procedure will revoke a user’s right to submit questions.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="user@yourcompany.com" />
Intralinks Integration Adapter User Guide
page 105
<batch Id="1001">
<Job Id="1" OperationType="Update">
<Workspace Id="1053545" >
<Groups>
<Group Name="BuyerGroup3" Type="Buyer">
<Users>
<User EMailId="testuser_11@e-trial.com"
FirstName="User1" LastName="EIS-218" Org="EIS218_Org"
Phone="996662299" QuestionSubmitter="false"
Role="Reviewer" />
<User EMailId="testuser_21@e-trial.com"
FirstName="User1" LastName="EIS-218" Org="EIS218_Org"
Phone="996662299" QuestionSubmitter="false"
Role="Previewer" />
</Users>
</Group>
</Groups>
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Working with Courier
Send Courier packages
When you install ILIA, you have the option to use it to send Courier packages.
See Using ILIA with Intralinks Courier. Any package created through ILIA is
captured in the ILC Compliance Feed, which can be used to generate reports.
Consult the Intralinks Courier Compliance Feed for details.
It is a good idea to familiarize yourself with the Courier interface before formatting
an XML Input file to work with Courier. In particular, you need to know if your
company has set policies for the various Courier settings, and what these settings
are. If you enter values in the Input XML file that contradict these administered
settings, an error message will be returned. You may also wish to consult the
Intralinks Courier Administrator Guide for information about administering and
using Courier.
Here are some other things that you will need to know:
•
The ILIA User ID will be considered as the package sender, and will be
defined by an email address.
•
The following fields are required in the XML Input file.
– Package subject
– One or more recipients must be defined by email addresses, for each
package.
– You must indicate whether you wish to send a public or private (secure)
package
Intralinks Integration Adapter User Guide
page 106
– At least one attachment is required for each package. You need to
enter the document name(s) and the local path.
•
The following fields are optional in the XML Input file:
– Package body text (what the recipient reads in the package alert)
– Expiration date
– Secure Note
– Allow or not allow replies
– Package protection; options are: No protection, Protect or Protect and
Prevent Print.
– Delivery confirmation
– Notification when a file within the package is opened
•
Tracking IDs are either optional or required, depending on your
company’s policy.
– You can either enter IDs from a list or enter a value (up to 20
characters).
<ExecuteData xsi:noNamespaceSchemaLocation="file:///
Z:/ILIA/Schemas/CreatePackage.xsd" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance">
<Identity UserId="user@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
<Packages>
<Package Subject="Please read this important
message" PackageType="Public" SecurePackageNotes=""
Protection="Protect" AllowReply="false"
DeliveryConfirmation="false" OpenFileNotify="false"
TrackingID="">
<Recipients>
<User Email="user@yourcompany.com"/>
<User Email="user@yourcompany.com"/>
</Recipients>
<Documents>
<Document Name="Doc111.doc"
LocalPath="C:\temp\Doc111.doc"/>
<Document Name="Doc211.pdf"
LocalPath="C:\temp\Doc211.pdf"/>
</Documents>
</Package>
</Packages>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Intralinks Integration Adapter User Guide
page 107
Administer Intralinks Courier accounts
You can use ILIA to create, update, and delete Intralinks Courier accounts singly
or in bulk. Here are some other things that you will need to know:
•
Your ILIA account needs to be assigned Business Group Coordinator
rights in order to administer Courier accounts. Your Intralinks Courier
exchange manager can help you with this.
•
You will need to know the name of the business group your ILIA account
is associated with.
•
Policies determine the rights and restriction assigned to a Courier user.
You will need to know the name(s) of the Courier policies available to you
when working with Courier accounts. Policies need to be defined in
advance using Courier administration. If a policy is not specified in the
XML file, the default policy will be used.
•
You will need to know the name of your Courier template ID, which is
associated with your ILIA user account. Your Intralinks Courier exchange
manager can help you with this.
Create Courier accounts
•
You will need to provide the following information for each user for whom
you wish to create a Courier account”
– email
– first name
– last name
– phone number
– organization
•
When you create new accounts, you have the option to suppress the alert
message that is sent to new users telling them they have a new Courier
account.
•
All accounts are created with English as the preferred language. When a
user logs in for the first time, he/she can change the language preference
to one of their choosing.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="BGCoordinator@intralinks.com"/>
<batch Id="1001">
<Job Id="1" OperationType="Create">
<CourierWorkspaces>
<CourierWorkspace BusinessGroup="BG-One"
TemplateId ="146982" Policy="My Policy"
SuppressAlerts="false" >
<Users>
<User EMailId="trial1@intralinks.com"
FirstName="Trial1" LastName="User" Org="IntraLinks"
Phone="1234"/>
Intralinks Integration Adapter User Guide
page 108
<User EMailId="trial2@intralinks.com"
FirstName="Trial2" LastName="User" Org="IntraLinks"
Phone="1234"/>
</Users>
</CourierWorkspace>
</CourierWorkspaces>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Update Courier accounts
•
To update an account, you only need to provide the user’s email address.
•
You can only update the account’s policy setting.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="BGCoordinator@intralinks.com"/>
<batch Id="1001">
<Job Id="3" OperationType="Update">
<CourierWorkspaces>
<CourierWorkspace BusinessGroup="BG-One"
TemplateId ="146982" Policy="My Policy">
<Users>
<User EMailId="trial1@intralinks.com"
FirstName="Trial1" LastName="User" Org="IntraLinks"
Phone="1234"/>
<User EMailId="trial2@@intralinks.com"
FirstName="Trial2" LastName="User" Org="IntraLinks"
Phone="1234"/>
</Users>
</CourierWorkspace>
<CourierWorkspace BusinessGroup="BG-One"
TemplateId ="146982" Policy="Default Policy">
<Users>
<User EMailId="trial3@@intralinks.com"
FirstName="Trial3" LastName="User" Org="IntraLinks"
Phone="1234"/>
<User EMailId="trial4@@intralinks.com"
FirstName="Trial4" LastName="User" Org="IntraLinks"
Phone="1234"/>
</Users>
</CourierWorkspace>
</CourierWorkspaces>
</Job>
</batch>
</ExecuteData>
Delete Courier accounts
•
To delete an account, you only need to provide the user’s email address.
Intralinks Integration Adapter User Guide
page 109
•
Accounts under suspension cannot be deleted.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="BGCoordinator@intralinks.com"/>
<batch Id="1001">
<Job Id="2" OperationType="Remove">
<CourierWorkspaces>
<CourierWorkspace BusinessGroup="BG-One"
TemplateId ="146982" Policy="Default Policy"
SuppressAlerts="false" >
<Users>
<User EMailId="trial1@intralinks.com"
FirstName="Trial1" LastName="User" Org="IntraLinks"
Phone="1234"/>
<User EMailId="trial2@intralinks.com"
FirstName="Trial2" LastName="User" Org="IntraLinks"
Phone="1234"/>
</Users>
</CourierWorkspace>
</CourierWorkspaces>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Working with Amendment Voting
Intralinks’ Amendment Voting solution provides tools for initiating and managing
amendment votes for syndicated loan deals. An Amendment Vote exchange must
be configured to support amendment voting.
Consult the Intralinks Platform Amendment Voting Guide for Managers for more
information.
Synchronize group tranches
This process will format loan information coming from the client’s system of record
to allow individual lenders to access their tranche(s) and to vote on amendments
affecting their investments.
Note: Only one exchange and one vote can be entered in the Input XML file.
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="xyz@yourcompany.com" />
<batch Id="1001">
<Job Id="1" OperationType="Synchronize">
Intralinks Integration Adapter User Guide
page 110
<Workspace Id="6919031" Name="AVM_IL2"
AmendmentVoteID="1234544" DealCurrency="USD"
CusipID="XYZ">
<Groups>
<Group Name="Lender1" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<User EMailId="lender1@bpm.etrial.org" FirstName="lender1" LastName="Lender1"
Org="999" Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender2" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<!--> <User EMailId="lender1@bpm.etrial.org" FirstName="Guru" LastName="Lender User2"
Org="XYZ" Phone="555 123-1234" Role="Previewer"/> -->
<User EMailId="lender2@bpm.e-trial.org"
FirstName="lender2" LastName="Lender2" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender3" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<!--> <User EMailId="lender1@bpm.etrial.org" FirstName="Guru" LastName="Lender User2"
Org="XYZ" Phone="555 123-1234" Role="Previewer"/> -->
<User EMailId="lender3@bpm.e-trial.org"
FirstName="lender3" LastName="Lender2" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender4" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
Intralinks Integration Adapter User Guide
page 111
<!--> <User EMailId="lender1@bpm.etrial.org" FirstName="Guru" LastName="Lender User2"
Org="XYZ" Phone="555 123-1234" Role="Previewer"/> -->
<User EMailId="lender4@bpm.e-trial.org"
FirstName="lender4" LastName="Lender2" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender5" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<!--> <User EMailId="lender1@bpm.etrial.org" FirstName="Guru" LastName="Lender User2"
Org="XYZ" Phone="555 123-1234" Role="Previewer"/> -->
<User EMailId="lender5@bpm.e-trial.org"
FirstName="lender5" LastName="Lender2" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender6" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<!--> <User EMailId="lender1@bpm.etrial.org" FirstName="Guru" LastName="Lender User2"
Org="XYZ Corp" Phone="555 123-1234" Role="Previewer"/>
-->
<User EMailId="lender6@bpm.e-trial.org"
FirstName="lender6" LastName="Lender2" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender7" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<User EMailId="lender7@bpm.e-trial.org"
FirstName="lender7" LastName="Lender1" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender8" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
Intralinks Integration Adapter User Guide
page 112
</CustomFields>
<Users>
<User EMailId="lender8@bpm.e-trial.org"
FirstName="lender8" LastName="Lender1" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender9" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<User EMailId="lender9@bpm.e-trial.org"
FirstName="lender9" LastName="Lender1" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender10" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<User EMailId="lender10@bpm.e-trial.org"
FirstName="lender10" LastName="Lender1" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender11" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<User EMailId="lender11@bpm.e-trial.org"
FirstName="lender11" LastName="Lender1" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender12" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<User EMailId="lender12@bpm.e-trial.org"
FirstName="lender12" LastName="Lender1" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender13" Type="Collaboration">
Intralinks Integration Adapter User Guide
page 113
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<User EMailId="lender13@bpm.etrial.org" FirstName="lender13" LastName="Lender1"
Org="999" Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender14" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<User EMailId="lender14@bpm.etrial.org" FirstName="lender14" LastName="Lender1"
Org="999" Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
<Group Name="Lender15" Type="Collaboration">
<CustomFields>
<CustomField Label="Group Type"
Value="Lender" />
</CustomFields>
<Users>
<User EMailId="lender15@bpm.e-trial.org"
FirstName="lender15" LastName="Lender1" Org="999"
Phone="555 123-1234" Role="reviewer"/>
</Users>
</Group>
</Groups>
<Tranches>
<Tranche TrancheId="1000"
TrancheName="TrancheA" TrancheStatus="Active"
TotalTrancheCommitment ="69550000">
<TrancheGroups>
<TrancheGroup GroupName="Lender1"
CurrentCommitment ="10000000"
DesiredCommitment="7000000" TrancheCurrency="USD"
ConversionPercentage="100"
ConvertedCommitment="10000000"
LenderVotePercentage="1" />
<TrancheGroup GroupName="Lender2"
CurrentCommitment ="9000000"
DesiredCommitment="10000000" TrancheCurrency="USD"
ConversionPercentage="100"
ConvertedCommitment="9000000"
LenderVotePercentage="1"/>
Intralinks Integration Adapter User Guide
page 114
<TrancheGroup GroupName="Lender3"
CurrentCommitment ="7500000" TrancheCurrency="USD"
ConversionPercentage="100"
ConvertedCommitment="7500000" LenderVotePercentage="1"
/>
<TrancheGroup GroupName="Lender4"
CurrentCommitment ="2500000" TrancheCurrency="USD"
ConversionPercentage="100"
ConvertedCommitment="2500000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender5"
CurrentCommitment ="12125000" TrancheCurrency="USD"
ConversionPercentage="100"
ConvertedCommitment="12125000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender6"
CurrentCommitment ="1250000" TrancheCurrency="USD"
ConversionPercentage="100"
ConvertedCommitment="1250000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender7"
CurrentCommitment ="1000000" TrancheCurrency="USD"
ConversionPercentage="100"
ConvertedCommitment="1000000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender8"
CurrentCommitment ="975000" TrancheCurrency="USD"
ConversionPercentage="100"
ConvertedCommitment="975000" LenderVotePercentage="1"/
>
<TrancheGroup GroupName="Lender9"
CurrentCommitment ="11450000" TrancheCurrency="USD"
ConversionPercentage="100"
ConvertedCommitment="11450000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender10"
CurrentCommitment ="13750000" TrancheCurrency="USD"
ConversionPercentage="100"
ConvertedCommitment="13750000"
LenderVotePercentage="1"/>
</TrancheGroups>
</Tranche>
<Tranche TrancheId="1001"
TrancheName="TrancheB" TrancheStatus="Active"
TotalTrancheCommitment="82870000">
<TrancheGroups>
<TrancheGroup GroupName="Lender1"
CurrentCommitment ="5000000" TrancheCurrency="EUR"
ConversionPercentage="200"
ConvertedCommitment="10000000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender11"
CurrentCommitment ="375000" DesiredCommitment="0"
TrancheCurrency="EUR" ConversionPercentage="200"
Intralinks Integration Adapter User Guide
page 115
ConvertedCommitment="750000" LenderVotePercentage="1"/
>
<TrancheGroup GroupName="Lender3"
CurrentCommitment ="2750000" TrancheCurrency="EUR"
ConversionPercentage="200"
ConvertedCommitment="5500000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender4"
CurrentCommitment ="1750000" TrancheCurrency="EUR"
ConversionPercentage="200"
ConvertedCommitment="3500000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender5"
CurrentCommitment ="12000000" TrancheCurrency="EUR"
ConversionPercentage="200"
ConvertedCommitment="24000000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender6"
CurrentCommitment ="6750000" TrancheCurrency="EUR"
ConversionPercentage="200"
ConvertedCommitment="13500000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender7"
CurrentCommitment ="3450000" TrancheCurrency="EUR"
ConversionPercentage="200"
ConvertedCommitment="6900000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender12"
CurrentCommitment ="2360000" TrancheCurrency="EUR"
ConversionPercentage="200"
ConvertedCommitment="4720000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender9"
CurrentCommitment ="5750000" TrancheCurrency="EUR"
ConversionPercentage="200"
ConvertedCommitment="11500000"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender10"
CurrentCommitment ="1250000" TrancheCurrency="EUR"
ConversionPercentage="200"
ConvertedCommitment="2500000"
LenderVotePercentage="1"/>
</TrancheGroups>
</Tranche>
<Tranche TrancheId="1002"
TrancheName="TrancheC" TrancheStatus="Active"
TotalTrancheCommitment="49122000">
<TrancheGroups>
<TrancheGroup GroupName="Lender13"
CurrentCommitment ="450000" TrancheCurrency="YEN"
ConversionPercentage="818.70"
ConvertedCommitment="3684150"
LenderVotePercentage="1"/>
Intralinks Integration Adapter User Guide
page 116
<TrancheGroup GroupName="Lender2"
CurrentCommitment ="275000" TrancheCurrency="YEN"
ConversionPercentage="818.70"
ConvertedCommitment="2251425"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender14"
CurrentCommitment ="975000" TrancheCurrency="YEN"
ConversionPercentage="818.70"
ConvertedCommitment="7982325"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender4"
CurrentCommitment ="375000" TrancheCurrency="YEN"
ConversionPercentage="818.70"
ConvertedCommitment="3070125"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender6"
CurrentCommitment ="675000" TrancheCurrency="YEN"
ConversionPercentage="818.70"
ConvertedCommitment="5526225"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender7"
CurrentCommitment ="425000" TrancheCurrency="YEN"
ConversionPercentage="818.70"
ConvertedCommitment="3479475"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender8"
CurrentCommitment ="775000" TrancheCurrency="YEN"
ConversionPercentage="818.70"
ConvertedCommitment="6344925"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender15"
CurrentCommitment ="1250000" TrancheCurrency="YEN"
ConversionPercentage="818.70"
ConvertedCommitment="10233750"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender9"
CurrentCommitment ="325000" TrancheCurrency="YEN"
ConversionPercentage="818.70"
ConvertedCommitment="2660775"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender10"
CurrentCommitment ="475000" TrancheCurrency="YEN"
ConversionPercentage="818.70"
ConvertedCommitment="3888825"
LenderVotePercentage="1"/>
</TrancheGroups>
</Tranche>
<Tranche TrancheId="1003"
TrancheName="TrancheD" TrancheStatus="Active"
TotalTrancheCommitment="0">
<TrancheGroups>
<TrancheGroup GroupName="Lender1"
CurrentCommitment ="0" TrancheCurrency="YEN"
ConversionPercentage="818.70" ConvertedCommitment="0"
LenderVotePercentage="1"/>
Intralinks Integration Adapter User Guide
page 117
<TrancheGroup GroupName="Lendernew"
CurrentCommitment ="0" TrancheCurrency="YEN"
ConversionPercentage="818.70" ConvertedCommitment="0"
LenderVotePercentage="1"/>
<TrancheGroup GroupName="Lender2"
/>
</TrancheGroups>
</Tranche>
</Tranches>
</Workspace>
</Job>
</batch>
</ExecuteData>
Download Deal Report
The Deal Report is used in conjunction with Amendment Voting and represents
the list of tranches on the exchanges and includes a list of lenders participating in
each tranche with/without commitment data.
The Download Deal Report can be generated in either XML or Excel (CSV)
format. The CSV format supports a single vote while the XML format supports
multiple votes.
The Input XML file must contain the following information in order to request a
Deal Report:
•
Type of report: Deal report (AV)
•
Report folder path
The target exchange can be found based on:
•
Exchange name (Optional)
•
Workspace ID. (Required)
•
AV Name (Required for Excel format only)
Deal Report in Excel format
The following information is returned for Excel generated report.
•
Report Date
•
User
•
Deal Name
•
CUSIP
•
Vote ID
•
Tranche Name
•
Lender Name
•
Commitment
•
Currency
•
Currency Conversion
Intralinks Integration Adapter User Guide
page 118
•
Converted Commitment
•
Voting Percentage
•
Consent
•
Agree
•
Election Option
•
Requested Commitment
•
Signature Page Submission
This example shows how to run a Deal Report in Excel format:
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="a_user@yourcompany.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download"
DownloadReportType="DealReport"
DownloadReportFormat="CSV"
DownloadReportPath="D:\DownLoadReport\Download_Rpt">
<Workspace Id="4880092"
AmendmentVoteProcessName="VoteName1" CusipID="XYZ">
</Workspace>
</Job>
</batch>
</ExecuteData>
Deal Report in XML format
The following information is returned for an XML generated report.
•
AVM Vote Report Date
•
User
•
Deal Name
•
Vote ID
•
Vote Name
•
Deal Currency
•
Tranche ID
•
Tranche Name
•
Lender Name
•
Commitment
•
Currency
•
Currency Conversion
Intralinks Integration Adapter User Guide
page 119
•
Converted Commitment
•
Voting Percentage
•
Consent
•
Agree
•
Election Option
•
Requested Commitment
•
Signature Page Submission
This example shows how to run a Deal Report in XML format:
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema">
<Identity UserId="a_user@yourcompany.com" />
<batch Id="1001">
<Job Id="1" OperationType="Download"
DownloadReportType="DealReport"
DownloadReportFormat="XML"
DownloadReportPath="D:\DownLoadReport\Download_Rpt">
<Workspace Id="4880092" CusipID="XYZ">
</Workspace>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Working with DMS
The Intralinks Deal Management System (DMS) allows clients to manage
syndicated loan transactions throughout the deal life cycle. This includes the
ability to track opportunities throughout the pipeline process, manage contacts
and store commentary, perform book building activities, and run reports.
Consult the Intralinks Deal Management System (DMS) User Guide for more
information.
You can use ILIA to import the following data into DMS:
•
Deal, Tranche and Book information
•
Contacts
•
Organizations
•
Comments
Add Deal, Tranche, and Book
<?xml version="1.0" encoding="utf-8"?>
Intralinks Integration Adapter User Guide
page 120
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
Documents%20and%20Settings/msiegeltuch/My%20Documents/
IntraLinks%20Job%20Archive/ILIA/ILIA%203.7/
CSAInputXMLSchema.xsd">
<Identity UserId="ilia3.4demouser1@ilia.e-trial.org"/>
<batch Id="1001">
<Job Id="1" OperationType="Synchronize">
<Deal DealName="Coca-Cola Exports Deal1"
ExternalId="200" PrimaryBorrower="Unilever"
DealOwner="ilia3.4demouser1@ilia.e-trial.org"
Stage="Pre-Market" Status="Pre-Pitch"
GlobalCommitment="100000" Currency="USD"
LendingType="Institutional" SyndicationType="Best
Effort" EffectiveDate="09/12/2013"
DealTeamRegion="Africa/Middle East/Central Asia"
Sector="High Technology" ClientRelationshipRank="New"
>
<InternalArranger UnderwrittenAmount="100000">
<Titles>
<Title>Administrative Agent</Title>
</Titles>
</InternalArranger>
<WorkingGroup>
<Member OrganizationName="Citibank"
Name="DCowan@workspace.e-trial.org" Lead="false"/>
</WorkingGroup>
<Arrangers>
<Arranger OrganizationName="Citibank"
UnderwrittenAmount="1000">
<Titles>
<Title>Administrative Agent</Title>
<Title>Sole Lead Arranger</Title>
</Titles>
</Arranger>
<Arranger OrganizationName="RBC"
UnderwrittenAmount="1000">
<Titles>
<Title>Co-Arranger</Title>
<Title>Joint Lead Arranger</Title>
</Titles>
</Arranger>
</Arrangers>
<DealFees>
<Fee FeeType="Agency Fee" FeeAmount="1"
AssociatedFeeAmount="Basis Point (bps)"
FeeFrequency="One-time" PLCode="ABC123"/>
Intralinks Integration Adapter User Guide
page 121
<Fee FeeType="Arranger Fee"
FeeAmount="34" AssociatedFeeAmount="Percent"
FeeFrequency="Monthly" PLCode="ABC12334"/>
<Fee FeeType="Commitment Fee"
FeeAmount="33" AssociatedFeeAmount="Currency"
FeeFrequency="Quarterly" PLCode="ABC345"/>
</DealFees>
<TrancheDetails>
<TrancheDetail TrancheName="Coca-Cola Exports
Tranche1" Secured="true" HighYield="true"
TrancheType="Bridge" TrancheSubType="Long Term"
DrawDownAvailability="Delayed Draw"
TrancheCurrency="USD" TargetHoldAmount="1000"
FinalHoldAmount="100" TrancheAmount="1000"
MaturityDate="10/07/2013" MaturityValue="12"
AssociatedWithMaturity="Years" AllInRate="1"
AssociatedAllInRate="Basis Point (bps)"
InterestType="Fixed" BaseRateName="Alternate Base
Rate" BaseRate="1" AssociatedBaseRate="Basis Point
(bps)" PriceTalk="1" AssociatedPriceTalk="Basis Point
(bps)" FinalSpread="1" AssociatedFinalSpread="Basis
Point (bps)" Status="Active" Floor="1"
AssociatedFloor="Basis Point (bps)">
<SubsidiaryBorrowers>
<SubsidiaryBorrower>Uniliver India</
SubsidiaryBorrower>
</SubsidiaryBorrowers>
<TrancheFees>
<Fee FeeType="Agency Fee" FeeAmount="1"
AssociatedFeeAmount="Basis Point (bps)"
FeeFrequency="One-time"/>
<Fee FeeType="Arranger Fee"
FeeAmount="34" AssociatedFeeAmount="Percent"
FeeFrequency="Monthly" PLCode="ABC12334"/>
<Fee FeeType="Commitment Fee"
FeeAmount="33" AssociatedFeeAmount="Currency"
FeeFrequency="Quarterly" PLCode="ABC345"/>
</TrancheFees>
<AlternativeCurrencies>
<AlternativeCurrency>USD</
AlternativeCurrency>
<AlternativeCurrency>AED</
AlternativeCurrency>
<AlternativeCurrency>AFN</
AlternativeCurrency>
</AlternativeCurrencies>
<AssociatedInvestors>
<AssociatedInvestor
InvestorName="Citibank" LevelOfInterest="High"
CommitmentAmount="100" CommitmentSpread="1"
FinalAllocationAmount="100" FinalOID="10">
<InvestorContacts>
<InvestorContact>DCowan@workspace.etrial.org</InvestorContact>
Intralinks Integration Adapter User Guide
page 122
<InvestorContact>kharvey@workspace.etrial.org</InvestorContact>
</InvestorContacts>
</AssociatedInvestor>
<AssociatedInvestor InvestorName="Accel
Partners" LevelOfInterest="Low"
CommitmentAmount="100" CommitmentSpread="4"
FinalAllocationAmount="100" FinalOID="100">
</AssociatedInvestor>
</AssociatedInvestors>
<UseOfProceeds>
<UseOfProceed>General Corp. Purpose</
UseOfProceed>
<UseOfProceed>Refin/Ret Bank Debt</
UseOfProceed>
<UseOfProceed>Acquisition Fin.</
UseOfProceed>
</UseOfProceeds>
</TrancheDetail>
<TrancheDetail TrancheName="Coca-Cola Exports
Tranche2" Secured="true" HighYield="true"
TrancheType="Bridge" TrancheSubType="Long Term"
DrawDownAvailability="Delayed Draw"
TrancheCurrency="USD" TargetHoldAmount="1000"
FinalHoldAmount="100" TrancheAmount="1000"
MaturityDate="10/07/2013" MaturityValue="12"
AssociatedWithMaturity="Years" AllInRate="1"
AssociatedAllInRate="Basis Point (bps)"
InterestType="Fixed" BaseRateName="Alternate Base
Rate" BaseRate="1" AssociatedBaseRate="Basis Point
(bps)" PriceTalk="1" AssociatedPriceTalk="Basis Point
(bps)" FinalSpread="1" AssociatedFinalSpread="Basis
Point (bps)" Status="Active" Floor="1"
AssociatedFloor="Basis Point (bps)">
<SubsidiaryBorrowers>
<SubsidiaryBorrower>Uniliver India</
SubsidiaryBorrower>
</SubsidiaryBorrowers>
<TrancheFees>
<Fee FeeType="Agency Fee" FeeAmount="1"
AssociatedFeeAmount="Basis Point (bps)"
FeeFrequency="One-time"/>
<Fee FeeType="Arranger Fee"
FeeAmount="34" AssociatedFeeAmount="Percent"
FeeFrequency="Monthly" PLCode="ABC12334"/>
<Fee FeeType="Commitment Fee"
FeeAmount="33" AssociatedFeeAmount="Currency"
FeeFrequency="Quarterly" PLCode="ABC345"/>
</TrancheFees>
<AlternativeCurrencies>
<AlternativeCurrency>USD</
AlternativeCurrency>
<AlternativeCurrency>AED</
AlternativeCurrency>
Intralinks Integration Adapter User Guide
page 123
<AlternativeCurrency>AFN</
AlternativeCurrency>
</AlternativeCurrencies>
<AssociatedInvestors>
<AssociatedInvestor
InvestorName="Prudential" LevelOfInterest="High"
CommitmentAmount="100" CommitmentSpread="1"
FinalAllocationAmount="100" FinalOID="10">
<InvestorContacts>
<InvestorContact>RLu@workspace.etrial.org</InvestorContact>
<InvestorContact>JBarrett@workspace.e-trial.org</
InvestorContact>
</InvestorContacts>
</AssociatedInvestor>
<AssociatedInvestor InvestorName="Accel
Partners" LevelOfInterest="Low"
CommitmentAmount="100" CommitmentSpread="4"
FinalAllocationAmount="100" FinalOID="100">
</AssociatedInvestor>
</AssociatedInvestors>
<UseOfProceeds>
<UseOfProceed>General Corp. Purpose</
UseOfProceed>
<UseOfProceed>Refin/Ret Bank Debt</
UseOfProceed>
<UseOfProceed>Acquisition Fin.</
UseOfProceed>
</UseOfProceeds>
</TrancheDetail>
</TrancheDetails>
</Deal>
</Job>
</batch>
</ExecuteData>
Add Deal, Tranche, and Book with Joint Book Runner
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
Documents%20and%20Settings/msiegeltuch/My%20Documents/
IntraLinks%20Job%20Archive/ILIA/ILIA%203.7/
CSAInputXMLSchema.xsd">
<Identity UserId="ilia3.4demouser1@ilia.e-trial.org"/>
<batch Id="1001">
<Job Id="1" OperationType="Synchronize">
<Deal DealName="Coca-Cola Exports Deal2"
ExternalId="200" PrimaryBorrower="Unilever"
JointBookIndicator="true"
Intralinks Integration Adapter User Guide
page 124
DealOwner="ilia3.4demouser1@ilia.e-trial.org"
Stage="Pre-Market" Status="Pre-Pitch"
GlobalCommitment="100000" Currency="USD"
LendingType="Institutional" SyndicationType="Best
Effort" EffectiveDate="09/12/2013"
DealTeamRegion="Africa/Middle East/Central Asia"
Sector="High Technology" ClientRelationshipRank="New"
>
<InternalArranger UnderwrittenAmount="100000">
<Titles>
<Title>Administrative Agent</Title>
</Titles>
</InternalArranger>
<WorkingGroup>
<Member OrganizationName="Citibank"
Name="DCowan@workspace.e-trial.org" Lead="false"/>
<Member OrganizationName="RBC"
Name="Ggretsch@workspace.e-trial.org" Lead="false"/>
</WorkingGroup>
<Arrangers>
<Arranger OrganizationName="Citibank"
UnderwrittenAmount="1000">
<Titles>
<Title>Administrative Agent</Title>
<Title>Sole Lead Arranger</Title>
</Titles>
</Arranger>
<Arranger OrganizationName="RBC"
UnderwrittenAmount="1000">
<Titles>
<Title>Co-Arranger</Title>
<Title>Joint Lead Arranger</Title>
</Titles>
</Arranger>
</Arrangers>
<DealFees>
<Fee FeeType="Agency Fee" FeeAmount="1"
AssociatedFeeAmount="Basis Point (bps)"
FeeFrequency="One-time" PLCode="ABC123"/>
<Fee FeeType="Arranger Fee"
FeeAmount="34" AssociatedFeeAmount="Percent"
FeeFrequency="Monthly" PLCode="ABC12334"/>
<Fee FeeType="Commitment Fee"
FeeAmount="33" AssociatedFeeAmount="Currency"
FeeFrequency="Quarterly" PLCode="ABC345"/>
</DealFees>
<TrancheDetails>
<TrancheDetail TrancheName="Coca-Cola Exports
Tranche1" Secured="true" HighYield="true"
Intralinks Integration Adapter User Guide
page 125
TrancheType="Bridge" TrancheSubType="Long Term"
DrawDownAvailability="Delayed Draw"
TrancheCurrency="USD" TargetHoldAmount="1000"
FinalHoldAmount="100" TrancheAmount="1000"
MaturityDate="10/07/2013" MaturityValue="12"
AssociatedWithMaturity="Years" AllInRate="1"
AssociatedAllInRate="Basis Point (bps)"
InterestType="Fixed" BaseRateName="Alternate Base
Rate" BaseRate="1" AssociatedBaseRate="Basis Point
(bps)" PriceTalk="1" AssociatedPriceTalk="Basis Point
(bps)" FinalSpread="1" AssociatedFinalSpread="Basis
Point (bps)" Status="Active" Floor="1"
AssociatedFloor="Basis Point (bps)">
<SubsidiaryBorrowers>
<SubsidiaryBorrower>Uniliver India</
SubsidiaryBorrower>
</SubsidiaryBorrowers>
<TrancheFees>
<Fee FeeType="Agency Fee" FeeAmount="1"
AssociatedFeeAmount="Basis Point (bps)"
FeeFrequency="One-time"/>
<Fee FeeType="Arranger Fee"
FeeAmount="34" AssociatedFeeAmount="Percent"
FeeFrequency="Monthly" PLCode="ABC12334"/>
<Fee FeeType="Commitment Fee"
FeeAmount="33" AssociatedFeeAmount="Currency"
FeeFrequency="Quarterly" PLCode="ABC345"/>
</TrancheFees>
<AlternativeCurrencies>
<AlternativeCurrency>USD</
AlternativeCurrency>
<AlternativeCurrency>AED</
AlternativeCurrency>
<AlternativeCurrency>AFN</
AlternativeCurrency>
</AlternativeCurrencies>
<AssociatedInvestors>
<AssociatedInvestor
InvestorName="Citibank"
ArrangerOrganization="Citibank"
OrganizationOwner="DCowan@workspace.e-trial.org"
LevelOfInterest="High" CommitmentAmount="100"
CommitmentSpread="1" FinalAllocationAmount="100"
FinalOID="10">
<InvestorContacts>
<InvestorContact>DCowan@workspace.etrial.org</InvestorContact>
<InvestorContact>kharvey@workspace.etrial.org</InvestorContact>
</InvestorContacts>
</AssociatedInvestor>
<AssociatedInvestor InvestorName="Accel
Partners" ArrangerOrganization="Citibank"
OrganizationOwner="DCowan@workspace.e-trial.org"
LevelOfInterest="Low" CommitmentAmount="100"
Intralinks Integration Adapter User Guide
page 126
CommitmentSpread="4" FinalAllocationAmount="100"
FinalOID="100">
</AssociatedInvestor>
</AssociatedInvestors>
<UseOfProceeds>
<UseOfProceed>General Corp. Purpose</
UseOfProceed>
<UseOfProceed>Refin/Ret Bank Debt</
UseOfProceed>
<UseOfProceed>Acquisition Fin.</
UseOfProceed>
</UseOfProceeds>
</TrancheDetail>
<TrancheDetail TrancheName="Coca-Cola Exports
Tranche2" Secured="true" HighYield="true"
TrancheType="Bridge" TrancheSubType="Long Term"
DrawDownAvailability="Delayed Draw"
TrancheCurrency="USD" TargetHoldAmount="1000"
FinalHoldAmount="100" TrancheAmount="1000"
MaturityDate="10/07/2013" MaturityValue="12"
AssociatedWithMaturity="Years" AllInRate="1"
AssociatedAllInRate="Basis Point (bps)"
InterestType="Fixed" BaseRateName="Alternate Base
Rate" BaseRate="1" AssociatedBaseRate="Basis Point
(bps)" PriceTalk="1" AssociatedPriceTalk="Basis Point
(bps)" FinalSpread="1" AssociatedFinalSpread="Basis
Point (bps)" Status="Active" Floor="1"
AssociatedFloor="Basis Point (bps)">
<SubsidiaryBorrowers>
<SubsidiaryBorrower>Uniliver India</
SubsidiaryBorrower>
</SubsidiaryBorrowers>
<TrancheFees>
<Fee FeeType="Agency Fee" FeeAmount="1"
AssociatedFeeAmount="Basis Point (bps)"
FeeFrequency="One-time"/>
<Fee FeeType="Arranger Fee"
FeeAmount="34" AssociatedFeeAmount="Percent"
FeeFrequency="Monthly" PLCode="ABC12334"/>
<Fee FeeType="Commitment Fee"
FeeAmount="33" AssociatedFeeAmount="Currency"
FeeFrequency="Quarterly" PLCode="ABC345"/>
</TrancheFees>
<AlternativeCurrencies>
<AlternativeCurrency>USD</
AlternativeCurrency>
<AlternativeCurrency>AED</
AlternativeCurrency>
<AlternativeCurrency>AFN</
AlternativeCurrency>
</AlternativeCurrencies>
<AssociatedInvestors>
<AssociatedInvestor
InvestorName="Prudential"
Intralinks Integration Adapter User Guide
page 127
ArrangerOrganization="Citibank"
OrganizationOwner="DCowan@workspace.e-trial.org"
LevelOfInterest="High" CommitmentAmount="100"
CommitmentSpread="1" FinalAllocationAmount="100"
FinalOID="10">
<InvestorContacts>
<InvestorContact>RLu@workspace.etrial.org</InvestorContact>
<InvestorContact>JBarrett@workspace.e-trial.org</
InvestorContact>
</InvestorContacts>
</AssociatedInvestor>
<AssociatedInvestor InvestorName="Accel
Partners" ArrangerOrganization="Citibank"
OrganizationOwner="DCowan@workspace.e-trial.org"
LevelOfInterest="Low" CommitmentAmount="100"
CommitmentSpread="4" FinalAllocationAmount="100"
FinalOID="100">
</AssociatedInvestor>
</AssociatedInvestors>
<UseOfProceeds>
<UseOfProceed>General Corp. Purpose</
UseOfProceed>
<UseOfProceed>Refin/Ret Bank Debt</
UseOfProceed>
<UseOfProceed>Acquisition Fin.</
UseOfProceed>
</UseOfProceeds>
</TrancheDetail>
</TrancheDetails>
</Deal>
</Job>
</batch>
</ExecuteData>
Add Organizations and Contacts
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance"
xsi:noNamespaceSchemaLocation="file:///C:/
Documents%20and%20Settings/msiegeltuch/My%20Documents/
IntraLinks%20Job%20Archive/ILIA/ILIA%203.7/
CSAInputXMLSchema.xsd">
<Identity UserId="ilia3.4demouser1@ilia.etrial.org"/>
<batch Id="1001">
<Job Id="1" OperationType="Synchronize">
<CrmOrganization LegalName="Citibank"
Country="AFGHANISTAN"
Intralinks Integration Adapter User Guide
page 128
Region="Middle East" Status="Active"
AddressLine1="Address11" AddressLine2="Address22"
City="ABC" State_Province="KA" PostalCode="515001"
OrganizationOwner="ilia3.4demouser1@ilia.e-trial.org"
Summary="Citibank">
<Ratings>
<Rating RatingType="S and P"
RatingValue="BBB+" RatingEffectiveDate="03/09/2014"
RatingExpiryDate="09/26/2014" />
<Rating RatingType="Moody’s" RatingValue="/"
RatingEffectiveDate="03/09/2014"
RatingExpiryDate="09/26/2014" />
<Rating RatingType="Fitch" RatingValue="CCC"
RatingEffectiveDate="03/09/2014"
RatingExpiryDate="09/26/2014" />
<Rating RatingType="Internal" RatingValue="A-"
RatingEffectiveDate="03/09/2014"
RatingExpiryDate="09/26/2014" />
</Ratings>
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="DCowan@workspace.etrial.org" FirstName="Bijan" LastName=" Sabet"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
<CrmContact Email="kharvey@workspace.e-trial.org"
FirstName="Kevin" LastName="Harvey"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Intralinks Integration Adapter User Guide
page 129
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
</CrmOrganization>
<CrmOrganization LegalName="RBC"
Country="AFGHANISTAN"
Region="Middle East" Status="Active"
AddressLine1="Address11" AddressLine2="Address22"
City="ABC" State_Province="KA" PostalCode="515001"
OrganizationOwner="ilia3.4demouser1@ilia.e-trial.org"
Summary="RBC">
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="Ggretsch@workspace.etrial.org" FirstName="Greg" LastName="Gretsch"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2" City="AP"
State_Province="INDIA" PostalCode="560019"
Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
<CrmContact Email="Rward@workspace.e-trial.org"
FirstName="Rob" LastName="Ward"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
Intralinks Integration Adapter User Guide
page 130
</CrmOrganization>
<CrmOrganization LegalName="Unilever"
Country="ALGERIA"
Region="Africa/Middle East/Central Asia"
Status="Active" AddressLine1="Address1"
AddressLine2="Address2" City="City1"
State_Province="State_Province1"
PostalCode="PostalCode1"
OrganizationOwner="ilia3.4demouser1@ilia.etrial.org" Summary="Unilever">
<Ratings>
<Rating RatingType="S and P" RatingValue="AAA"
RatingEffectiveDate="09/30/2013" RatingExpiryDate="10/
02/2014"/>
<Rating RatingType="Moody’s" RatingValue="/"
RatingEffectiveDate="09/30/2013" RatingExpiryDate="10/
02/2014"/>
</Ratings>
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="BGoodman@workspace.etrial.org" FirstName="Bob" LastName="Goodman"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
<CrmContact Email="DYuan@workspace.e-trial.org"
FirstName="David" LastName="Yuan"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Intralinks Integration Adapter User Guide
page 131
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
</CrmOrganization>
<CrmOrganization LegalName="Uniliver India"
Country="ALGERIA"
Region="Africa/Middle East/Central Asia"
Status="Active" AddressLine1="Address1"
AddressLine2="Address2" City="City1"
State_Province="State_Province1" Parent="Unilever"
PostalCode="PostalCode1"
OrganizationOwner="ilia3.4demouser1@ilia.etrial.org" Summary="Uniliver India">
<Ratings>
<Rating RatingType="Fitch" RatingValue="DDD"
RatingEffectiveDate="09/30/2013" RatingExpiryDate="10/
02/2014"/>
<Rating RatingType="Internal" RatingValue="2"
RatingEffectiveDate="09/30/2013" RatingExpiryDate="10/
02/2014"/>
</Ratings>
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="BRoberts@workspace.etrial.org" FirstName="Bryan"
LastName="Roberts"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
<CrmContact Email="SAnderson@workspace.e-trial.org"
FirstName="Steve"
LastName="Anderson"
Intralinks Integration Adapter User Guide
page 132
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
</CrmOrganization>
<CrmOrganization LegalName="Coca-Cola UK"
Country="ALGERIA"
Region="Africa/Middle East/Central Asia"
Status="Active" AddressLine1="Address1"
AddressLine2="Address2" City="City1"
State_Province="State_Province1" Parent="Unilever"
PostalCode="PostalCode1"
OrganizationOwner="ilia3.4demouser1@ilia.etrial.org" Summary="Coca-Cola UK">
<Ratings>
<Rating RatingType="Fitch" RatingValue="DDD"
RatingEffectiveDate="09/30/2013" RatingExpiryDate="10/
02/2014"/>
<Rating RatingType="Internal" RatingValue="2"
RatingEffectiveDate="09/30/2013" RatingExpiryDate="10/
02/2014"/>
</Ratings>
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="BAscher@workspace.etrial.org" FirstName=" Brian"
LastName="Ascher"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Intralinks Integration Adapter User Guide
page 133
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
<CrmContact Email="JSlavet@workspace.e-trial.org"
FirstName="James"
LastName="Slavet"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
</CrmOrganization>
<CrmOrganization LegalName="Prudential"
Country="INDIA" Region="North Africa" Status="Active"
AddressLine1="Address111" AddressLine2="Address222"
City="DEF" State_Province="KA"
PostalCode="515001"
OrganizationOwner="ilia3.4demouser1@ilia.e-trial.org"
Summary="Prudential">
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="RLu@workspace.etrial.org" FirstName="Ruby" LastName="Lu"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Intralinks Integration Adapter User Guide
page 134
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
<CrmContact Email="JBarrett@workspace.e-trial.org"
FirstName="James" LastName="Barrett"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
</CrmOrganization>
<CrmOrganization LegalName="AIG" Country="INDIA"
Region="North Africa" Status="Active"
AddressLine1="Address111" AddressLine2="Address222"
City="DEF" State_Province="KA"
PostalCode="515001"
OrganizationOwner="ilia3.4demouser1@ilia.e-trial.org"
Summary="AIG">
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="MKrupka@workspace.etrial.org" FirstName="Michael" LastName="Krupka"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
Intralinks Integration Adapter User Guide
page 135
<CrmContact Email="JLee@workspace.e-trial.org"
FirstName="Jenny" LastName="Lee"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
</CrmOrganization>
<CrmOrganization LegalName="Polaris Ventures"
Country="INDIA" Region="North Africa" Status="Active"
AddressLine1="Address111" AddressLine2="Address222"
City="DEF" State_Province="KA"
PostalCode="515001"
OrganizationOwner="ilia3.4demouser1@ilia.e-trial.org"
Summary="Polaris Ventures">
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="DHornik@workspace.etrial.org" FirstName="David" LastName="Hornik"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
<CrmContact Email="GRitter@workspace.e-trial.org"
FirstName="Gordon" LastName="Ritter"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Intralinks Integration Adapter User Guide
page 136
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
</CrmOrganization>
<CrmOrganization LegalName="Accel Partners"
Country="INDIA"
Region="North Africa" Status="Active"
AddressLine1="Address111" AddressLine2="Address222"
City="DEF" State_Province="KA"
PostalCode="515001"
OrganizationOwner="ilia3.4demouser1@ilia.e-trial.org"
Summary="Accel Partners">
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="TBanahan@workspace.etrial.org" FirstName="Tom"
LastName="Banahan" OfficePhone="123456789"
Status="Active" Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
<CrmContact Email="JBreyer@workspace.e-trial.org"
FirstName="Jim"
LastName="Breyer"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
Intralinks Integration Adapter User Guide
page 137
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
</CrmOrganization>
<CrmOrganization LegalName="Citi Financials"
Country="INDIA"
Region="North Africa" Status="Active"
AddressLine1="Address111" AddressLine2="Address222"
City="DEF" State_Province="KA"
PostalCode="515001"
OrganizationOwner="ilia3.4demouser1@ilia.e-trial.org"
Summary="Citi Financials">
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="PFenton@workspace.etrial.org" FirstName="Peter"
LastName="Fenton" OfficePhone="123456789"
Status="Active" Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
<CrmContact Email="KEfrusy@workspace.e-trial.org"
FirstName="Kevin"
LastName="Efrusy"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
Intralinks Integration Adapter User Guide
page 138
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
</CrmOrganization>
<CrmOrganization LegalName="Benchmark Capital"
Country="INDIA"
Region="North Africa" Status="Active"
AddressLine1="Address111" AddressLine2="Address222"
City="DEF" State_Province="KA"
PostalCode="515001"
OrganizationOwner="ilia3.4demouser1@ilia.e-trial.org"
Summary="Benchmark Capital">
<IndustryIdentifiers>
<IndustryIdentifier IdentifierType="LEI"
IdentifierValue="lei2"/>
</IndustryIdentifiers>
<InvestorClassifications>
<InvestorClassification>Insurance Company</
InvestorClassification>
<InvestorClassification>Hedge Fund</
InvestorClassification>
</InvestorClassifications>
<CrmContacts>
<CrmContact Email="RConway@workspace.etrial.org" FirstName="Ron"
LastName="Conway" OfficePhone="123456789"
Status="Active" Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
<CrmContact Email="NShen@workspace.e-trial.org"
FirstName="Neil"
LastName="Shen"
OfficePhone="123456789" Status="Active"
Title="ENGINEER_RESEARCHER_SCIENTIST"
Fax="123456789" MobilePhone="123456789"
AddressLine1="Sample Address"
AddressLine2="Sample Address 2"
City="AP" State_Province="INDIA"
PostalCode="560019" Country="ARMENIA"
Intralinks Integration Adapter User Guide
page 139
Industry="GOVERNMENT_MILITARY_PUBLIC_SERVICE"
FunctionalArea="INFORMATION_TECHNOLOGY"
Salutation="Mrs"
ContactOwner="ilia3.4demouser1@ilia.e-trial.org" />
</CrmContacts>
</CrmOrganization>
</Job>
</batch>
</ExecuteData>
Add Comments
<?xml version="1.0" encoding="utf-8"?>
<ExecuteData xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xsi:noNamespaceSchemaLocation="file:///C:/
Documents%20and%20Settings/msiegeltuch/My%20Documents/
IntraLinks%20Job%20Archive/ILIA/ILIA%203.7/
CSAInputXMLSchema.xsd">
<Identity UserId="ilia3.4demouser1@ilia.e-trial.org"/>
<batch Id="1001">
<Job Id="1" OperationType="Synchronize">
<Commentaries>
<Commentary Subject="Hello" Comment="Test"
DealName="Coca-Cola Exports Deal1" TrancheName="CocaCola Exports Tranche1">
<Organizations>
<Organization LegalName="Citibank"
Email="DCowan@workspace.e-trial.org"/>
<Organization LegalName="Unilever"
Email="BGoodman@workspace.e-trial.org"/>
<Organization LegalName="Prudential"
Email="RLu@workspace.e-trial.org"/>
</Organizations>
</Commentary>
</Commentaries>
</Job>
</batch>
</ExecuteData>
Return to Sample XML files index.
Intralinks Integration Adapter User Guide
page 140
Chapter 7: Integration Adapter Data
Dictionary
This chapter contains a dictionary of XML definitions used for the field names,
attributes and elements used in creating XML input files. It also contains the rules
for constructing XML files following the Intralinks ILIA schema.
You can obtain a zip file of these schema by navigating to the Intralinks exchange
where you downloaded the Integration Adapter and documentation.
The following subjects are covered in this chapter:
•
Mapping of data types to fields
•
ILIA schema definition
– ExecuteData
– Batch and Job information
– Workspaces
– Folders
– Document
– Alert
– Users
– User
– MemberRoles
– Group
– Group elements
– Permissions
– DocumentCriteria
– How DocumentCriteria filtering works
– ConfigCustomField
– Publication element (IL5 only)
– Attachment attributes
– PassThrough Fields
– Attachment attributes
– Courier
– Amendment voting
– Deal Management System (DMS)
– Document-centric report
Intralinks Integration Adapter User Guide
page 141
– Document Access report
– User-centric report
– User Comparison report
– Time bound download
•
Output report definition (.XSD)
•
Common Parameters Charts
– Country
– Roles
– Title
– Functional Area
– Industry
– TimeZone
Intralinks Integration Adapter User Guide
page 142
Mapping of data types to fields
Field Name
Type
Comments
OperationTypes
enumerated
Create
Remove
Update
Synchronize
Rollback
Download
EMailId
string (email address)
The email address of a user who is added to
the Intralinks exchange.
FirstName
string
See Validation Rules in Appendix B
LastName
string
See Validation Rules in Appendix B
Org
string
See Validation Rules in Appendix B
Phone
string
See Validation Rules in Appendix B
Role
string
Can be one of the following:
"REVIEWER"
"PREVIEWER”
"PUBLISHER"
"MANAGER_LTD"
"MANAGER"
"REVIEWER_PLUS"
"PUBLISHER_PLUS"
"HIDDEN_MANAGER_PLUS"
"MANAGER_PLUS"
UserId
string
The email address that ILIA uses to perform
actions on the Intralinks exchange.
See Validation Rules in Appendix B
GroupId
string
See Validation Rules in Appendix B
Group<Name>
string
See Validation Rules in Appendix B
Group<Type>
string
See Validation Rules in Appendix B
Workspace<Id>
string
See Validation Rules in Appendix B
Workspace<Name>
string
See Validation Rules in Appendix B
Intralinks Integration Adapter User Guide
page 143
ILIA schema definition
This section explains how the ILIA schema is organized.
ExecuteData
ExecuteData is the top level of the command file.
Intralinks Integration Adapter User Guide
page 144
ExecuteData attributes
Attribute Name
Data Type
Usage
Note
DateFormat1
string
optional
Specify format of date strings in
XML Input file (e.g. dd-MM-yyyy).
EMailNotification
string
optional
Comma separated list of email
addresses.3
SendAlertImmediate2
boolean
optional
true = document alerts will always
be sent immediately.
OutputFilename
string
optional
Used to define the name of the
Output XML file. The file name will
be this string plus the first batch ID
plus the date time stamp.
If this field is set it will override the
setting in the Configuration
Manager.
1 - See Date Format for instructions on setting the date.
2 - All users in all exchanges will receive the alert immediately if this flag is on.
3 - This setting will override the notification list specified in the Configuration
Manager.
ExecuteData elements
Attribute Name
Min
Max
Usage
Identity
1
1
required
batch
1
unbounded
required
Report
0
unbounded
optional
ExecuteData expanded
•
Within Execute data you provide the information about the identity that
will be doing the operations.
•
Batch is the specific work this command file is going to do.
•
Report is an optional item that allows you to publish the Output report into
a designated exchange, in addition to publishing it in the Output folder.
Note: Impersonate (shown below) is not currently supported.
Intralinks Integration Adapter User Guide
page 145
Intralinks Integration Adapter User Guide
page 146
Batch and Job information
•
Job is where the specific operation type is defined and the workspace is
defined
•
Operation types can be:
– Create
– Remove
– Synchronize
– Update
– Rollback
– Download
Intralinks Integration Adapter User Guide
page 147
Job attributes
Attribute Name
Data Type
Usage
Note
Id
string
required
Required unless
DownloadAllWorkspaces is set
to “true” on the job level.
OperationType
OperationType (enum)
optional
Create
Remove
Update
Rollback
Download
Synchronize
RollbackFile
Full path/filename of
rollback file
optional
If OperationType=Rollback this
must refer to a rollback file
(output file from previous job).
DownloadAll
Workspaces
boolean
optional
OperationType=Download “true”
will return results from all
exchanges that the user has
privileges for, without the need to
mention a specific exchange in
the XML Input file.
DownloadReportPath*
string
optional
The path to save the report file.
This path must exist.
DownloadReportType
enum
optional
DocumentCentric
DocumentAccess
UserCentric
UserComparision
DealReport
DownloadReportFormat
enum
optional
CSV
XML
DownloadType
Enum
optional
Full
Incremental
Timebound
FromDate
string
optional
Used to set a time range for
timebound downloads. This is a
required field only for timebound
downloads.
ToDate
string
optional
Used to set a time range for
timebound downloads. This is a
required field only for timebound
downloads.
* The ILIA Service requires that all paths used to specify file locations are on
a local drive or specified using a UNC path if on a mapped drive. This
includes paths in the input XML files and in the UI Configuration screens.
When using a UNC path to another computer, the source computer must
allow the account running ILIA to have access to the files on that
computer.
Intralinks Integration Adapter User Guide
page 148
If a mapped drive is selected for the Input, Output, Archive and File
Download path in the Configuration Manager, a warning message will be
displayed and it will be converted to a UNC path.
An example of a UNC path: //acomputer123/folder/myfile
Job element
Attribute Name
Min
Max
Usage
Workspace
0
unbounded
required
Intralinks Integration Adapter User Guide
page 149
Workspaces
Intralinks Integration Adapter User Guide
page 150
Workspace attributes
Attribute Name
Data Type
Usage
Note
Id
string
required
Type
WorkspaceType
optional
Intralinks Platform
IL5
Name
string
optional
See Validation Rules.
AmendmentVoteID
string
optional
See Amendment voting.
DealCurrency
string
optional
See Amendment voting.
CusipID
string
optional
See Amendment voting.
AddRemovedUsers
boolean
optional
true = Users that removed
themselves can be re-added to
the exchange.
This attribute exists to preserve
version compatibility. It has
been deprecated.
PvPDeclaration
Enum
optional
PrivateOnly
PublicOnly
PublicAndPrivate
Phase
string
optional
Open
Hold
Preparation
AddUserProtectPeriod
integer
optional
Number of days to protect users
who are removed.from being readded.
0=no protection
Note: The setting here will
override the setting in the
Configuration Manager.
SuppressAlert
boolean
optional
Concerns the Welcome to
Workspace Alert
Default = false (no suppression)
SuppressWelcomeAler
t
boolean
optional
This can only be used when
updating the phase of an
exchange
These attributes are used for the Download feature only.
IncludeDeleted
boolean
optional
Include deleted documents in
download.
IncludePreviousVer
boolean
optional
Include previous versions of
documents in download.
DownloadType
Enum
optional
Full
Incremental
Timebound
Intralinks Integration Adapter User Guide
page 151
Attribute Name
Data Type
Usage
Note
IncludePlaceholders
boolean
optional
Include document placeholders
in download.
These attributes are used for exchange creation only.
Create
boolean
optional
Must be true if creating a new
exchange.
Template
string
optional
Must contain template ID if
creating an exchange.
Host
string
optional
Must contain host name if
creating an exchange.
Description
string
optional
Description of new exchange.
PublishFields
boolean
optional
true=Publish the custom fields
in an exchange.
Workspace elements
Attribute Name
Min
Max
Usage
CustomFields
0
1
ConfigCustomFields
0
1
Users
0
1
Groups
0
1
Folders
0
1
DocumentCriteria
0
1
RemoveUserNote
0
1
Will be included in the
removal alert for all of the
users removed from the
exchange
GroupUserCriteria
0
1
Allow filtering of report data
based on user and group.
PassThroughFields
0
1*
A string to keep track of a
user, document, folder, etc.
Not processed in XML file but
returned in XML Output file.
* PassThroughFields can contain more than one PassThroughField.
Intralinks Integration Adapter User Guide
page 152
Folders
Within the Workspace information there can be an element for Folders.
•
Folders contains all the information about specific folder items that you
are working with in this command file
– There can be 0 to the exchange limit on the number of folders that can
be included
•
The specific folder to be used in the exchange.
– This can be a new folder or an existing folder
•
A folder contains documents
•
Permissions set at the folder level will apply to all documents in the folder
– See Permissions for important information on folder permissioning.
Intralinks Integration Adapter User Guide
page 153
Folder attributes
Attribute Name
Data Type
Usage
Note
Name
string
required
Id
string
optional
ID of folder. This can be used
instead of the name.
Create
boolean
optional
true=Create if "Create Folders"
option is enabled in UI.
SortOrder
integer (zero and
negative values are not
allowed)
optional
The same sort order cannot be
assigned to two documents or
folders at the same level.
Index
boolean
optional
This can only be set for top-level
folders.
LocalPath*
string
optional
Specify path to copy files from
local to exchange (e.g.
"C:\Temp").
LocalFilter
string
optional
Filter local files to copy (e.g.
"*.pdf").
NewName
string
optional
TargetFolder
string
optional
* The ILIA Service requires that all paths used to specify file locations are on
a local drive or specified using a UNC path if on a mapped drive. This
includes paths in the input XML files and in the UI Configuration screens.
When using a UNC path to another computer, the source computer must
allow the account running ILIA to have access to the files on that
computer.
If a mapped drive is selected for the Input, Output, Archive and File
Download path in the Configuration Manager, a warning message will be
displayed and it will be converted to a UNC path.
An example of a UNC path: //acomputer123/folder/myfile
Intralinks Integration Adapter User Guide
page 154
Folder elements
Attribute Name
Min
Max
Usage
Documents
0
1
optional
See Validation Rules in
Appendix B.
Publications
0
1
optional
See Validation Rules in
Appendix B.
Permissions
0
1
optional
Note
0
1
folder note
optional
string
See Validation Rules in
Appendix B.
PassThroughFields
0
1*
A string to keep track
of a user, document,
folder, etc. Not
processed in XML file
but returned in XML
Output file.
* PassThroughFields can contain more than one PassThroughField.
Folder creation behavior
If the folder specified in the input file is found on the exchange, it will be used. If
the folder is not found, the following table can be used to determine if the folder
will be created.
The Configuration Setting refers to the "Create folder if it does not exist" option in
the Configuration Manager. "XML Create" is the "Create" attribute in the Folder
element in the XML file.
Configuration Setting =
true
Configuration Setting = false
XML Create=true
Create folder
Create folder
XML Create=false
Do not create folder
Do not create folder
XML Create not specified
Create folder
Do not create folder
Note: A duplicate folder will not be created under any conditions.
Intralinks Integration Adapter User Guide
page 155
FolderList Attributes
Attribute Name
Data Type
Usage
Note
Id
string
optional
Folder ID
ContentsOnly
boolean
optional
Used for Remove
operation only.
true=Only contents
will be deleted
false=Folder and
contents will be
deleted (default)
Intralinks Integration Adapter User Guide
page 156
Document
•
This is the specific file information.
– Local path is the source file path on the local system
– NoteRequired indicates if the note must be displayed each time the file
is viewed or accessed
•
Permissions are for that specific file/document
Intralinks Integration Adapter User Guide
page 157
Document attributes
Attribute Name
Data Type
Usage
Note
Name
string
required
See Validation Rules in
Appendix B.
EffectiveDate
date
optional
Id
string
optional
This is valid only when
operation type is Update or
Remove.
LocalPath*
string
optional
Used to point to the file that
needs to be attached to the
document.
NewName
string
optional
New name of document.
NoteRequired
boolean
optional
See “Note” in Document
elements below.
OwnerUser
string
optional
User name or user email
address.
OwnerGroup
string
optional
Group name or group ID.
SortOrder
integer (zero and
negative values are
not allowed)
optional
The same sort order
cannot be assigned to two
documents or folders at the
same level.
TargetFolder
string
optional
Name/Id of folder to move
document into.
Visibility
enum
optional
public
private
* The ILIA Service requires that all paths used to specify file locations are
on a local drive or specified using a UNC path if on a mapped drive. This
includes paths in the input XML files and in the UI Configuration screens.
When using a UNC path to another computer, the source computer must
allow the account running ILIA to have access to the files on that
computer.
If a mapped drive is selected for the Input, Output, Archive and File
Download path in the Configuration Manager, a warning message will
be displayed and it will be converted to a UNC path.
An example of a UNC path: //computer#/folder/myfile
Intralinks Integration Adapter User Guide
page 158
Document elements
Element Name
Min
Max
Usage
Note
Permissions
0
1
optional
Alerts
0
1
optional
CustomFields
0
1
optional
Field name/value pairs
Note*
0
1
optional
string
PassThroughFields
0
1**
optional
A string to keep track of a
user, document, folder, etc.
Not processed in XML file but
returned in XML Output file.
* The length of a note cannot exceed 4000 characters.
** PassThroughFields can contain more than one PassThroughField.
Intralinks Integration Adapter User Guide
page 159
GroupList element
GroupList Elements
Element Name
Min
Max
GroupFilter
0
unbounded
CustomField
0
1
UserFilter
0
unbounded
Intralinks Integration Adapter User Guide
Usage
Note
Filter groups by custom field
name/value pairs.
page 160
GroupFilter attributes
Attribute Name
Data Type
Usage
Note
GroupId
string
optional
ID of group
GroupName
string
optional
Name of group
Attribute Name
Data Type
Usage
Note
UserEmailId
string
optional
ID of user
UserId
string
optional
Unique ID of user in
Global User Directory
(GUD)
UserName
string
optional
First and last name of
user
Visibility
visibility type
optional
public
private
UserFilter attributes
Intralinks Integration Adapter User Guide
page 161
Alert
This information needs to be provided when sending an alert about a document.
ILIA does not support a custom alert note and subject for publications (IL5).
Add Recipient diagram
Intralinks Integration Adapter User Guide
page 162
Alert attributes
Attribute Name
Data Type
Usage
Note
EmailId
string
optional
ID of user in group
GroupId
string
optional
ID of group
GroupName
string
optional
Name of group
Subject
string
optional
Subject of alert email
Body
string
optional
Body message of alert email
AllPermissionedUsers
boolean
optional
Send to all users permissioned to
see the document
Alert elements
Attribute Name
Min
Max
CustomField
0
unbounded
Recipients
0
1
Intralinks Integration Adapter User Guide
Usage
page 163
Users
•
Contains the user elements for this action.
Intralinks Integration Adapter User Guide
page 164
User
•
User is the element for the specific user information.
•
The initial values, shown below, can be set when adding a person to the
Global User Directory (GUD).
– If the person is already in the GUD, their information will be validated
against the existing record and the differences will be reported.
•
The role in the exchange can be set for existing users only.
Intralinks Integration Adapter User Guide
page 165
User attributes
Attribute Name
Data Type
Usage
Note
EMailID
string
required
See Validation Rules in
Appendix B
FirstName
string
required
See Validation Rules in
Appendix B
LastName
string
required
See Validation Rules in
Appendix B
Org
string
required
See Validation Rules in
Appendix B
Phone
string
required
See Validation Rules in
Appendix B
Roles
string
required
Can be one of the
following:
"REVIEWER"
"PREVIEWER”
"PUBLISHER"
"MANAGER_LTD"
"MANAGER"
"REVIEWER_PLUS"
"PUBLISHER_PLUS"
"HIDDEN_MANAGER
_PLUS"
"MANAGER_PLUS"
Language
string
keyContact
boolean
Title
string
optional
Industry
string
optional
Functional Area
string
optional
City
string
optional
City
State
string
optional
State
ZipCode
string
optional
Zip Code
Country
string
optional
Country
Fax
string
optional
Fax
Mobile
string
optional
Mobile
TimeZone
string
optional
Time Zone
Intralinks Integration Adapter User Guide
optional
English (default)
French
German
Japanese
Portuguese
Spanish
Chinese
page 166
Attribute Name
Data Type
Usage
Note
SortFirstName
string
optional
SortFirstName
SortLastName
string
optional
SortLastName
AlphaFirstName
string
optional
AlphaFirstName
AlphaLastName
string
optional
AlphaLastName
Address1
string
optional
Address2
string
optional
Placeholder
boolean
optional
true=placeholder user
SupressWelcomeAlert
boolean
optional
true=alert will not be
sent.
QuestionSubmitter
boolean
optional
true=submitter
false=default
If a Question Submitter
exists and you enter
false, the user’s right
to submit questions for
that Buyer Group will
be removed.
User elements
Element Name
Min
Max
Usage
MemberRoles
0
1
The MemberRoles feature must
be enabled on the exchange.
Group roles are only valid when
adding/updating users in groups.
PassThroughFields
0
1*
A string to keep track of a user,
document, folder, etc. Not
processed in XML file but
returned in XML Output file.
* PassThroughFields can contain more than one PassThroughField.
Intralinks Integration Adapter User Guide
page 167
MemberRoles
Element Name
Min
Max
Usage
MemberRole
0
unbounded
Specifies one member role.
MemberRole attributes
Attribute Name
Data Type
Usage
Note
Role
string
optional
Name of member role.
Intralinks Integration Adapter User Guide
page 168
Groups
•
Contains the Group elements
Intralinks Integration Adapter User Guide
page 169
Group
•
This is the information on a specific group
•
A group can contain a set of users, and a set of custom fields.
Group attributes
Attribute Name
Data Type
Usage
Note
Id
string
optional
Group ID (if you don’t want to
identify the group by name)
Name
string
required
Type
string
optional
Intralinks Integration Adapter User Guide
Workspace (default)
Buyer
Collaboration
page 170
Attribute Name
Data Type
Usage
Note
DefaultFolder
string
optional
When creating or updating
groups; ILIA will set the
default folder for the specified
group(s).
FTSEnable
boolean
optional
True=Enable Full Text
Search
NewName
string
optional
New name of folder
RemoveMembersFromExchange
boolean
optional
True=Members will be
removed from the exchange
Group elements
Attribute Name
Min
Max
Usage
Users
0
1
optional
CustomFields
0
1
optional
Note
0
1
optional
PassThroughFields
0
1*
optional
* PassThroughFields can contain more than one PassThroughField.
Permissions
Intralinks Integration Adapter User Guide
page 171
Permissions attributes
Attribute Name
Data Type
Usage
Note
Replace
boolean
optional
true=existing document /folder
permissions will be replaced with
these permissions.
Permission attributes
Attribute Name
Data Type
Usage
Note
GroupId
string
optional
ID of group
GroupName
string
optional
Name of group.
See Validation Rules in Appendix
B.
EmailId
string (email
address)
optional
By specifying the email address of
a user, ILIA will search for all of the
groups that this user is a member
of, and wll permission all of these
groups.
See Validation Rules in Appendix
B.
Control
boolean
optional
true=Control permission
See
boolean
optional
Create
boolean
optional
Protection
string (ENUM)
optional
NoProtect
Protect
ProtectNoPrint
Permission element
Attribute Name
Min
Max
Usage
CustomField
0
unbounded
All of the groups that
match the defined
custom fields will be
permissioned.
Intralinks Integration Adapter User Guide
page 172
DocumentCriteria
Intralinks Integration Adapter User Guide
page 173
DocumentCriteria attributes
The DocumentCriteria attributes will be combined together (AND'd) and only the
documents that meet all the criteria will be included in the filter operation.
Attribute Name
Data Type
Usage
Note
CreateDateFrom1
string (date)
optional
Date of file creation Use to include
files newer than this date.
Visibility
visibility type
optional
Filter documents on the exchange
based on their public/private
declaration.
CreateDateTo1
string (date)
optional
Date of file creation Use to include
files older than this date.
Creator
string
optional
Name of document creator.
EffectiveDate1
string
optional
EffectiveDateFrom1
string
optional
A filter to find documents
EffectiveDateTo1
string
optional
A filter to find documents
Extension
string
optional
Any extension to the document
MIMEType
string
optional
Type of file.
ModifedDateFrom1
string (date)
optional
Date of file last changed. Use to
include files newer than this date.
ModifedDateTo1
string (date)
optional
Date of file last changed. Use to
include files older than this date.
Name
string
optional
Name of file. Wildcard character *
and ? are allowed.
OwnerUser
string
optional
User’s name (first, last) or user’s
email address.
OwnerGroup
string
optional
Group name or group ID
Submitter
string
optional
Email address or user name
SubmittedDateFrom1
string
optional
SubmittedDateTo1
string
optional
1 - See Date Format for instructions on setting the date.
DocumentCriteria elements
The FolderList, DocumentList and PublicationList elements provide a way to filter
the document list by specifying the Document ID's, Folder Id's and Publication
ID's. The criteria attributes will then be applied to this list. If no ID's are specified
then the criteria attributes will be applied to the entire exchange.
Element Name
Min
Max
Usage
FolderList
0
unbounded
optional
Intralinks Integration Adapter User Guide
page 174
Element Name
Min
Max
Usage
PublicationList
0
unbounded
optional
DocumentList
0
unbounded
optional
CustomField
0
unbounded
optional
How DocumentCriteria filtering works
When the DocumentCriteria element is defined in the input file the attributes in the
criteria (Name, Creator, etc.) will be compared against the folders, document and
publications in the “Candidate” list. This comparison is not case sensitive.
By default all of the folders, document and publications in the exchange will be
included in the candidate list. If a FolderList, DocumentList and/or PublicationList
is defined, only these folders, document and publications will be include in the
candidate list.
Also, if any Folder, Document or Publication elements are defined in the input file,
they will also be included in the candidate list.
Note: In all operations using the document criteria for filtering items to be included
in that operation, the document criteria uses parent custom field values for filtering
and ignores the child custom fields.
GroupUserCriteria
Element Name
Min
Max
GroupList
0
1
UserList
0
1
Intralinks Integration Adapter User Guide
Usage
Note
page 175
GroupUserCriteria elements
Element Name
Min
Max
GroupFilter
0
unbounded
CustomFields
0
1
UserFilter
0
unbounded
Usage
Note
Note: The UserId is referred to as the InternalId in the User-centric and User
Access reports.
Intralinks Integration Adapter User Guide
page 176
CustomFields
CustomField attributes
Attribute Name
Data Type
Usage
Label
string
required
Value
string
required
Note
CustomField elements
Element Name
Min
Max
Usage
CustomField
0
unbounded
optional
CustomField can contain children to allow setting values of child custom fields.
Note: ILP exchanges allow parent custom fields to have children but only one
level deep (child custom fields cannot have children).
Intralinks Integration Adapter User Guide
page 177
ConfigCustomField
ConfigCustomField can be used to enable or disable custom fields in the
exchange.
ConfigCustomField attributes
Attribute Name
Data Type
Usage
Note
Label
string
required
Type
string (enum)
required
Exchange
Group
Document
Parent
string
optional
Value of the parent custom field
Enable
boolean
optional
true=enabled
false=disabled
ConfigCustomField elements
Element Name
Min
Max
Usage
ConfigCustomField
0
unbounded
optional
ConfigCustomFields can contain children (only one level deep) to allow enabling/
disabled child custom fields.
DocumentList Attributes
Attribute Name
Data Type
Usage
Note
Id
string
optional
Document ID
Intralinks Integration Adapter User Guide
page 178
PublicationList Attributes
Attribute Name
Data Type
Usage
Note
Id
string
optional
Publication ID
Publication element (IL5 only)
This diagram shows the publication attributes and elements.
Intralinks Integration Adapter User Guide
page 179
Publication attributes
Attribute Name
Data Type
Usage
Note
Name
string
required
Id
string
optional
EffectiveDate
date
optional
NewName
string
optional
SortOrder
integer (zero and
negative values are
not allowed)
optional
TargetFolder
string
optional
Visibility
VisibilityType (enum)
optional
IL5 only
public
private
IL5 only
Publication elements
Element Name
Min
Max
Usage
Permissions
0
1
optional
Attachments
0
1
optional
Alerts
0
1
optional
Attachment attributes
Attribute Name
Data Type
Usage
Note
Name
string
required
Name of attachment
LocalPath*
string
optional
Local path/name of file to
copy to exchange
TargetFolder
string
optional
Name/Id of publication to
move attachment into
NewName
string
optional
New name of attachment
* The ILIA Service requires that all paths used to specify file locations are on
a local drive or specified using a UNC path if on a mapped drive. This
includes paths in the input XML files and in the UI Configuration screens.
When using a UNC path to another computer, the source computer must
allow the account running ILIA to have access to the files on that
computer.
If a mapped drive is selected for the Input, Output, Archive and File
Download path in the Configuration Manager, a warning message will be
displayed and it will be converted to a UNC path.
An example of a UNC path: //acomputer123/folder/myfile
Intralinks Integration Adapter User Guide
page 180
PassThrough Fields
The passthrough fields are specified in the Input XML file and appear in
the Output Report file.
PassThrough attributes
Attribute Name
Data Type
Usage
Note
Name
string
required
Name of the
passthrough field
Value
string
optional
Passthrough field
value
PassThrough elements
Element Name
Min
Max
Usage
PassThroughField
0
1*
A string to keep track
of a user, document,
folder, etc. Not
processed in XML file
but returned in XML
Output file.
* PassThroughFields can contain more than one PassThroughField.
Intralinks Integration Adapter User Guide
page 181
Courier
Courier ExecuteData
Intralinks Integration Adapter User Guide
page 182
Courier ExecuteData elements
Element Name
Min
Max
Identity
0
1
Usage
Batch
Courier identity attributes
Attribute Name
Data Type
Usage
UserId
integer
required
Note
Courier batch attributes
Attribute Name
Data Type
Usage
Id
integer
required
Note
Courier batch elements
Element Name
Min
Max
Job
0
1
Intralinks Integration Adapter User Guide
Usage
page 183
Courier job attributes
Attribute Name
Data Type
Usage
Note
Id
string
required
OperationType
operation types
required
Create
Update
Delete
Remove
Usage
Courier job elements
Element Name
Min
Max
CourierWorkspaces
0
1
Packages
1
unbounded
Intralinks Integration Adapter User Guide
page 184
Courier workspaces elements
Element Name
Min
Max
CourierWorkspace
1
unbounded
Usage
Courier workspace attributes
Attribute Name
Data Type
Usage
Note
TemplateId
integer
optional
BusinessGroup
string
optional
Policy
string
optional
If one of these
attributes in provided,
the other two are
required as well.
SuppressAlerts
boolean
optional
true=suppress alert
false=allow alert
Max
Usage
Courier workspace elements
Element Name
Min
Users
Intralinks Integration Adapter User Guide
page 185
Courier users elements
Element Name
Min
Max
User
1
unbounded
Usage
Courier user attributes
Attribute Name
Data Type
Usage
Note
EMailId
string
required
100 character max.
FirstName
string
required
The following
characters are not
allowed:
/@~%+:{}()[] <
>|‘,“\;
LastName
string
required
The following
characters are not
allowed:
/@~%+:{}()[] <
>|‘,“\;
Org
string
required
The following
characters are not
allowed:
/@~%+:{}()[] <
>|‘,“\;
Phone
string
required
Numerals 1-9
Alphabetic characters
including:
“()<>[],;{}:|\/`^
‘?_-# +$%&*~!‘
@
The letter “x” can be
used for “extension”
Spaces are allowed
but not two or more in
a row.
Intralinks Integration Adapter User Guide
page 186
Courier packages elements
Element Name
Min
Max
Package
1
unbounded
Intralinks Integration Adapter User Guide
Usage
page 187
Courier package attributes
Attribute Name
Data Type
Usage
Note
Subject
string
required
60 characters
maximum
PackageBody
string
optional
PackageType
package type
required
Public
Private
SecurePackageNotes
string
optional
4000 characters max.
PackageExpiry
string
optional
Date format:
MM/dd/yyyy
AllowReply
boolean
optional
true
false (default)
DeliveryConfirmation
boolean
optional
true
false (default)
OpenFileNotify
boolean
optional
true
false (default)
TrackingId
string
May be required by
company policy
Up to 60 alphanumeric
characters
DateFormat
string
Protection
protection type
MM/dd/yyyy
optional
NotSet (default)
NoProtect
Protect
ProtectNoPrint
Usage
Courier package elements
Element Name
Min
Max
Recipients
1
unbounded
Documents
1
unbounded
Courier recipients elements
Element Name
Min
Max
User
1
unbounded
Intralinks Integration Adapter User Guide
Usage
page 188
Courier user attributes
Attribute Name
Data Type
Usage
Note
EMailId
string
required
100 character max.
FirstName
string
required
The following
characters are not
allowed:
/@~%+:{}()[] <
>|‘,“\;
LastName
string
required
The following
characters are not
allowed:
/@~%+:{}()[] <
>|‘,“\;
Org
string
required
The following
characters are not
allowed:
/@~%+:{}()[] <
>|‘,“\;
Phone
string
required
Numerals 1-9
Alphabetic characters
including:
“()<>[],;{}:|\/`^
‘?_-# +$%&*~!‘
@
The letter “x” can be
used for “extension”
Spaces are allowed
but not two or more in
a row.
Intralinks Integration Adapter User Guide
page 189
Courier documents elements
Element Name
Min
Max
Document
1
unbounded
Usage
Courier document attributes
Attribute Name
Data Type
Usage
Name
string
required
LocalPath
string
required
Intralinks Integration Adapter User Guide
Note
page 190
Amendment voting
Tranche elements
Element Name
Min
Max
Tranche
0
15
Attribute Name
Data Type
Usage
TrancheName
string
required
TrancheId
string
required
TrancheStatus
status type
required
TotalTrancheCommitment
dollar amount
(decimal)
required
Usage
Tranche attributes
Intralinks Integration Adapter User Guide
Note
Active
Inactive
Terminated
Pending
page 191
Tranche groups element
Element Name
Min
Max
TrancheGroups
0
1
Usage
Tranche group elements
Element Name
Min
Max
TrancheGroup
0
unbounded
Usage
Tranche group attributes
Attribute Name
Data Type
Usage
GroupName
string
required
CurrentCommitment
dollar amount
(decimal)
optional*
DesiredCommitment
dollar amount
(decimal)
optional
TrancheCurrency
string
optional
ConversionPercentage
numeric
optional
ConvertedCommitment
dollar amount
(decimal)
optional
LenderVotePercentage
numeric
optional
Note
0 to 100
*If you provide CurrentCommitment, you must provide all of the other attributes
except DesiredCommitment.
Intralinks Integration Adapter User Guide
page 192
Deal Management System (DMS)
CrmOrganization
Intralinks Integration Adapter User Guide
page 193
CrmOrganization Elements
Element Name
Min
Max
CrmOrganization
0
unbounded
Usage
DMS Organization Attributes
Attribute Name
Data Type
Usage
Note
LegalName
string
required
Not allowed:
/@~%+:"/{}//`()
[]<>|�\,\\;
Country
UserProfCountry
required
Region
RegionType
required
Status
Status
required
AddressLine1
string
optional
AddressLine2
string
optional
City
string
optional
State_Province
string
optional
PostalCode
string
optional
TaxId
string
optional
Parent
string
optional
OrganizationOwner
string
optional
Summary
string
optional
Intralinks Integration Adapter User Guide
0-9
Only numbers allowed.
page 194
IndustryIdentifier
IndustryIdentifier Elements
Element Name
Min
Max
Usage
IndustryIdentifier
0
unbounded
optional
Note
IndustryIdentifier Attributes
Attribute Name
Data Type
Usage
IdentifierType
Industry Identifier Type
required
IdentifierValue
string
required
Intralinks Integration Adapter User Guide
page 195
InvestorClassification
InvestorClassification Elements
Element Name
Min
Max
InvestorClassifications
0
1
Usage
InvestorClassification Attributes
Attribute Name
Data Type
Usage
InvestorClassification
Investor Classification
Type
optional
Intralinks Integration Adapter User Guide
Note
page 196
Rating
Rating Elements
Element Name
Min
Max
Rating
0
unbounded
Usage
Rating Attributes
Attribute Name
Data Type
Usage
RatingType
Rating Type
required
RatingValue
string
required
RatingEffectiveDate
string
required
RatingExpiryDate
string
optional
Intralinks Integration Adapter User Guide
Note
Allowed characters for
Internal Rating Type:
a-z, A-Z, 0-9 + - /
page 197
CrmContacts
Intralinks Integration Adapter User Guide
page 198
CrmContacts Elements
Element Name
Min
Max
Usage
CrmContact
0
unbounded
optional
CrmContacts Attributes
Attribute Name
Data Type
Usage
Note
FirstName
string
required
LastName
string
required
The following
characters are not
allowed:
/@~%+:{}()[]<>
|‘,“\;
Email
string
required
100 characters
OfficePhone
string
required
For Length = 4,
following characters
are allowed:
0-9 x
Status
Status
required
Active
Inactive
Title
UserProfTitle
optional
Fax
string
optional
MobilePhone
string
optional
AddressLine1
string
optional
AddressLine2
string
optional
City
string
optional
State_Province
string
optional
PostalCode
string
optional
Country
UserProfCountry
optional
Industry
UserProfIndustry
optional
Functional Area
UserProfFunctionalAre
a
optional
Salutation
SalutationType
optional
Intralinks Integration Adapter User Guide
For Length = 4,
following characters
are allowed:
0-9 x
Mr
Mrs
Ms
Dr
page 199
Attribute Name
Data Type
Usage
ReportsTo
string
optional
ContactOwner
string
optional
Intralinks Integration Adapter User Guide
Note
page 200
Deal
Intralinks Integration Adapter User Guide
page 201
Deal Elements
Element Name
Min
Max
Usage
Deal
0
unbounded
Attribute Name
Data Type
Usage
ExternalId
string
optional
PrimaryBorrower
string
optional
JointBookIndicator
boolean
optional
DealOwner
string
optional
Stage
Stage Type
required
Status
Deal Status
required
DealName
string
required
Not allowed:
<> \
GlobalCommitment
double
optional
Allowed characters:
0-9 , .
Currency
Currency Type
optional
LendingType
Lending Type
optional
SyndicationType
Syndication Type
optional
DealCUSIP
string
optional
Length = 9
Allowed values:
0-9 A-Z a-z
EffectiveDate
string
optional
Only valid dates are
allowed.
Deal Attributes
Note
mm/dd/yyyy format
0-9 /
DealTeamRegion
Region Type
Intralinks Integration Adapter User Guide
optional
page 202
Attribute Name
Data Type
Usage
Note
Sector
Sector Type
optional
Aerospace and
Defense
Automobiles and
Components
Capital Goods
Commercial Services
and Supplies
Consumer Products
and Services
Energy and Power
Financials
Government and
Agencies
Healthcare
High Technology
Industrials
Materials
Media and
Entertainment
Real Estate
Retail
Telecommunications
Transportation
Utilities
ClientRelationshipRan
k
Client Relationship
Rank
optional
ProjectedCloseDate
string
optional
Intralinks Integration Adapter User Guide
page 203
DealFees
DealFees Elements
Element Name
Min
Max
Fee
0
unbounded
Usage
DealFees Attributes
Attribute Name
Data Type
Usage
FeeType
Fee Type
required
FeeAmount
double
required
AssociatedFeeAmount
Associated Fee
Amount Type
required
FeeFrequency
Fee Frequency Type
required
PLCode
string
required
Intralinks Integration Adapter User Guide
Note
Allowed characters:
0-9 , .
Max. char. = 50
Any character.
page 204
TrancheDetails
Intralinks Integration Adapter User Guide
page 205
TrancheDetails Elements
z
Element Name
Min
Max
Usage
TrancheDetail
0
unbounded
TrancheDetails Attributes
Attribute Name
Data Type
Usage
Note
TrancheName
string
required
Characters not allowed:
<> \
FacilityCUSIP
string
optional
Length = 9Allowed values:
0-9 A-Z a-z
Secured
boolean
optional
HighYield
boolean
optional
TrancheType
Tranche Type
required
TrancheSubType
Tranche Subtype
required
DrawDownAvailability
Draw Down Availability
Type
optional
TrancheCurrency
Currency Type
required
TargetHoldAmount
double
optional
FinalHoldAmount
double
optional
TrancheAmount
double
required
MaturityDate
string
optional
Valid dates only:
mm/dd/yy (0-9) \
MaturityValue
double
optional
Characters allowed:
0-9 , .
AssociatedWithMaturity
Associated with Maturity
Type
required
AllInRate
double
optional
AssociatedAllInRate
Associated Type
required
InterestType
Tranche Interest Type
optional
BaseRateName
Base Rate Name Type
optional
BaseRate
double
optional
AssociatedBaseRate
Associated Type
required
PriceTalk
string
optional
AssociatedPriceTalk
Associated Type
required
Intralinks Integration Adapter User Guide
Boolean values only
(true, false)
Characters allowed:
0-9 , .
Characters allowed:
0-9 , .
Characters allowed:
0-9 , .
Characters not allowed:
<> \
page 206
Attribute Name
Data Type
Usage
Note
FinalSpread
double
optional
Characters allowed:
0-9 .
AssociatedFinalSpread
Associated Type
required
Status
Status
required
Floor
double
optional
AssociatedFloor
Associated Type
required
Characters allowed:
0-9 .
AssociatedInvestors Elements
Element Name
Min
Max
AssociatedInvestor
0
unbounded
Usage
AssociatedInvestor Attributes
Attribute Name
Data Type
Usage
InvestorName
string
required
ArrangerOrganization
string
optional
OrganizationOwner
string
optional
LevelOfInterest
Level of Interest Type
optional
CommitmentAmount
double
optional
CommitmentSpread
double
optional
FinalAllocationAmount
double
optional
FinalOID
double
optional
Note
InvestorContacts Elements
Element Name
Min
Max
InvestorContact
0
unbounded
Usage
InvestorContacts Attributes
Attribute Name
Data Type
Usage
InvestorContact
string
optional
Intralinks Integration Adapter User Guide
Note
page 207
AlternativeCurrencies Elements
Element Name
Min
Max
AlternativeCurrency
0
unbounded
Usage
AlternativeCurrencies Attributes
Attribute Name
Data Type
Usage
AlternativeCurrency
Currency Type
optional
Note
TrancheFees Elements
Element Name
Min
Max
Fee
0
unbounded
Usage
TrancheFees Attributes
Attribute Name
Data Type
Usage
FeeType
Fee Type
required
FeeAmount
double
required
AssociatedFeeAmount
Associated Fee
Amount Type
required
FeeFrequency
Fee Frequency Type
required
PLCode
string
optional
Note
SubsidiaryBorrowers Elements
Element Name
Min
Max
SubsidiaryBorrower
0
unbounded
Intralinks Integration Adapter User Guide
Usage
page 208
Arrangers
Intralinks Integration Adapter User Guide
page 209
Arrangers Elements
Element Name
Min
Max
Arranger
0
unbounded
Usage
Arranger Attributes
Attribute Name
Data Type
Usage
OrganizatonName
string
required
UnderwrittenAmount
double
optional
JointBookPermission
Joint Book Permission
optional
Element Name
Min
Max
Title
1
unbounded
Attribute Name
Data Type
Usage
Title
TitleType
required
Note
Characters allowed:
0-9 , .
Titles Elements
Usage
Titles Attributes
Intralinks Integration Adapter User Guide
Note
page 210
WorkingGroup
WorkingGroup Elements
Element Name
Min
Max
Member
0
unbounded
Usage
WorkingGroup Attributes
Attribute Name
Data Type
Usage
OrganizatonName
string
required
Name
string
required
Lead
boolean
optional
Intralinks Integration Adapter User Guide
Note
Boolean only
(true, false)
page 211
InternalArranger
Intralinks Integration Adapter User Guide
page 212
InternalArranger Elements
Element Name
Min
Max
Usage
InternalArranger Attributes
Attribute Name
Data Type
Usage
Note
UnderwrittenAmount
double
optional
Allowed characters:
0-9
Element Name
Min
Max
Usage
Title
1
unbounded
required
Attribute Name
Data Type
Usage
Note
Title
TitleType
required
Titles Elements
Titles Attributes
Intralinks Integration Adapter User Guide
page 213
Commentaries
Intralinks Integration Adapter User Guide
page 214
Commentary Elements
Element Name
Min
Max
Commentary
0
unbounded
Usage
Commentary Attributes
Attribute Name
Data Type
Usage
Note
Subject
string
required
Not Allowed
/ \ : * “ < > ? | and tabs
Comment
string
required
DealName
string
optional
TrancheName
string
optional
Arranger Elements
Element Name
Min
Max
Commentary
0
1
Usage
Arranger Attributes
Attribute Name
Data Type
Usage
LegalName
string
optional
Email
string
optional
Note
Borrower Elements
Element Name
Min
Max
Commentary
0
1
Usage
Borrower Attributes
Attribute Name
Data Type
Usage
LegalName
string
optional
Email
string
optional
Intralinks Integration Adapter User Guide
Note
page 215
Investor Elements
Element Name
Min
Max
Commentary
0
1
Usage
Investor Attributes
Attribute Name
Data Type
Usage
LegalName
string
optional
Email
string
optional
Note
Report Command
This diagram shows the attributes and elements of the report command, used to
post the output file to a target exchange.
Intralinks Integration Adapter User Guide
page 216
Report attributes
Attribute Name
Data Type
Usage
Note
WorkspaceID
string
required
FolderPath
string
required
ReportName
string
optional
SortOrder
integer (zero and
negative values are
not allowed)
optional
Visibility
visibility type
optional
EffectiveDate
string
optional
ConvertFormat
string (restricted)
optional
CSV
HTML
Report elements
Element Name
Min
Max
Usage
Permission
0
1
optional
Alert
0
1
optional
CustomFields
0
1
optional
Intralinks Integration Adapter User Guide
page 217
Document-centric report
The Document-centric report will provide the user with the details of the folders,
documents, groups, users and permissions in one or more exchanges.
Two attributes are available at the job level of the input file to define the report
details. These fields will only be used when the OperationType is "Download".
The DocumentCriteria element can optionally be included to filter the document
list. The report has been enhanced to include document owner, group member
roles, and document submitter.
The report file will have the document data stored in the exchange hierarchy
defined in the following diagram.
Document-centric Report Schema (1)
Intralinks Integration Adapter User Guide
page 218
Document-centric Report Schema (2)
Intralinks Integration Adapter User Guide
page 219
Document-centric Report Publication Element
Intralinks Integration Adapter User Guide
page 220
Document-centric Report Document Element
Intralinks Integration Adapter User Guide
page 221
Document Access report
The Document Access report will provide the user with the exchange document
access history for documents, users, groups including alert information (sent,
failure status, failure description).
Document Access report schema
The following diagrams define the XML elements and attributes that are used in
the Document Access report.
Intralinks Integration Adapter User Guide
page 222
Intralinks Integration Adapter User Guide
page 223
Intralinks Integration Adapter User Guide
page 224
Intralinks Integration Adapter User Guide
page 225
User-centric report
The User-centric report provides filterable information about exchanges (names,
IDs, phases, etc.), groups (names, custom fields, etc.), and users (names,
addresses, phone numbers, whether removed, etc.).
User-centric report schema
The following diagrams define the XML elements and attributes that are used in
the User-centric report.
Intralinks Integration Adapter User Guide
page 226
User Comparison report
The User Comparison report compares user profile information in the Intralinks
application to user profile information stored on a back-end system.
Intralinks Integration Adapter User Guide
page 227
Time bound download
A time bound download allows you to download documents that were added,
documents that were modified or both new and modified documents within a
specified time frame.
When you perform a timebound download, the output file will be similar to the
following example:
<?xml version="1.0" encoding="utf-8"?>
<ProcessReport xmlns:xsd="http://www.w3.org/2001/
XMLSchema" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" ProcessingDateTime="2015-0903T13:26:53.4036012+05:30" Description=""
InputFileArchive="C:\Users\M1022338\Desktop\ILIA\Archi
ve\Archive 09.03.2015 13.26.51.xml"
MachineID="A4MD21244">
<Batch Id="1001">
<Job Id="1" OperationType="Download">
<Workspace Id="4566301" Name="smitha_Exchange"
Status="Completed">
<Command Type="Copy" ItemType="Document"
Name="~$cumentation for ILIA 4.8saasd"
Intralinks Integration Adapter User Guide
page 228
Status="Complete" Description="Successfully downloaded
file." ErrorCode="103014" />
<Command Type="Copy" ItemType="Document"
Name="Book1" Status="Complete"
Description="Successfully downloaded file."
ErrorCode="103014" />
<Command Type="Copy" ItemType="Document"
Name="Word" Status="Complete"
Description="Successfully downloaded file."
ErrorCode="103014" />
<Command Type="Copy" ItemType="Document"
Name="Word111.abc" Status="Complete"
Description="Successfully downloaded file."
ErrorCode="103014" />
<Command Type="Copy" ItemType="Document"
Name="Documentation for ILIA 4 8.absss"
Status="Complete" Description="Successfully downloaded
file." ErrorCode="103014" />
</Workspace>
</Job>
</Batch>
<ReportUpload />
</ProcessReport>
Intralinks Integration Adapter User Guide
page 229
Output report definition (.XSD)
The following diagram shows the WorkspaceDifferences element of the Output
report file.
Intralinks Integration Adapter User Guide
page 230
Output file attributes
Attribute Name
Data Type
Usage
Description
string
optional
ProcessingDateTime
DateTime
optional
InputFileArchive
string
optional
Note
Location of archived input file
Output file elements
Attribute Name
Min
Max
Usage
batch
1
unbounded
required
WorkspaceDifferences
0
unbounded
optional
Attribute Name
Data Type
Usage
Id
string
optional
Attribute Name
Min
Max
Usage
Job
1
unbounded
required
Attribute Name
Data Type
Usage
Id
string
optional
OperationType
enum
optional
Create
Remove
Update
Download
Rollback
Synchronize
Status
enum
optional
NotStarted
Completed
PartiallyCompleted
Failed
Attribute Name
Min
Max
Workspace
1
unbounded
Batch attributes
Note
Batch elements
Job attributes
Note
Job elements
Intralinks Integration Adapter User Guide
Usage
page 231
Workspace attributes
Attribute Name
Data Type
Usage
Id
string
required
Name
string
optional
Status
enum
optional
Description
string
optional
Note
NotStarted
Completed
PartiallyCompleted
Failed
Workspace elements
Attribute Name
Min
Max
Usage
Command
0
unbounded
optional
PassThroughFields
0
1*
A string to keep track
of a user, document,
folder, etc. Not
processed in XML file
but returned in XML
Output file.
* PassThroughFields can contain more than one PassThroughField.
Intralinks Integration Adapter User Guide
page 232
Command attributes
Attribute Name
Data Type
Usage
Note
Type
enum
required
Add
Update
Delete
ItemType
enum
optional
Folder
Document
Publication
Attachment
Group
User
Id
string
optional
ID of object on IL.
Name
string
optional
ID of object on IL.
Status
enum
optional
Complete
Error
Description
string
optional
Command elements
Attribute Name
Min
Max
Usage
PassThroughFields
0
1*
A string to keep track
of a user, document,
folder, etc. Not
processed in XML file
but returned in XML
Output file.
* PassThroughFields can contain more than one PassThroughField.
Workspace attributes
Attribute Name
Data Type
Usage
WorkspaceId
string
optional
Note
Workspace elements
Attribute Name
Min
Max
Usage
ContactDifferences
0
unbounded
optional
Intralinks Integration Adapter User Guide
page 233
Contact Differences attributes
Attribute Name
Data Type
EMailId
string
Note
FirstName
*
LastName
*
Org
*
Phone
*
Role
*
Address1
*
Address2
*
Address3
*
City
*
State
*
ZipCode
*
Country
*
Mobile
*
Fax
*
Title
*
Industry
*
TimeZone
*
* Element will exist only if workspace and input value are different. Both the
workspace value and the input value will be included.
Passthrough elements
Element Name
Min
Max
Usage
PassThroughField
0
1*
A string to keep track
of a user, document,
folder, etc. Not
processed in XML file
but returned in XML
Output file.
* PassThroughFields can contain more than one PassThroughField.
Intralinks Integration Adapter User Guide
page 234
Common Parameters Charts
Country
Value
Status
AFGHANISTAN
Afghanistan
ALBANIA
Albania
ALGERIA
Algeria
AMERICAN_SAMOA
American Samoa
ANDORRA
Andorra
ANGOLA
Angola
ANGUILLA
Anguilla
ANTARCTICA
Antarctica
ANTIGUA
Antigua
ARGENTINA
Argentina
ARMENIA
Armenia
ARUBA
Aruba
ASCENSION_ISLAND
Ascension Island
AUSTRALIA
Australia
AUSTRIA
Austria
AZERBAIJAN
Azerbaijan
BAHAMAS
Bahamas
BAHRAIN
Bahrain
BANGLADESH
Bangladesh
BARBADOS
Barbados
BARBUDA
Barbuda
BELARUS
Belarus
BELEM
Belem
BELGIUM
Belgium
BELIZE
Belize
BENIN
Benin
BERMUDA
Bermuda
BHUTAN
Bhutan
BOLIVIA
Bolivia
BOSNIA
Bosnia
Intralinks Integration Adapter User Guide
page 235
Value
Status
BOTSWANA
Botswana
BOUVET_ISLAND
Bouvet Island
BRAZIL
Brazil
BRITISH_VIRGIN_ISLANDS
British Virgin Islands
BRUNEI_DARUSSALM
Brunei Darussalm
BULGARIA
Bulgaria
BURKINA_FASO
Burkina Faso (former Upper Volta)
BURUNDI
Burundi
CAMBODIA
Cambodia
CAMEROON
Cameroon
CANADA
Canada
CAPE_VERDE
Cape Verde
CAYMAN_ISLANDS
Cayman Islands
CENTRAL_AFRICAN_REPUBLIC
Central African Republic
CHAD
Chad
CHILE
Chile
CHINA
China (People's Republic)
CHRISTMAS_ISLAND
Christmas Island
CIS
CIS
COCOS_KEELING_ISLANDS
Cocos Keeling Islands
COLOMBIA
Colombia
CONGO
Congo
COOK_ISLANDS
Cook Islands
COMOROS
Comoros
COSTA_RICA
Costa Rica
CROATIA
Croatia
CUBA
Cuba
CYPRUS
Cyprus
CZECH_REPUBLIC
Czech Republic
DENMARK
Denmark
DIEGO_GARCIA
Diego Garcia
DJIBOUTI
El Salvador
DOMINICA
Dominica
Intralinks Integration Adapter User Guide
page 236
Value
Status
DOMINICAN_REPUBLIC
Dominican Republic
ECUADOR
Djibouti
EGYPT
Ecuador
EL_SALVADOR
Egypt
EQUATORIAL_GUINEA
Equatorial Guinea
ERITREA
Eritrea
ESTONIA
Estonia
ETHIOPIA
Ethiopia
FALKLAND_ISLANDS
Falkland Islands
FAROEISLANDS
Faroe Islands
FIJI
Fiji
FINLAND
Finland
FRANCE
France
FRENCH_GUIANA
French Guiana
FRENCH_POLYNESIA
French Polynesia
FRENCH_SOUTHERN_TERRITORIES
French Southern Territories
FYROM
Fyrom (Macedonia)
GABON
Gabon (Gabonese Republic)
GAMBIA
Gambia
GEORGIA
Georgia
GERMANY
Germany
GHANA
Ghana
GIBRALTAR
Gibraltar
GRAND_CAYMAN
Grand Cayman
GREECE
Greece
GREENLAND
Greenland
GRENADA
Grenada
GUADELOUPE
Guadeloupe
GUAM
Guam
GUANTANAMO_BAY
Guantanamo Bay
GUATEMALA
Guatemala
GUERNSEY
Guernsey
GUINEA
Guinea
Intralinks Integration Adapter User Guide
page 237
Value
Status
GUINEA_BISSAU
Guinea-Bissau
GUYANA
Guyana
HAITI
Haiti
HEARD_ISLAND_AND_MCDONALD_ISLA
NDS
Heard Island and Mcdonald Islands
HERZEGOVINA
Herzegovina
HONDURAS
Honduras
HONG_KONG
Hong Kong
HUNGARY
Hungary
ICELAND
Iceland
INDIA
India
INDONESIA
Indonesia
IRAN
Iran
IRAQ
Iraq
IRELAND
Ireland (Irish Republic, Eire)
ISLE_OF_MAN
Isle of Man
ISRAEL
Israel
ITALY
Italy
IVORY_COAST
Ivory Coast (La Cote d'Ivoire)
JAMAICA
Jamaica
JAPAN
Japan
JERSEY
Jersey
JORDAN
Jordan
KAZAKHSTAN
Kazakhstan
KENYA
Kenya
KHMER_REPUBLIC
Khmer Republic (Cambodia/Kampuchea)
KIRIBATI_REPUBLIC
Kiribati Republic (Gilbert Islands)
KOREA_REPUBLIC_OF_SOUTH_KOREA
Korea, Republic of (South Korea)
KUWAIT
Kuwait
KYRGYSTAN
Kyrgystan
LAOS
Laos
LATVIA
Latvia
LEBANON
Lebanon
LESOTHO
Lesotho
Intralinks Integration Adapter User Guide
page 238
Value
Status
LIBERIA
Liberia
LIBYA
Libya
LIECHTENSTEIN
Liechtenstein
LITHUANIA
Lithuania
LUXEMBOURG
Luxembourg
MACAO
Macao
MACEDONIA
Macedonia
MADAGASCAR
Madagascar
MALAWI
Malawi
MALAYSIA
Malaysia
MALDIVES
Maldives
MALI
Mali
MALTA
Malta
MARSHALL_ISLANDS
Marshall Islands
MARTINIQUE
Martinique (French Antilles)
MAURITANIA
Mauritania
MAURITIUS
Mauritius
MAYOTTE
Mayotte
MEXICO
Mexico
MICRONESIA
Micronesia (F.S. of Polynesia)
MIDWAY_ISLANDS
Midway Islands
MOLDOVA
Moldova
MONACO
Monaco
MONGOLIA
Mongolia
MONTENEGRO
Montenegro
MONTSERRAT
Montserrat
MOROCCO
Morocco
MOZAMBIQUE
Mozambique
MYANMAR
Myanmar (Burma)
NAMIBIA
Namibia (former South-West Africa)
NAURU
Nauru
NEPAL
Nepal
NETHERLANDS
Netherlands
Intralinks Integration Adapter User Guide
page 239
Value
Status
NETHERLANDS_ANTILLES
Netherlands Antilles
NEW_CALEDONIA
New Caledonia
NEW_ZEALAND
New Zealand
NICARAGUA
Nicaragua
NIGER
Niger
NIGERIA
Nigeria
NIUE
Niue
NORFOLK_ISLAND
Norfolk Island
NORTH_KOREA
North Korea
NORTH_MARIANA_ISLANDS
North Mariana Islands (Saipan)
NORWAY
Norway
OMAN
Oman
PAKISTAN
Pakistan
PALAU
Palau
PALESTINIAN_TERRITORY
Palestinian Territory
PANAMA
Panama
PAPUA_NEW_GUINEA
Papua New Guinea
PARAGUAY
Paraguay
PERU
Peru
PHILIPPINES
Philippines
PITCAIRN
Pitcairn
POLAND
Poland
PORTUGAL
Portugal (includes Azores)
PUERTO_RICO
Puerto Rico
QATAR
Qatar
REUNION
Reunion (France)
ROMANIA
Romania
RUSSIA
Russia
RWANDA
Rwanda (Rwandese Republic)
SAINT_KITTS_AND_NEVIS
Saint Kitts and Nevis
SAINT_LUCIA
Saint Lucia
SAINT_MARTIN
Saint Martin
SAINT_VINCENT_AND_THE_GRENADINE
S
Saint Vincent and the Grenadines
Intralinks Integration Adapter User Guide
page 240
Value
Status
SAN_MARINO
San Marino
SAO_TOME_AND_PRINCIPE
Sao Tome and Principe
SAUDI_ARABIA
Saudi Arabia
SENEGAL
Senegal
SERBIA
Serbia, Republic of
SEYCHELLES
Seychelles
SIERRA_LEONE
Sierra Leone
SINGAPORE
Singapore
SLOVAKIA
Slovakia
SLOVENIA
Slovenia
SOLOMON_ISLANDS
Solomon Islands
SOMALIA
Somalia
SOUTH_AFRICA
South Africa
SOUTH_GEORGIA_AND_THE_SOUTH_SA
NDWICH_ISLANDS
South Georgia and the South Sandwich Islands
SPAIN
Spain (including Balearic Islands)
SRI_LANKA
Sri Lanka
ST_HELENA
St. Helena
ST_PIERRE
St. Pierre &(et) Miquelon (France)
SUDAN
Sudan
SURINAME
Suriname
SVALBARD_AND_JAN_MAYEN
Svalbard and Jan Mayens
SWAZILAND
Swaziland
SWEDEN
Sweden
SWITZERLAND
Switzerland
SYRIAN_ARAB_REPUBLIC
Syrian Arab Republic (Syria)
TAHITI
Tahiti (French Polynesia)
TAIWAN
Taiwan
TAJIKISTAN
Tajikistan
TANZANIA
Tanzania (includes Zanzibar)
THAILAND
Thailand
TIMOR-LESTE
Timor-Leste
TOGO_TOGOLESE_REPUBLIC
Togo (Togolese Republic)
TOKELAU
Tokelau
Intralinks Integration Adapter User Guide
page 241
Value
Status
TONGA
Tonga
TRINIDAD_AND_TOBAGO
Trinidad and Tobago
TUNISIA
Tunisia
TURKEY
Turkey
TURKMENISTAN
Turkmenistan
TURKS_AND_CAICOS_ISLANDS
Turks and Caicos Islands
TUVALU
Tuvalu (Ellice Islands)
UGANDA
Uganda
UKRAINE
Ukraine
UNITED_ARAB_EMIRATES
United Arab Emirates
UNITED_STATES_MINOR_OUTLYING_ISL
ANDS
United States Minor Outlying Islands
UNITED_KINGDOM
United Kingdom
URUGUAY
Uruguay (East Republic)
UNITED_STATES
United States
UZBEKISTAN
Uzbekistan
VANUATU
Vanuatu (New Hebrides)
VATICAN_CITY
Vatican City
VENEZUELA
Venezuela
VIETNAM
Vietnam
VIRGIN_ISLANDS_BRITISH
Virgin Islands British
VIRGIN_ISLANDS_US
Virgin Islands US
WALLIS_AND_FUTUNA
Wallis and Futuna
WESTERN_SAHARA
Western Sahara
WESTERN_SAMOA
Western Samoa
YEMEN_ARAB_REPUBLIC
Yemen Arab Republic (North Yemen)
YUGOSLAVIA
Yugoslavia
ZAIRE
Zaire (former Republic of the Congo)
ZAMBIA
Zambia
ZIMBABWE
Zimbabwe
Intralinks Integration Adapter User Guide
page 242
Roles
KEY
VALUE
REVIEWER
reviewer
PREVIEWER
previewer
PUBLISHER
publisher
MANAGER_LTD
manager ltd
MANAGER
manager
REVIEWER_PLUS
reviewer+
PUBLISHER_PLUS
publisher+
HIDDEN_MANAGER_PLUS
(manager+)
MANAGER_PLUS
manager+
WS_ADMIN
ws_admin
Title
Value
Industry
ANALYST
Analyst
ASSISTANT_SUPPORT_STAFF
Assistant / Support Staff
ASSOCIATE
Associate
BOARD_MEMBER
Board Member
CHAIRMAN_PRESIDENT_CEO
Chairman / President / CEO
C_LEVEL_OTHER
C-Level (Other)
COMPLIANCE_OFFICER
Compliance Officer
CONTROLLER_TREASURER
Controller / Treasurer
DOCTOR_PHYSICIAN
Doctor / Physician
ENGINEER_RESEARCHER_SCIENTIST
Engineer / Researcher / Scientist
GC_OTHER_COUNSEL
GC / Other Counsel
GENERAL_MANAGER
General Manager
MANAGER_SUPERVISOR
Manager / Supervisor
MANAGING_DIRECTOR_DIRECTOR
Managing Director / Director
OTHER
Other
PARTNER
Partner
PROJECT_MANAGER
Project Manager
TRADER
Trader
Intralinks Integration Adapter User Guide
page 243
Value
Industry
UNAVAILABLE
Unavailable
VP_SVP_EVP
VP / SVP / EVP
Functional Area
Value
Industry
ASSET_BACKED_SECURITIES
Asset Backed Securities
COMMERCIAL_LOANS
Commercial Loans
COMPLIANCE_RISK_REGULATORY_AFFAIRS
Compliance / Risk / Regulatory Affairs
CONSULTING_ADVISORY
Consulting / Advisory
CORPORATE_DEVELOPMENT_PARTNERSHIP
S
Corporate Development/Partnerships
CUSTOMER_SERVICE
Customer Service
FINANCE_INTERNAL
Finance (Internal)
HEDGE_FUND
Hedge Fund
HUMAN_RESOURCES
Human Resources
INFORMATION_TECHNOLOGY
Information Technology
INSTITUTIONAL_INVESTING
Institutional Investing
INVESTMENT_BANKING
Investment Banking
LAW_FIRM_LITIGATION
Law Firm - Litigation
LAW_FIRM_MA
Law Firm - M&A
LAW_FIRM_OTHER
Law Firm - Other
LEGAL_IN_HOUSE
Legal (In-House)
LOAN_SYNDICATION_SERVICING
Loan Syndication & Servicing
OPERATIONS
Operations
PRIVATE_EQUITY
Private Equity
PROCUREMENT
Procurement
RESEARCH_AND_DEVELOPMENT
Research and Development
SALES_AND_MARKETING
Sales and Marketing
UNAVAILABLE
Unavailable (User opts not to specify)
Intralinks Integration Adapter User Guide
page 244
Industry
Value
Industry
ADVERTISING_MARKETING_PR
Advertising/Marketing PR
AEROSPACE
Aerospace
AGRICULTURE_CHEMICALS_FOREST_PRODUCT
S
Agriculture/Chemicals/Forest Products
AUTOMOTIVE
Automotive
BUSINESS_PROFESSIONAL_SERVICES
Professional Services
CONSUMER_GOODS
Consumer Goods
EDUCATION
Education
ENERGY_UTILITIES
Energy Utilities
FINANCIAL_SERVICES
Financial Services
GOVERNMENT_MILITARY_PUBLIC_SERVICE
Government/Military/Public
HEALTHCARE_MEDICAL
Healthcare
HOSPITALITY_RECREATION
Hospitality/Recreation
INSURANCE
Insurance
MANUFACTURING_CONSTRUCTION_INDUSTRIAL
S
Manufacturing/Construction/Industrial
MEDIA_PUBLISHING_ENTERTAINMENT
Media/Publishing/Entertainment
METALS_MINING
Metals/Mining
OTHER
Other
PHARMACEUTICALS_BIOTECHNOLOGY
Pharmaceuticals/Biotechnology
REAL_ESTATE
Real Estate
RETAIL
Retails
SUSTAINABILITY
Sustainability
TECHNOLOGY_COMPUTERS_ELECTRONICS
Technology/Computers/Electronics
TELECOMMUNICATIONS_NETWORKING
Telecommunications/Networking
TRAVEL_TRANSPORTATION
Travel/Transportation
UNAVAILABLE
Unavailable
TimeZone
Use the Time Zones Chart to refer to the time zone mentioned in the Response/Request XML
of any API.
Name
ID
Description
The Hours from GMT
ACST
34
Australian Central Standard Time
GMT+9.5
Intralinks Integration Adapter User Guide
page 245
Name
ID
Description
The Hours from GMT
ACDT
35
Australian Central Daylight Time
GMT+10.5
CST
1
Central Standard Time
GMT-06
EST
2
Eastern Standard Time
GMT-05
MST
3
Mountain Daylight Time
GMT-07
BuenosAires
5
PST
6
YST
7
GMT-09
AHST, EAST
8
GMT-10
GMTMinus12
9
GMT-12
NT
10
GMT-11
AST, EDT
17
GMT-04
AT
18
GMT-02
GMT
19
CET
20
GMT+01
EET
21
GMT+02
BT
22
GMT+03
ZP4
23
GMT+04
ZP5
24
GMT+05
ZP6
25
GMT+06
WAST
26
GMT+07
CCT
27
GMT+08
JST
28
GMT+09
GST
29
GMT+10
GMTPlus11
30
GMT+11
NZST
31
GMT+12
WAT
32
GMT+01
NZST2
34L
GMT+13
GMT-03
Pacific Standard Time
Greenwich Mean Time
Intralinks Integration Adapter User Guide
GMT-08
GMT
page 246
Chapter 8: Troubleshooting
Overview
This chapter describes issues that you may encounter while using the Intralinks
Integration Adapter and provides actions you can take to resolve them.
Category
Error Number Range
User/participant processing errors
100000
Group processing errors
101000
Folder processing errors
102000
Document/attachment processing errors
103000
Exchange/workspace processing errors
104000
Publication/attachment processing errors
105000
Custom field processing errors
106000
Login processing errors
108000
Intralinks Courier-related errors
109000
Report processing errors
110000
General processing and rollback errors
111000
Amendment Voting processing errors
112000
DMS processing errors
113000
In addition, messages from Intralinks Platform may be displayed if files cannot be
encrypted when they are added to an Intralinks Platform exchange. View
Intralinks Platform errors.
Intralinks Integration Adapter User Guide
page 247
Error messages
User/participant processing errors
No.
Problem
100000
An email ID was provided for a placeholder user. We will add this contact to the
exchange with the email address, as a
non-placeholder user.
No action required.
100001
The AddRemovedUsers attribute is no
longer supported. Please use the AddUserProtectionPeriod instead.
Replace the AddRemovedUsers attribute
with the AddUserProtectionPeriod attribute
in the XML Input file.
100002
Group member roles are not enabled on
the exchange. The member roles will be
ignored.
You cannot specify group member roles if
member roles are not enabled on this
exchange. Check with your Intralinks
exchange manager to enable group member
roles on this exchange.
100003
This exchange does not allow you to send
email notifications to users who have been
removed.
You can have your IL administer update the
exchange to allow sending email alerts to
users who have been removed.
100004
Users that removed themselves cannot be
re-added to the exchange.
No action required.
100005
The language that you selected is not supported by Intralinks.
Select another language from among the following:
- English (default)
- French
- German
- Japanese
- Portuguese
- Spanish
- Chinese
100006
This user has already set his language
preference. You cannot change this selection.
No action required.
100007
The role "{0}" is invalid and will be ignored.
No action required.
100008
User role must be at least Manager to be
a key contact.
Assign another key contact or consult your
Intralinks exchange manager about changing the user’s role.
100009
The remove user custom alert has been
successfully set.
No action required.
100010
A user update was requested but no
changes were entered.
No action required.
100011
We could not find any users who matched
the user criteria you specified.
Not all the criteria you specify will produce
results.
100012
User member roles can only be set at the
group level.
Member roles can only be assigned to users
in a group. See “Set member roles of new
users” or “Set member roles of existing
users” under Groups and users.
Intralinks Integration Adapter User Guide
Resolution
page 248
No.
Problem
100013
You cannot add this user to the exchange
because the user was recently removed
and ILIA is presently configured to prevent
re-addition of users within a specified time
period (protection period).
Consult your Intralinks exchange manager
about changing this setting, if desired.
100014
User cannot be removed from the
exchange because ILIA is presently configured to prevent removal of certain
classes of user.
The rules governing user removal/addition
can be updated in the ILIA Configuration
Manager, if desired.
100015
User was not found.
Verify whether the information you entered
for this user is correct in the XML Input file.
User may have been deregistered.
100016
Alert could not be sent to user {0}.
No action required.
100017
The specified alert recipient was not
found.
Verify that the recipient is a member of the
exchange. Verify that you entered the correct user name or user email address in the
XML Input file.
100018
Successfully activated the alerts  for
user {0}.
No action required.
100019
Incorrectly formed email address
Verify the email address in your XML Input
file.
100020
No recipient was specified for alert
Verify whether you specified a recipient in
your XML Input file.
100021
The user is already present in the
exchange.
No action required.
100022
The number of users being added
exceeds the limitation.You cannot add
more than 200 users in a single XML input
file.
Verify that your XML Input file contains
fewer than 200 users. You can enter multiple
XML Input files.
100023
You cannot modify your own role.
No action required.
100024
You cannot perform actions on a user
whose role is Admin.
No action required.
100025
The user returned is deregistered.
Please contact Intralinks customer service.
100026
The specified Exchange Role Type is
either null or empty!
Verify that you entered a valid Exchange
Role Type in the XML Input file.
100027
User does not have required permissions
to perform given action
See your Intralinks exchange manager
about changing user permissions.
100028
You do not have permission to perform
this task.
See your Intralinks exchange manager
about changing user permissions.
100029
Your role and rights on the exchange have
changed.
See your Intralinks exchange manager
about changing your role and rights.
100030
The user you specified is deregistered.
Please contact Intralinks customer service.
Intralinks Integration Adapter User Guide
Resolution
page 249
No.
Problem
Resolution
100031
The selected user was not found on the
exchange.
Verify whether the user is on the specified
exchange and whether you have entered the
user name and exchange correctly in the
XML Input file.
100032
The user is not registered or has been
suspended. Please contact Intralinks customer service for assistance.
Please contact Intralinks customer service
for assistance.
100033
You cannot select an exchange role that
has more rights than your role.
Select another exchange role or contact
your Intralinks exchange manager about
changing your role.
100034
You cannot add exchange users while
creating or updating a buyer group. In
addition, you cannot remove a member
while updating the buyer group.
These actions cannot be performed in the
same job. Submit separate jobs for each
operation.
100035
The selected role cannot be used with this
group.
No action required.
100036
The user was not found.
Verify whether the user is on the specified
exchange and whether you have entered the
user name and exchange correctly in the
XML Input file.
100037
The user could not be removed from the
exchange. The user may be a member of
a department on the exchange.
No action required.
100038
Some required information for this user is
missing, or information is in the wrong format. Please review your entries.
Verify whether the information you entered
for this user is correct in the XML Input file.
100039
The contact's first name, last name,
phone, or organization provided differs
from the parameters stored in Intralinks.
The existing information will be used
instead
No action required.
100040
The contact's first name, last name,
phone, or organization provided differs
from the parameters stored in Intralinks.
The existing information will be used
No action required.
100041
This person already is a member of the
exchange.
No action required.
100042
No record exists for this person. Please
create a new record for the person.
Add a new user using the XML Input file.
100043
You cannot add a user with an exchange
role that has more rights than your role.
Change the user’s exchange role in the XML
Input file or consult your Intralinks exchange
manager about changing your role.
100044
You cannot add a user with this role.
For role-related issues, consult your Intralinks exchange manager.
100045
Users with the selected role cannot be primary contacts for the exchange.
Select another primary contact or consult
with your Intralinks exchange manager
about changing the role of the user.
Intralinks Integration Adapter User Guide
page 250
No.
Problem
Resolution
100046
You cannot update information for a user
who is a member of a Buyer group.
No action required.
100047
This user cannot be removed. You cannot
remove self or user who is present in a
department.
No action required.
100048
User does not exist on the exchange or
don't have permission to update the user.
Verify the location of the user on the
exchange. For permission issues, consult
your Intralinks exchange manager.
100049
Information for one of the following user
profile fields is incorrect: Title, Industry,
Country, Time Zone, Functional Area
Check your entries for these fields in the
XML Input file.
100050
You cannot add profile information when
adding users to this exchange.
No action required.
100051
Your rights to view this exchange have
changed. You are no longer allowed to
access the exchange.
Consult your Intralinks exchange manager
about your role and permissions.
100052
You are not allowed to remove yourself
from this exchange.
No action required.
100053
The contact's first name is too long.
Please enter a shorter name.
Enter a shorter name for this user in the
XML Input file.
100054
The user group name is too long. Please
enter a shorter name.
Enter a shorter name for this group in the
XML Input file.
Limit 49 characters.
100055
An email address is required.
Enter an email address for this user in the
XML Input file.
100056
A first name is required.
Enter a first name for this user in the XML
Input file.
Limit 29 characters.
100057
The format of the email address is invalid.
Enter a valid email address in the XML Input
file.
100058
The format of the fax number is invalid.
Enter a valid fax number in the XML Input
file.
100059
The format of the mobile number is
invalid.
Enter a valid mobile phone number in the
XML Input file.
100060
The format of the phone number is invalid.
Enter a valid phone number in the XML Input
file.
100061
A last name is required.
Enter a last name for this user in the XML
Input file.
Limit 29 characters.
100062
No user data was supplied.
Intralinks Integration Adapter User Guide
Enter the required user data in the XML
input file.
page 251
No.
100063
Problem
An organization name is required.
Resolution
Enter an organization name in the XML Input
file.
Limit 49 characters.
100064
A phone number is required.
Enter a phone number in the XML Input file.
100065
The first name is invalid. The following
characters are not allowed: / @ ~ % + : , {
} ( ) [ ] < > | ` ; \ ."
Enter a valid first name in the XML Input file.
The group name is invalid. Its name cannot include the following characters: / \ < >
Enter a valid group name in the XML Input
file.
100066
Limit 29 characters.
Limit 49 characters.
100067
100068
The last name is invalid. The following
characters are not allowed: / @ ~ % + : , {
} ( ) [ ] < > | ` ; \ ."
Enter a valid last name in the XML Input file.
The organizationname is invalid. The following characters are not allowed: / @ ~
% + : { } ( ) [ ] < > | ` ; \ ."
Enter a valid organization name in the XML
Input file.
Limit 29 characters.
Limit 49 characters.
100069
The contact's last name is too long.
Please enter a shorter name.
Enter a valid last name for the contact in the
XML Input file.
Limit 29 characters.
100070
The organization name is too long. Please
enter a shorter name.
Enter a valid organization name for the contact in the XML Input file.
Limit 49 characters.
100071
The user could not be assigned as a
Question Submitter. The Q&A setting is
not enabled on this exchange.
See your Intralinks exchange manager
about enabling the Q&A setting on this
exchange.
100072
Buyer feature is disabled. User can not be
marked/unmarked as Question Submitter.
See your Intralinks exchange manager
about enabling the Buyer Groups on the
exchange.
100073
The user could not be assigned as a
Question Submitter because he/she is not
a member of a Buyer Group.
Please ensure that this user is a member of
a Buyer Group.
100074
User can be marked/unmarked Question
Submitter when operation types are create/update/synchronize.
Operation type must be create, update, or
synchronize to mark or unmark a Question
Submitter.
100075
The Attribute Question Submitter is not
declared.
You must declare a value for the Question
Submitter attribute. Options are “true” or
“false”.
100076
Mobile number length is longer than the
maximum allowed length. This must be
less than 29 character long.
Reenter the mobile number in the XML Input
file.
100077
You do not have the necessary permissions to perform this task.
See your Intralinks exchange manager
about changing your permissions.
Intralinks Integration Adapter User Guide
page 252
No.
Problem
Resolution
100079
The document is a placeholder. It cannot
be downloaded.
No action required.
100081
The To date is required.
Enter the end of the date range you want to
include in the download.
100082
The From date is required.
Enter the start of the date range you want to
include in the download.
100083
The To date has an invalid format.
Review the date format specified in the input
XML file. Modify either the date format or the
date so that the date uses the specified date
format.
100084
The From date has an invalid format.
Review the date format specified in the input
XML file. Modify either the date format or the
date so that the date uses the specified date
format.
100086
A document type must be specified for
Timebound.
Enter a document type (Created, Updated,
or Both)
100087
DownloadType is required if FromDate,
ToDate and DocumentType are specified.
Enter a download type.
100088
The time duration exceeded the maximum
limit.
Enter a shorter time span for the download.
30 days maximum.
100089
The From date must be earlier than the To
date
Check your entries; be sure that the start of
the date range is earlier than the end of the
range.
100090
IL5 workspaces are not supported in the
TimeBound download.
Select only ILP exchanges when performing
a TimeBound download.
100091
A document update was requested, but no
changes were entered.
No action required.
Group processing errors
No.
Problem
Resolution
101000
This group cannot be created as long as
the configuration setting has the Group
Creation option disabled.
Consult with your Intralinks exchange manager about enabling the Group Creation
option setting.
101001
Default folder name exceeds character
limitation. Group folder not set.
Enter a valid folder name in the XML Input
file.
Limit 60 characters.
Intralinks Integration Adapter User Guide
page 253
No.
Problem
101002
Default folder name contains illegal characters. Group folder not set.
Resolution
Enter a valid folder name in the XML Input
file.
For IL5, two consecutive forward slashes (//)
are not allowed, but a single forward slash is
allowed.
For Intralinks Platform, the following characters are not allowed:
/ \ : * " <> ? |
Limit 60 characters for either platform.
101003
Default folder not available on IL5
exchanges. DefaultFolder will be ignored.
No action required.
101004
The application cannot find a group that
matched the criteria you specified.
Not all the criteria you specify will produce
results.
101005
You can only specify a new name for a
group when performing an Update operation.
Specify an Update operation in the XML
Input file to change the group name.
101006
The specified group cannot be removed.
Verify that your setting in the Configuration
Manager (under Group Processing Options)
allows you to remove empty groups.
101008
The new group name is invalid. The name
cannot include the following characters: / \
<>
Verify the group name you entered in the
XML Input file is valid.
101009
Invalid default folder name. Group folder
not set.
Verify the folder name you entered in the
XML Input file is valid.
For IL5, two consecutive forward slashes (//)
are not allowed, but a single forward slash is
allowed.
For Intralinks Platform, the following characters are not allowed:
/ \ : * " <> ? |
60 characters maximum (for either platform).
101010
The new group name is too long. Please
enter a shorter name.
Re-enter the group name in the XML Input
file.
49 characters maximum (for either platform)
101011
Full Text Search is not enabled on the
exchange. FTSEnable will be ignored.
Consult with your Intralinks exchange manager if you wish to have FTS enabled on this
exchange.
101012
Groups cannot be changed when synchronizing user information. Please
remove the Groups from XML Input file.
Remove the groups from the XML Input file.
101013
RemoveMembersFromExchange can only
be used with the Remove operation. The
setting will be ignored.
Include a Remove operation or delete the
RemoveMembersFromExchange from the
XML Input file.
Intralinks Integration Adapter User Guide
page 254
No.
Problem
Resolution
101014
RemoveMembersFromExchange will be
ignored when group users are specified in
the XML input file.
Only the specific users you mentioned in the
XML Input file were removed. If you want to
remove all the users in the group, use the
Remove Members from Exchange command and don’t mention individual users.
101015
Group Id or Name required.
Enter a valid Group ID or name in the XML
Input file.
101016
Alert group could not be found by custom
field match.
ILIA did not find any groups that matched
your custom field.
101017
Alert group could not be identified by
email ID.
ILIA did not find any groups that matched the
email ID you entered.
101018
Alert group could not be identified by
group ID.
ILIA did not find any groups that matched the
group ID you entered.
101019
Alert group could not be identified by
group name.
ILIA did not find any groups that matched the
group name you entered.
101020
Alert group and recipient identifiers are
missing.
Enter valid alert groups or recipient identifiers in the XML Input file.
101021
AllPermissionedUsers cannot be used
when specifying groups or recipients. AllPermissionedUsers setting will be
ignored.
You can’t alert everyone and also specify
individual users to alert. Choose one method
or the other.
101022
Successfully activated the alerts  for
group {0}.
No action required.
101023
Group not found. Document owner could
not be set.
Verify that the group exists on the specified
exchange and that the group name matches
your entry in the XML Input file.
101024
You are trying to permission one or more
groups and the permission criteria you
specified does not match any of these
groups.
Check your XML Input file to verify that the
criteria you specified for these permissions
is valid.
101025
Cannot find group {0} you are trying to
permission.
Verify that the group exists on the specified
exchange and that the group name matches
your entry in the XML Input file.
101026
Permission identifiers are missing.
Enter the permission identifiers in your XML
Input file.
101027
The Replace attribute is not supported on
IL5 Exchanges. Permissions have not
been applied.
You cannot append permissions on an IL5
exchange.
101028
Permission group {0} successfully set
No action required.
101029
Control Permission is not supported for
AllUsers Group
No action required.
101030
Target folder only allowed when updating
folder.
You cannot use the Target Folder attribute
when creating or removing folders. Check
you XML Input file.
Intralinks Integration Adapter User Guide
page 255
No.
Problem
Resolution
101031
Group does not exist
Verify that the group exists on the specified
exchange and that the group name matches
your entry in the XML Input file.
101032
Exchange Group Type can only be
<EXCHANGE>
Verify that the group type is Exchange in the
XML Input file.
101033
If the number of groups in an exchange
exceeds the limit configured
Consult your Intralinks exchange manager.
101034
The group that you selected was not
found. It may have been deleted.
Verify that the group exists on the specified
exchange and that the group name matches
your entry in the XML Input file.
101035
An existing Exchange Group already has
this name.
Enter a new name for the Exchange Group
in the XML Input file.
101036
You have specified and invalid Group
Type. The options are: Exchange, Collaboration, Buyer.
Enter a valid Exchange Group Type in the
XML Input file.
101037
Exchange Group Name 'ALL USERS' is
reserved
Enter a valid name for the Exchange Group
in the XML Input file.
101038
Multiple Exchange Group creation is not
supported
You can only create a single exchange
group.
101039
Group does not exist.
Verify that the group exists on the specified
exchange and that the group name matches
your entry in the XML Input file.
101040
The group name is reserved. Please enter
another name.
Enter a valid name for the group in the XML
Input file.
101041
The group is being updated by another
user. Please try again later.
Wait for several minutes and the resubmit
you XML Input file.
101042
Another group has been assigned this
name. Please enter another name.
Enter a valid name for the group in the XML
Input file.
101043
You do not have permission to update the
group.
If you need to change your permissions,
consult your Intralinks exchange manager.
101044
You do not have permission to access the
groups in this exchange.
If you need to change your permissions,
consult your Intralinks exchange manager.
101045
You do not have permission to remove
this group.
If you need to change your permissions,
consult your Intralinks exchange manager.
101046
You have supplied invalid data when creating this group.
Consult Appendix B in this User Guide for
data specifications.
101047
You do not have permission to create
groups.
If you need to change your permissions,
consult your Intralinks exchange manager.
101048
You have specified and invalid Group
type. The options are: Exchange, Collaboration, Buyer.
Enter a valid group type in the XML Input
file.
101049
You cannot create Collaboration or Buyer
groups on this exchange.
No action required.
Intralinks Integration Adapter User Guide
page 256
No.
Problem
Resolution
101050
The selected group does not belong to
this exchange.
Verify that the group and exchange names
match your entries in the XML Input file.
101051
Exchange group is not empty.
No action required.
101052
Default folder can not be defined empty
explicitly when operation type is create.
Please consult your Intralinks exchange
manager.
101053
You cannot add or remove users from the
All Users Group.
No action required.
101054
You cannot create, update, or remove the
All Users Group.
No action required.
101055
You cannot apply permissions to the All
Users Group.
No action required.
101056
You cannot have Groups and Users in the
same input file.
When performing a synchronization of users
and groups, the users element is mentioned
under the Workspace and the Groups element is also mentioned under the Workspace. This is not allowed.
101057
Group does not match group filters.
This group can’t be updated according to the
settings you have indicated in the ILIA Configuration Manager.
101058
Exchange level settings for allusers group
is disabled
Ensure that the All Users Group is enabled
on the exchange.
101059
The Group Note is too long.
Enter a shorter note. The maximum length is
200 characters.
101060
All of the characters in the group name {0}
are unsupported.
Enter a new name for the group. See the
Intralinks Integration Adapter User Guide,
Appendix B, for character limitations.
101061
Option for create group in synchronization
is not set. Cannot create Group.
Change your “Create groups that do not
already exist” setting in the ILIA Configuration Manager.
Intralinks Integration Adapter User Guide
page 257
Folder processing errors
No.
Problem
Resolution
102000
The requested smart folder was not found
in the system
Consult your Intralinks exchange manager.
102001
The folder has new documents in it that
are not in the output file. It cannot be
rolled back. You can manually remove this
folder.
ILIA will not rollback a folder if items were
added to the folder independent of the Rollback file. You can manually remove this
folder.
102002
A matching folder could not be found.
Verify that the folder name entered in the
Input XML file is valid.
102003
When assigning permissions, the Create
attribute can only be assigned to folders.
Create permission is allowed at the folder
level only. Check the XML file to ensure that
create attribute is applied to the folder level
permission.
102004
Folder could not be created because the
“Create Folders That Do Not Exist” setting
is turned off.
Correct the XML Input file or check with your
Intralinks exchange manager if you need to
change this setting.
102005
Failed to create folder.
Consult your Intralinks exchange manager.
102006
Could not find folder Id.
Verify that the folder ID entered in the Input
XML file is valid.
102007
Folder Id is not supported when creating a
folder. Please provide a folder name.
Enter a valid folder name in the XML Input
file.
102008
Folder name exceeds the character limitation.
Enter a valid folder name that does not
exceed the character limitation.
For IL5: 60 characters.
For Intralinks Platform: 60 characters.
102009
Folder name contains invalid characters.
Enter a valid folder name that does not contain illegal characters.
For IL5, two consecutive forward slashes ( //
) are not allowed, but a single forward slash
is allowed.
For Intralinks Platform, the following characters are not allowed:
/\:*"<>?|
102010
Folder note exceeds character limitation.
Enter a valid folder note in the XML Input
file.
Maximum length for folder note = 4000 characters.
102011
The folder has new documents in it that
are not in the output file. It cannot be
rolled back. You can manually remove this
folder.
Intralinks Integration Adapter User Guide
If you want, you can manually remove this
folder.
page 258
No.
Problem
Resolution
102012
Folder path not found on local system.
Verify that the folder path you entered in the
XML Input file under Local Path is a valid
path on your system.
102013
Target folder not found. Folder cannot be
moved.
Check the Input XML file to verify that the
right folder path is provided.
102014
Specified id is not a folder.
Check the XML Input file to verify that the
right folder ID is provided.
102215
Folder name is missing.
Check the Input XML file to verify that the
folder name was included.
102016
A folder name or id is required.
Check the XML file to ensure that you
entered a folder name or ID.
102017
Could not find folder to apply permission.
Verify that the location of the folder you want
to permission and correct the XML Input file,
if necessary.
102018
Index is not allowed on subfolders and will
be ignored.
No action required.
102019
Folder can only be renamed when updating folder.
Use the Update command in your XML Input
file to rename the folder.
102020
Unindexed folder/publication should not
have an index number. The index number
was removed.
No action required.
102021
Index was changed to start at 1.First index
at any level should be 1 (with padding).
No action required.
102022
Folder had no index number. An index
number was added.
No action required.
102023
Folder index number was incorrect. It was
changed to match its parent folder.
No action required.
102024
Folder’s index number was incorrect. It
was changed to match the previous folder.
No action required.
102025
Sort orders are not allowed for folders.
The sort number was removed.
No action required.
102026
Folder cannot be moved into its subfolder.
No action required.
102027
Indexing is disabled on this exchange.
The folder or document will be added/
updated but the index will not be applied.
No action required.
102028
The folder {0} is already at SortOrder =
{1}.
No action required.
102034
Folder does not exist
Verify that the folder specified in the XML
Input file is identified correctly and is on the
proper exchange.
102041
Folder for the item could not be found; it
may have been moved or deleted
Verify that the folder exists on the exchange
you specified.
Intralinks Integration Adapter User Guide
page 259
No.
Problem
Resolution
102042
The destination target folder and the target exchange do not match.
Verify that the folder exists on the exchange
you specified.
102044
Two of the subfolders you are creating
have the same order number.
Verify the numbering of the folders on this
exchange and re-enter the sort order in the
XML Input file.
102045
[Document/Folder] could not be moved
because the target folder was deleted.
Verify that the folder exists on the exchange
you specified.
102046
Deleted folder could not be moved
Verify that the folder exists on the exchange
you specified.
102047
Folder cannot be moved into its subfolder
Check the folder hierarchy on the specified
exchange.
102048
Folder note is empty
Enter the note text in your XML Input file.
102049
Folder does not exist.
Verify that the folder exists on the exchange
you specified. It may be on another
exchange or may have been deleted.
102050
Folder could not be deleted; it may have
been deleted already.
Verify that the folder exists on the exchange
you specified. It may have been moved, it
may be on another exchange, or it may have
been deleted.
Intralinks Integration Adapter User Guide
page 260
Document/attachment processing errors
No.
Problem
Resolution
103001
Permission cannot be assigned by email
ID for ILP exchanges.
ILP exchanges can only be permissioned by
group. An email ID refers to a user.
103002
A matching document could not be
found.
Check the XML Input file to ensure that
you entered the document name
correctly. Verify that the document exists
on that exchange. It may have been
moved or deleted.
103003
The document was successfully rolled
back, although the original version had
been updated.
No action required.
103004
CreateDateFrom is not a valid date.
Check the XML Input file to ensure that
you entered a valid Create Date From.
See Date Format Attribute in this User
Guide.
103005
CreateDateTo is not a valid date.
Check the XML Input file to ensure that
you entered a valid Create Date To. See
Date Format Attribute in this User Guide.
103006
Effective Date is not enabled for this
exchange. The criteria you specified
will be ignored.
Not all the criteria you specify when
running an Access Report will produce
results.
103007
EffectiveDate cannot be used with
EffectiveDateFrom or EffectiveDateTo.
EffectiveDate will be ignored.
No action required.
103008
Document ownership is not enabled for
this exchange. The criteria you
specified will be ignored.
Not all the criteria you specify when running
an Access Report will produce results.
103009
Workflow is not enabled for this
exchange. The criteria you specified for
the submitter will be ignored.
Not all the criteria you specify when
running an Access Report will produce
results.
103010
No documents match the criteria
specified.
No action required, or change the criteria
in you XML file.
103011
Document download cancelled.
No action required.
103012
Document download failed because a
transmission error occurred.
Please resubmit your request.
103013
Document download failed because the
document was protected.
Consult your Intralinks exchange manager.
103014
Successfully downloaded file.
No action required.
103015
EffectiveDateFrom is not a valid date.
Check the XML Input file to ensure that you
entered a valid DateFrom.
103016
EffectiveDateTo is not a valid date.
Check the XML Input file to ensure that you
entered a valid DateTo.
103017
Could not find specified folder for download.
Check the XML file to verify that the folder ID
is valid.
Intralinks Integration Adapter User Guide
page 261
No.
Problem
Resolution
103018
ModifiedDateFrom is not a valid date.
Check the XML Input file to ensure that you
entered a valid Modified Date From.
103019
ModifiedDateTo is not a valid date.
Check the XML Input file to ensure that you
entered a valid Modified Date To.
103020
No documents met criteria to be downloaded.
No action required, or change the criteria in
you Input XML file.
103021
No documents to download.
Verify the document criteria in your XML
Input file.
103022
SubmittedDateFrom is not a valid date.
Check the Input XML file to verify that your
Submitted Date From is a valid date.
103023
SubmittedDateTo is not a valid date.
Check the Input XML file to verify that your
Submitted Date To is a valid date.
103024
IL5 exchanges do not have documents.
Check the Input XML file to verify that you
haven’t specified a document download from
an IL5 exchange.
103025
Failed to create the document because
user does not have the correct privileges
on this exchange.
Please verify that the user has the correct
privilege on this exchange.
103026
Could not find document ID.
Check the Input XML file to ensure that you
entered the correct document name or ID.
103027
The Effective Date is invalid.
Check the Input XML file to ensure that you
entered the Effective Date correctly. See
“Date Format Attribute” in the User Guide.
103028
Document name exceeds character limitation.
Check the Input XML file to see if the document name exceeds the character limitation
(245).
103029
Document name contains invalid characters.
Check the Input XML file to see if the attachment name contains invalid characters.
The following characters are not permitted:
/\:*“<>?|%
103030
Document name cannot begin with a
period or full stop (.).
Check the Input XML file to see if the document name contains a period or full stop.
103031
Document new name exceeds character
limitation.
Check the Input XML file to see if the document name exceeds the character limitation
(245).
103032
Document new name contains invalid
characters.
Check the Input XML file to see if the document name contains invalid characters.
The following characters are not permitted:
/\:*“<>?|%
103033
The document new name cannot begin
with a period or full stop (.).
Check the Input XML file to see if the document name contains a period or full stop.
103034
You can only rename a document when
you are performing an Update operation.
Check the Input XML file to ensure that you
entered the operation correctly.
Intralinks Integration Adapter User Guide
page 262
No.
Problem
Resolution
103035
Document note exceeds the 4000 character limit.
Check the Input XML file to ensure that the
Document Note does not exceed 4000 characters.
103036
Document note is not defined and you
have specified that viewers should always
see the note.
Correct the Input XML file to ensure that you
have specified a value for the Note, or
remove the tag that specifies that viewers
should always see the note.
103037
Document not found on local system.
Check the location of the document on your
local or network drive. Make sure it matches
the location specified in the XML file.
103038
Document not found. Document owner
could not be set.
Check the XML file to verify that the document name is valid. Verify that the document
exists on the specified exchange. It may
have been moved or deleted.
103039
Could not set document owner. {0}
Verify that ownership is enabled on this
exchange. Verify that the user or group
exists on the exchange.
103040
Multiple users match owner id. Document
owner could not be set.
Verify that the information entered in the
XML Input file is correct.
130041
User not found. Document owner could
not be set.
Check the XML file to verify that the user
name is valid for the specified exchange.
103042
You can only move a document when you
are performing an Update operation.
Use an Update operation in the XML
Input file to move the document.
103043
Target folder not found
Verify that the target folder exists on the
exchange.
103044
Document not found.
Check the XML file to verify that the document name is valid. Verify that the document
exists on the specified exchange. It may
have been moved or deleted.
103045
Duplicate document name. The name has
been changed to {0}
No action required.
103046
The file cannot be added more than once
to the same folder.
Check the XML file to ensure that the same
document has not been added more than
once to the same folder.
103047
You cannot use the Local Path tag to point
to folder you want to upload when you are
performing an update operation.
Check the XML Input file to ensure that you
entered the operation correctly.
103048
Specified Id is not a document
Check the Input XML file to verify that the
document ID is valid.
103049
The file name is not valid. It must be 245
characters or less, and cannot contain
these characters: / \ : * “ < > ? | %
Please enter a valid file name in the XML
Input file.
103050
Failed to copy files from local path.
Consult your Intralinks exchange manager.
103051
LocalPath is required for document
upload.
Enter a valid local path in the XML Input file.
Intralinks Integration Adapter User Guide
page 263
No.
Problem
Resolution
103052
Could not find document to apply DCM
setting.
Check the XML Input file to ensure that you
entered the folder path and document name
correctly.
103053
Document name is missing.
Check the XML Input file to see if the document name was included.
103054
A document name or Id is required.
Please enter a valid document name or ID in
the XML Input file.
103055
Could not find document to apply permission.
Check the XML Input file to ensure that
you entered the folder path and
document name correctly.
103056
Document protection is not enabled on
this exchange. Protection will not be
applied.
Remove the protection from the XML
Input file, or consult your Intralinks
exchange manager to change the
exchange setting.
103057
Removed existing permissions.
No action required.
103058
Target folder not found. Document cannot
be moved.
Check the XML Input file to ensure that
you entered the folder path correctly.
103059
This document is protected. Downloading
is not allowed.
No action required or consult your Intralinks
exchange manager about changing the protection applied to the document.
103060
Exchange is Public/Private enabled but
the Document is not set with Public/Private value.
Reenter the Public/Private value for this document in the XML Input file.
103061
This document is protected. Downloading
and printing are not allowed.
No action required.
103062
Positioning the document failed
Please consult your Intralinks exchange
manager.
103063
File not found in local system.
Verify that the file exists on the local
system.
Check the XML Input file to verify that the
file name was entered correctly.
103064
The exchange contains public and private
information. You must make a content
preference declaration before accessing
documents. Please log into the exchange
using a Web browser and make your declaration before continuing.
You must make a content preference
declaration before accessing documents.
Please log into the exchange using a Web
browser and make your declaration
before continuing.
103065
Item contained a word that is reserved by
the system.
See Appendix B of this document for a
list of reserved words
103066
Item name contained characters that are
not allowed.
Check Appendix B of this document for
validation rules.
103067
File type [“File Type” or “.ext” or
“Unknown”] is not allowed
Consult your Intralinks exchange
manager.
Intralinks Integration Adapter User Guide
page 264
No.
Problem
Resolution
103068
A document ID parameter is required but
has not been specified.
Enter a document ID parameter in the
XML Input file.
103069
Document could not be added. The folder
does not exist.
Verify that the folder exists on the
specified exchange. It may have been
moved or deleted.
103070
File could not be processed.
Consult your Intralinks exchange
manager.
103071
Document has no attached file for download.
You cannot download a placeholder
document. No action required.
103072
Document could not be uploaded
Consult your Intralinks exchange
manager.
103073
Only Collaboration groups can be
selected as document owners.
If you wish to assign a group document
owner, enter the name of a Collaboration
group in the XML Input file.
103074
No documents were updated or added; no
alert can be sent
Verify that you added or updated a
document in the XML Input file.
103075
There is a DRM (pdf protection) problem.
Consult your Intralinks exchange
manager.
103076
DRM (pdf protection) only available for
document which has a file attachment in
PDF format
Verify that the document type is
supported by DRM protection.
103077
DRM (pdf protection) is not enabled on
this exchange
Consult your Intralinks exchange
manager to change your protection
setting for this exchange.
103078
IRM (IRM protection) is not yet completed
for the given file attachment
Document is not currently available. Try
again later. If problems continue, consult
your Intralinks exchange manager.
103079
Unprotected document could not be
replaced with protected document
No action required.
103080
Role changed; move not allowed
Consult your Intralinks exchange
manager about role assignments.
103081
No new actions are required.
No action required.
103082
This exception will be thrown when we try
to undo move one or more documents or
folders which are already moved and
deleted by another user before undo.
No action required.
103084
[Document / Folder] cannot be moved into
document
Verify the names of your folders and
documents on this exchange and enter a
valid folder name in the XML Input file.
103085
Operation types are: "Bulk Print", "Bulk
Download"
Reenter the operation type in the XML
Input file.
103086
Document note is empty
Add the content of your document note to
the XML Input file.
Intralinks Integration Adapter User Guide
page 265
No.
Problem
Resolution
103087
Save Deleted Document setting is turned
OFF at the exchange level
Please consult with your Intralinks
exchange manager to activate the Save
Deleted Document setting for this
exchange.
103088
Document does not exist.
Check the XML Input file to ensure that
you entered the document name
correctly.
103089
PVP setting is not enabled for this
exchange. The criteria you specified will
be ignored.
To change the PVP setting on this
exchange, consult your Intralinks
exchange manager.
Exchange/workspace processing errors
No.
Problem
Resolution
104000
The exchange description is too long.
Maximum length is 1000.
Enter a valid exchange description.
104001
Remove alert note should not exceed
2500 characters.
Enter a valid Remove Alert Note in the
XML Input file.
104002
RemoveUserNote supported with
Remove operation only.
Specify a remove operation in the XML
Input file to remove user note.
104003
GroupUserCriteria can only be used for
Download and Remove operation. The
GroupUserCriteria will be ignored.
No action required.
104004
This exchange has additional security and
cannot be accessed using the Intralinks
Integration Adapter.
Two-factor Authorization has been enabled
on this exchange. Contact your Exchange
Manager to change the security setting.
104005
Could not find a matching exchange
"{0}".
Check your XML Input file to verify that
you entered a valid exchange name.
104006
Failed to set the exchange phase. Verify
that phase is valid for this exchange.
Check the XML file to see if the phase is
entered correctly.
Check with your Intralinks exchange manager for the valid phases for this exchange.
104007
No new actions are required for the '{0}'
exchange.
No action required.
104008
An exchange ID is required in the input
XML file.
Include a valid exchange ID in the XML file.
104009
Exchange needs to be created but
Exchange name, host name or
template ID are missing.
Create Workspace requires exchange
name, host name and template ID.
Modify your input XML file to include all
three fields.
104010
The exchange with the ID '{0}' that was
specified in the input XML file cannot
be located on Intralinks. Please check to
be sure the correct exchange was
specified.
Verify whether this exchange ID exists on
Intralinks.
Intralinks Integration Adapter User Guide
page 266
No.
Problem
Resolution
104011
The exchange '{0}' that was specified in
the input XML file cannot be located on
Intralinks. Please check to be sure the
correct exchange was specified.
Verify whether this exchange name exists
on Intralinks.
104012
The workspace type specified does not
match the server workspace type.
Consult your Intralinks exchange
manager.
104013
Exchange creation attributes are not
allowed for this operation.
Remove exchange creation attributes
form your XML Input file and re-submit
the file.
104014
Workspace phase does not match.
Verify that the phase you entered in the
XML Input file is valid for the specified
workspace. Phases are:
- Hold
- Preparation
- Open
104015
IL5 workspace does not support
documents.
Verify that you entered the correct
platform in the XML Input file (ILP or IL5).
IL5 support publications. ILP supports
documents.
104016
Exchange "{0}" does not allow bulk
downloads.
Consult your Intralinks exchange
manager about changing the setting on
this exchange.
104018
Exchange is already in the queue.
No action required.
104019
Your exchange changes could not be
located. The file containing your
exchange changes may have been
renamed or moved.
Verify that the file you indicated is on the
specified exchange. It may have been
moved or deleted.
104020
The following characters cannot be
used in hostnames: \ //<>
Enter a valid host name in the XML Input
file for the exchange you are creating.
104021
The host name is too long. It must be
100 characters or less.
Host names are limited to 100 characters
or less. Please correct your Input XML
file.
104022
The following characters cannot be
used in exchange descriptions: \ < >
Please make sure the exchange
descriptions in your Input XML file don’t
contain any illegal characters.
104023
Your exchange changes could not be
located. The folder in which you saved
your exchange changes may have been
renamed or moved.
Verify the location of the folder on your
Intralinks exchange.
104024
Your exchange changes could not be
opened. You do not have permission to
open the file containing your exchange
changes. The person with
administrative rights to your computer
or network drive may be able to give
you access to the file.
Consult your Intralinks exchange
manager.
Intralinks Integration Adapter User Guide
page 267
No.
Problem
104025
Your exchange changes could not be
opened. You do not have permission to
open the folder in which you saved
your exchange changes. The person
with administrative rights to your
computer or network drive may be able
to give you access to the file.
Consult your Intralinks exchange
manager.
104026
Your exchange changes could not be
opened. You do not have permission to
open the file or folder containing your
exchange changes. The person with
administrative rights to your computer
or network drive may be able to give
you access to the file.
Consult your Intralinks exchange
manager.
104027
Your exchange changes could not be
opened. Not enough space is available
on your computer or network drive to
open your exchange changes. If
possible, make additional space
available on the drive and then try
again.
Consult your Intralinks exchange
manager.
104028
Your exchange changes could not be
opened. An error occurred when
attempting to open your exchange
changes. There may be a problem with
your computer or network drive. Please
contact your IT department for
assistance.
Contact your IT department for
assistance.
104029
Invalid workspace name. The name
cannot contain '<', '>, '\' or //.
Please check your Input XML file to see if
you workspace name contains illegal
characters.
104030
The exchange name is too long. It must
be 100 characters or less.
Please correct your exchange name in the
Input XML file.
104031
Exchange entrance requirements not
met.
Consult your Intralinks exchange
manager.
104032
Bulk operations are prohibited in this
exchange
Consult your Intralinks exchange
manager about changing the setting on
this exchange.
104033
Exchange is Invalid.
You have entered an exchange that
doesn’t exist. Enter a valid exchange in
the XML Input file.
104034
Exchange is frozen; action not allowed
Contact your Intralinks exchange
manager to unfreeze the exchange.
104035
You must accept the exchange’s user
agreement before entering the
exchange.
Consult your Intralinks exchange
manager.
104036
The exchange was not properly
entered.
Check the host name in you Input XML
file to see if it is valid.
Intralinks Integration Adapter User Guide
Resolution
page 268
No.
Problem
Resolution
104037
The exchange could not be found.
Check the host name in you Input XML
file to see if it is valid.
104038
You must first agree to the exchange’s
confidentiality agreement or other
statement. Log into Intralinks in your
web browser, select this exchange, and
review the agreement that appears. If
you agree, click Agree or Continue.
After you have done this, you can view
this exchange in Intralinks Designer.
Consult your Intralinks exchange
manager.
104039
Exchange Welcome alert has been
suppressed by the user.
No action required.
104040
You cannot suppress the Welcome
alert when creating a new exchange.
The Welcome alert can be suppressed
when changing the phase of an
exchange.
104041
You cannot suppress the Welcome
alert on an IL5 exchange.
No action required.
104042
You cannot update the phase of an IL5
exchange.
No action required.
104043
The document is set to Public or Private
but the Workspace is not Public/Private
enabled.
To enable the Public/Private setting on the
exchange, please consult your Intralinks
exchange manager.
104044
Your assigned role requires a private setting. You cannot declare yourself as public.
Update your Public/Private (PVP) declaration.
104045
Successfully set the exchange phase to
{0}.
No action required.
104046
Unable to create the Workspace
Verify that you have the proper rights and
that the XML syntax is properly formed.
104047
Sort order values cannot be duplicates.
Change the sort order.
104048
SortOrder must be greater than 0
Change the sort order.
104049
The commands in the XML Input File
could not be executed because the sort
order you specified contains a zero or you
have entered the same sort order for two
different documents or folders
Change the sort order.
104050
Could not move {0} because it is already
in that location
No action required.
Intralinks Integration Adapter User Guide
page 269
Publication/attachment processing errors
No.
Problem
105000
A matching publication could not be found.
Resolution
Verify that the publication exists on the
exchange.
Verify that you entered the publication name
correctly in the XML Input file.
105001
ILP exchanges do not support publications.
Either specify documents for the ILP
exchange or verify that you have entered an
IL5 exchange in the XML Input file.
105002
Attachment name exceeds character limitation.
Maximum number of characters for attachment name:
For IL5: 255 (less the number of characters
needed for the file extension and the “dot”).
For Intralinks Platform: 245.
105003
Attachment name contains invalid characters.
Check the XML file to see if the attachment
name contains invalid characters.
#\/:*?“<>|
105004
The attachment name cannot begin with a
period or full stop (.).
Enter a valid attachment name in the Input
XML file.
105005
The attachment was not found.
Verify that the attachment exists on the
exchange.
Verify that you entered a valid attachment
name in the XML Input file.
105006
Attachment not found on local system.
Verify the location of the attachment.
Verify that you entered a valid attachment
name in the XML Input file.
105007
Attachments could not be created
because ILIA user ID is not assigned the
correct privileges.
Consult your Intralinks exchange manager.
105008
Failed to create the publication because
user does not have the correct privileges
on this exchange.
Consult your Intralinks exchange manager.
105009
failed to create the publication because
user does not have the correct privileges
on this exchange.
Consult your Intralinks exchange manager.
105010
Specified Id is not a publication
Enter the correct publication ID in the XML
Input file.
105011
ILP exchanges do not have publications.
Check the Input XML file to verify that you
haven’t specified a publication download
from an ILP exchange.
105012
LocalPath not allowed. Attachments cannot be updated.
Check the local path name and verify that it
is accessible.
Intralinks Integration Adapter User Guide
page 270
No.
Problem
Resolution
105013
Attachment name is missing.
Check the XML Input file to see if the attachment name was included.
105014
Could not find publication to apply DCM
setting.
Check the XML Input file to ensure that you
entered the publication name or ID correctly.
If you have, check with your Intralinks
exchange manager.
105015
Publication name is missing.
Enter the publication name in the XML Input
file.
105016
The Integration Adapter has experienced
an internal problem during an attempt to
apply permissions.
Try resubmitting your XML Input file in a few
minutes. If problems continue, consult you
exchange manager.
105017
Could not find publication Id
Check the XML Input file to ensure that you
entered the correct publication ID.
105018
The Effective Date is invalid.
Re-enter the Effective Date in the XML Input
file in the correct format.
105019
Publication not found.
Check the XML Input file to ensure that you
entered the publication name or ID correctly.
105020
Publication name exceeds character limitation.
Re-enter the publication name in the XML
file.
Upon create event: 125*
Upon update event: 150
* Web Services allows 150 characters when
creating a publication.
105021
Publication name contains invalid characters.
Re-enter the publication name in the XML
file.
For IL5, two consecutive forward slashes ( //
) are not allowed, but a single forward slash
is allowed. In addition, the following characters are not permitted:
\<>
105022
Sort order for publication is invalid.
Verify that you entered a numeric value for
the Sort Order in the XML Input file.
105023
Attachment had no index number. An
index number was added.
No action required
105024
Publication had no index number. An
index number was added.
No action required.
105025
Attachment’s index number was incorrect. It was changed to match its publication.
No action required.
105026
Publication’s index number was incorrect.
It was changed to match its folder.
No action required.
105027
Attachment’s index number was incorrect. It was changed to match the previous
attachment.
No action required.
Intralinks Integration Adapter User Guide
page 271
No.
Problem
Resolution
105028
Publication’s index number was incorrect.
It was changed to match the previous publication.
No action required.
105029
Sort orders are not allowed for publications. The sort number was removed.
No action required.
105034
Invalid file name
See Appendix B in this document for validation rules for file names.
105033
Publication does not exist.
Check the XML Input file to see if the publication name or ID was included.
105034
Attachment could not be added. The publication does not exist.
Check the XML Input file to see if the publication name or ID was included.
105035
Publication could not be added. The folder
does not exist.
Check the XML Input file to see if the folder
name or ID was included.
105036
File uploaded successfully.
No action required.
Custom field processing errors
No.
Problem
Resolution
106000
The Integration Adapter has experienced
an internal problem while setting the group
custom fields.
A communication failure may have
occurred. Please wait a few minutes and
resubmit your input file. If the problem
persists, consult your Intralinks exchange
manager.
106001
Successfully published custom fields.
No action required.
106002
CustomField Label must be set.
Set the Custom Field Label in the XML
Input file.
106003
We cannot assign a value to the custom
field {0} because the value type is either
invalid or out of range.
Verify the correct format and correct the
XML Input file.
106004
The custom field {0} could not be enabled/
disabled.
Check that the specified custom field
name specified in the XML file is valid.
106005
The custom field {0} was successfully
enabled/disabled.
No action required.
106006
The custom field value in {0} could not be
set.
A communication failure may have
occurred. If so, resubmit the XML file. Or,
user privileges have been changed.
Consult your Intralinks exchange
manager.
106007
Document not found. Custom field could
not be set.
Verify that the exchange that contains the
document is listed correctly in the XML
Input file and that the document name is
correct. Or, verify that the document has
been uploaded to the exchange indicated.
Intralinks Integration Adapter User Guide
page 272
No.
Problem
Resolution
106008
The custom field you are trying to assign
{0} does not exist.
Verify that this custom field exists on the
specified exchange.
106009
The custom field you are trying to assign
does not exist.
No action required.
106010
The custom field {0} could not be configured.
A communication failure may have
occurred. If so, resubmit the XML file. Or,
user privileges have been changed.
Consult your Intralinks exchange
manager.
106011
The custom field {0} was successfully configured.
No action required.
106012
The custom field value can not be greater
than 255 characters. The value has been
truncated.
No action required.
106013
Custom field values for {0} could not be
set.
Consult your Intralinks exchange
manager.
106014
No custom fields have been defined for
this element, or the custom fields have not
been published.
Consult your Intralinks exchange
manager.
106015
The custom fields collection has not been
published yet.
Consult your Intralinks exchange
manager.
106016
Inactive custom fields cannot be assigned
to documents.
Verify which custom fields have been
published on the specified exchange.
106017
106018
Required custom fields are missing.
Enter the required custom fields in the
XML Input file.
106019
Custom fields have not been published, or
have been disabled.
Consult your Intralinks exchange
manager.
106020
Custom fields are inactive on this
exchange.
Consult your Intralinks exchange
manager.
106021
There is no active custom field found to
publish.
Enable at least one custom field on this
exchange before trying to publish the custom field.
106022
Custom fields set to publish
No action required.
106023
Custom fields failed to set to publish
Verify that the custom fields are enabled on
the exchange.
106024
Custom fields already set to publish
No action required.
106025
Custom fields are not enabled
Verify that the custom fields are enabled on
the exchange.
Intralinks Integration Adapter User Guide
page 273
Login processing errors
No.
Problem
Resolution
108000
You cannot log in with a temporary password.
A permanent password is required. Log into
Intralinks from your web browser using your
temporary password. Follow the instructions
and accept the Intralinks license agreement.
Next, create a permanent password. Then
click the Intralinks icon in the notification
area, select Log Into Intralinks, and enter
your new password. If your password has
expired, contact Intralinks Client Services to
obtain a new temporary password.
108001
Your password has expired.
Please reset your password using your Web
browser.
108002
ID and password are incorrect.
Verify your ID and password and reenter
them.
108003
You are already logged into Intralinks.
No action required.
108004
The session has timed out.
Consult your Intralinks exchange manager.
108005
The user must log in.
Consult your Intralinks exchange manager.
108006
User session invalid. This may be due to
session timeout or concurrent login
Consult your Intralinks exchange manager.
108007
A timeout occurred while processing a file
Resubmit the XML Input file.
108008
User's current session is invalid. This may
be due to session timeout or concurrent
login.
Consult your Intralinks exchange manager.
108009
There is a problem with your user ID or
password. Please contact Intralinks Client
Services for assistance.
Consult your Intralinks exchange manager.
108010
There is a problem with your user ID or
password. Please contact Intralinks Client
Services for assistance.
Consult your Intralinks exchange manager.
108011
You are already logged into Intralinks. You
are already logged into Intralinks with this
ID. You can continue logging in, but the
prior session will be ended and any inprogress work will be lost.
You many be logged in on another machine.
108012
A permanent password is required. Log
into Intralinks from your web browser
using your temporary password. Follow
the instructions and accept the Intralinks
license agreement. Next, create a permanent password. Then click the Intralinks
icon in the notification area, select Log
Into Intralinks, and enter your new password. If your password has expired, contact Intralinks Client Services to obtain a
new temporary password.
You cannot log in using your temporary
password. Follow the instructions in the error
message to create a new password.
Intralinks Integration Adapter User Guide
page 274
Intralinks Courier-related errors
No.
Problem
Resolution
109000
There are no packages to delete.
No action required.
109001
No packages were deleted.
No action required.
109002
The package does not exist, or you do not
have access to this package.
Consult your Courier exchange manager.
109003
The package ID is invalid. The package
was not found or has been deleted.
Verify that you entered a valid package ID in
the XML Input file.
109004
You do not have rights to create a package on this exchange.
Consult your Courier exchange manager
about changing your rights.
109005
You do not have rights to update this
package.
Consult your Courier exchange manager
about changing your rights.
109006
Error downloading the package, please
contact the sender of the package.
Consult your Courier exchange manager.
109007
Intralinks Courier controller initialization
failed.
Consult your Courier exchange manager.
109008
Internet connection has been lost.
Check your network connections.
109009
Session has been expired.
Consult your Courier exchange manager.
109010
Error found in workspace.
Consult your Courier exchange manager.
109011
Error found while loading policies.
Consult your Courier exchange manager.
109012
Error found while setting session in
Intralinks Courier.
Consult your Courier exchange manager.
109013
An error was found while validating package file or the specified file does not exist.
Verify that you have specified valid file
names and paths for this package in the
XML Input file.
109014
Send Folders option is not supported.
You cannot attach folders to a Courier package. Verify that you have specified valid file
names and paths for this package in the
XML Input file.
109015
Package folder does not exist.
Verify the name and location of the folder
you entered in the XML Input file.
109016
Package attachments must be greater
than zero.
Include at least one attachment for this public package.
109017
Package name length must be less than
or equal to 60.
Enter a valid package name in the XML
Input file.
60 characters or less.
109018
The number of package recipients must
be greater than zero.
Include at least one Courier package recipient to your XML Input file.
109019
You cannot add Private note to a public
package.
No action required or send as a secure
package.
Intralinks Integration Adapter User Guide
page 275
No.
Problem
Resolution
109020
Package Private Note length cannot
exceed 4000.
Check Appendix B in this document for validation rules.
109021
Public package is not allowed according to
policy settings.
No action required or send as secure package.
109022
Protection is not allowed in case of public
package.
No action required or send as secure package.
109023
Protection forced from the server side,
and package protection not similar to the
policy.
Verify that your protection setting in the XML
Input file matches your company’s policy.
109024
Package expiration date not according to
policy settings.
Verify that your the package expiration date
in the XML Input file matches your company’s policy.
109025
Package Expiration date exceeds the
expiration policy.
Enter a valid Package Expiration Date in the
XML Input file that conforms to your company’s policy.
109026
Package Expiration date must be in future.
Enter a valid Expiration date in the XML
Input file.
109027
Tracking code is empty or its length
greater than 60.
Enter a valid tracking code in the XML Input
file. Maximum length = 60 characters.
109028
Tracking code length greater than 60.
Enter a valid tracking code in the XML Input
file. Maximum length = 60 characters.
109029
Package Tracking code value must exist
in the Tracking code list values.
Verify that the tracking code you entered is
listed in the Tracking Code list. If not,
change the tracking code or add this code to
the list.
109030
Package has been created successfully.
No action required.
109031
Error found while sending package.
Consult your Courier exchange manager.
109032
Error found while cleaning up local files.
Consult your Courier exchange manager.
109033
Unknown error found.
Consult your Courier exchange manager.
109034
Courier exchange not found.
Consult your Courier exchange manager.
109035
Package body length exceeds from the
allowed 2500 characters length.
Renter the package body text and verify that
it contains fewer than 2500 characters.
109036
The filename is too long. Filenames must
be less than 260 characters.
See Appendix B is this document for validation rules.
109037
The filename contains invalid characters
See Appendix B is this document for validation rules.
109038
You are using the wrong operation type
for this Courier-related operation.
Consult chapter 6 of the Intralinks Integration Adapter User Guide.
109039
Package could not be sent because network drive is not connected and file(s)
cannot be accessed. The user name or
password used to connect the drive may
be wrong.
Verify that the user name and password are
correct for accessing the drive.
Intralinks Integration Adapter User Guide
page 276
No.
Problem
Resolution
109040
Package could not be delivered because
the e-mail address is invalid.
Verify the email address of the package
recipient.
109041
Invalid package expiry date.
Please enter a valid expiry date for this
package.
109042
A Courier account with this name already
exists.
No action required. If you need more information consult your Intralinks exchange
manager.
109043
A server-side error was encountered.
Resubmit you Input XML file. If the problem
recurs, please consult your Intralinks
exchange manager.
109044
Please ensure that all of the required
parameters are included in the XML Input
file.
Consult the Intralinks Integration Adapter
User Guide, chapter 6, for required parameters for working with Courier exchanges.
109045
Only one business group is supported.
You can only enter one business group in
the XML Input file.
109046
Business group not found.
Please enter a valid business group in the
XML Input file.
109047
The policy was not found under this Business Group.
Please enter a valid policy name for this
Business Group in the XML Input file.
109048
Courier exchange has been created.
No action required.
109049
Courier exchange not found or does not
belong to the given business group.
Please enter a valid Courier exchange for
this Business Group in the XML Input file.
109050
Courier exchange has been removed successfully.
No action required.
109051
Courier exchange has been updated successfully.
No action required.
109052
No valid first name provided.
Please enter a valid first name in the XML
Input file.
109053
This Courier account cannot be updated
at the present time.
No action required. Please consult your
Intralinks exchange manager for more information.
109054
Only one Courier exchange can be created for this email address.
Please consult your Intralinks exchange
manager.
109055
Email address is not valid.
Please enter a valid email address in the
XML Input file.
109056
The policy name is invalid.
Please enter a valid policy name for this
Business Group in the XML Input file.
109057
No last name was provided.
Please enter a valid last name in the XML
Input file.
109058
Organization is a mandatory field.
Please enter a valid organization in the XML
Input file.
109059
A default policy name has not been found
for this Business Group.
Please enter a valid policy name for this
Business Group in the XML Input file.
Intralinks Integration Adapter User Guide
page 277
No.
Problem
Resolution
109060
Courier exchange account object is null.
No action required.
109062
The phone number you entered has less
than four digits.
Please enter a valid phone number in the
XML Input file. See Appendix B is this document for validation rules.
109063
Phone number is invalid.
Please enter a valid phone number in the
XML Input file. See Appendix B is this document for validation rules.
109064
Template not found.
Please enter a valid template ID in the XML
Input file.
109065
More than one template ID was found.
Only one template is supported.
Please enter a valid template ID in the XML
Input file.
109066
A server-side error was encountered.
Resubmit you Input XML file. If the problem
recurs, please consult your Intralinks
exchange manager.
109067
Package name contains invalid characters.
Please rename your package. See Appendix
B is this document for validation rules.
109068
Packages that begin with (.) cannot be
couriered. Please rename the package
and try again.
Please rename your package. See Appendix
B is this document for validation rules.
109069
You are not authorized to perform this
task.
If you need to change your rights on the
exchange, please consult your Intralinks
exchange manager.
109070
The user has been deregistered. Please
contact Intralinks customer service for
assistance
This user is no longer registered.
Report processing errors
No.
Problem
110000
The Document Centric Report failed to
save. Please check the name and path of
the report file.
Please check the name and path of the
report file in your Input XML file.
110001
The Document Access Report was created.
No action required.
110002
The Access reports you requested for
exchange {0} were successfully created.
No action required.
110003
Document Centric Report {0} was successfully created.
No action required.
110004
User Centric Report {0} was successfully
created.
No action required.
110005
Document Access Report is available for
ILP exchanges only.
Check the Input XML file to verify that you
have specified an ILP exchange.
110006
Document Centric Report is available for
ILP exchanges only.
Check the Input XML file to verify that you
have specified an ILP exchange.
Intralinks Integration Adapter User Guide
Resolution
page 278
No.
Problem
Resolution
110007
A valid report path and name is required.
Check the Input XML file to verify that the
path and name are valid.
110008
You do not have rights to view document
access reports for this exchange.
Please consult your Intralinks exchange
manager to obtain the necessary rights.
110009
You have specified a folder path for the
document centric report. You need to
specify the full document path.
Specify the full document path in the XML
Input file.
110010
User Comparison Report is available for
ILP exchanges only.
You cannot generate a User Comparison
Report for IL5 exchanges.
110011
User Comparison Report cannot be generated for all exchanges.
No action required.
110012
No users provided for generating User
Comparison Report.
Enter one or more valid email addresses in
the XML Input file to identify users.
110013
User Comparison Report {0} was successfully created.
No action required.
110014
Report file path is too long to generate
report. Please provide a shorter file path.
Enter a shorter file path.
110015
User Comparison Report could not be created. No records found.
No action required.
110016
User-centric Report could not be created.
No records found.
No action required.
110017
You cannot filter a Document-centric
Report with a User ID.
Use the name of the document creator to filter this report.
General processing and rollback errors
No.
Problem
Resolution
111000
Problem loading rollback file.
Could not find rollback file. Check the XML
file to see if the rollback path is valid. Check
that the rollback file exists in the specified
location and that ILIA has access to that
folder.
111003
The Integration Adapter has experienced
an internal problem.
Consult your Intralinks exchange manager.
111004
Authorization error archiving the input file.
Consult your Intralinks exchange manager
about changing the access rights.
111005
A connection could not be established to
Intralinks or your system of record. Please
check your network connections.
Please check your network connections.
111006
The user ID that was provided in the Input
file had not been defined in the Configuration settings.
Enter the user ID using the ILIA Configuration Manager.
111007
The input XML file does not conform to the
Intralinks schema. Detailed error: {0}.
Check the Input XML file to make sure that
you have no formatting errors.
Intralinks Integration Adapter User Guide
page 279
No.
Problem
111008
A synchronization job for the '{0}'
exchange is already in the queue. Please
try again later.
Resubmit your XML Input file later.
111009
The Integration Adapter could not access
the exchange.
Consult your Intralinks exchange manager.
111010
Network status is offline.
Reestablish your network connections.
111012
An XML <identity> element is missing in
the Input file.
Check the XML Input file for formatting
errors.
111013
The process was stopped by the service.
A user manually stopped the service. No
action required.
111014
An unhandled error occurred while processing the input file. Exception:{0} Stack
Trace:{1}
Consult your Intralinks exchange manager.
111015
The elements specified in the Input file are
not supported by the operation type {0}.
Review the ILIA User Guide to verify which
elements are supported by which operation
types.
111016
The Integration Adapter has experienced
an internal problem during an attempt to
apply permissions.
Consult your Intralinks exchange manager.
111017
The application is busy, please retry last
command again.
Resubmit the XML Input file.
111018
The Configuration file is not valid. Please
contact your System Administrator
Consult your Intralinks exchange manager.
111019
Operation has been cancelled
Consult your Intralinks exchange manager.
111020
Unspecified reason
Consult your Intralinks exchange manager.
111022
The following characters are not allowed
/ \ < > Please enter a new title.
Verify that you haven’t entered any illegal
characters in the XML Input file. See Appendix B in this document.
111023
The following characters are not allowed
/ \ : * “ < > ? | % Please enter a new title.
Verify that you haven’t entered any illegal
characters in the XML Input file. See Appendix B in this document.
111025
The following characters are not allowed #
/ \ : * ? “ < > | Please enter a new title.
Verify that you haven’t entered any illegal
characters in the XML Input file. See Appendix B in this document.
111033
Intralinks registration is not complete.
Consult your Intralinks exchange manager.
111034
Ticket number not found.
No action required.
111035
Intralinks server is not available.
Please try again later. If the problem continues, consult your Intralinks exchange manager.
111036
You do not have the necessary permissions to perform this task.
See your Intralinks exchange manager to
obtain the necessary permissions.
111037
Security settings prevented item from
being read.
See your Intralinks exchange manager to
change the security settings, if desired.
Intralinks Integration Adapter User Guide
Resolution
page 280
No.
Problem
Resolution
111038
Item could not be found; it may have been
moved or deleted.
Verify that the item you specified in the XML
Input file exists on the specified exchange.
111039
An error occurred while opening the item.
Consult your Intralinks exchange manager.
111040
Server is not available.
Please try again later. If the problem continues, consult your Intralinks exchange manager.
111041
No response was received during the
time-out period for a request.
Consult your Intralinks exchange manager.
111042
The request was canceled.
A user manually stopped the service. No
action required.
111043
The remote service point could not be
contacted at the transport level.
Consult your Intralinks exchange manager.
111044
The connection was prematurely closed.
Consult your Intralinks exchange manager.
111045
The connection for a request that specifies
the Keep-alive header was closed unexpectedly.
Consult your Intralinks exchange manager.
111046
A message was received that exceeded
the specified limit when sending a request
or receiving a response from the server.
Consult your Intralinks exchange manager.
111048
An internal asynchronous request is pending.
Consult your Intralinks exchange manager.
111049
This member supports the .NET Framework infrastructure and is not intended to
be used directly from your code
Consult your Intralinks exchange manager.
111050
The response received from the server
was complete but indicated a protocollevel error.
Consult your Intralinks exchange manager.
111051
The name resolver service could not
resolve the proxy host name.
Consult your Intralinks exchange manager.
111052
A complete response was not received
from the remote server.
Consult your Intralinks exchange manager.
111053
An error occurred while establishing a
connection using SSL.
Consult your Intralinks exchange manager.
111054
A complete request could not be sent to
the remote server.
Consult your Intralinks exchange manager.
111055
The server response was not a valid
HTTP response.
Consult your Intralinks exchange manager.
111056
No error was encountered.
No action required.
111057
A server certificate could not be validated.
Consult your Intralinks exchange manager.
111058
An exception of unknown type has
occurred.
Consult your Intralinks exchange manager.
Intralinks Integration Adapter User Guide
page 281
No.
Problem
Resolution
111059
Proxy authentication failed
Check your proxy settings. See Chapter 2 of
the ILIA User Guide.
111060
Proxy server is not available
Consult your IT department.
111061
The proxy URL Format is wrong
Check your proxy settings. See Chapter 2 of
the ILIA User Guide.
111063
Task successfully completed.
No action required.
111064
Task successfully completed.
No action required.
111065
Task successfully completed.
No action required.
111066
An exception of unknown type has
occurred.
Consult your Intralinks exchange manager.
111067
Data field failed validation
Consult your Intralinks exchange manager.
111068
Given parameters are out of range
Consult your Intralinks exchange manager.
111069
Invalid identifier specified. Should have
positive id
Consult your Intralinks exchange manager.
111070
Value must be either Y or N.
Consult your Intralinks exchange manager.
111071
Text contains line feeds which cause it to
be more than one line.
Consult your Intralinks exchange manager.
111072
Length must be between <min> and
<max>.
Consult your Intralinks exchange manager.
111073
Exchange RoleType is not valid!
Enter a valid exchange role type in the XML
Input file and resubmit the file.
111074
Exchange Setting type is not valid!
Consult your Intralinks exchange manager.
111075
Given Collection or Map must have at
least one element
Consult your Intralinks exchange manager.
111076
The string value of the http request
parameter cannot be converted to the
Java type of the target field.
Consult your Intralinks exchange manager.
111077
Search term provided in exchange users/
groups may contain wild cards.
Consult your Intralinks exchange manager.
111079
Search term provided in exchange users/
groups may be too short.
Consult your Intralinks exchange manager.
111080
Setting type passed is not valid.
Consult your Intralinks exchange manager.
111081
Setting Category passed is not valid
Consult your Intralinks exchange manager.
111082
Must be greater than or equal to <value>
Re-enter a valid value in the XML Input file
and resubmit the file.
111083
String cannot be only white space
Verify your entry in the XML Input file.
111087
Search specified includeContents.
Consult your Intralinks exchange manager.
Intralinks Integration Adapter User Guide
page 282
No.
Problem
Resolution
111088
Wildcards not allowed Your request could
not be completed because this exchange
does not allow wildcards when searching.
Please remove the wildcards from your
search terms and search again.
Consult your Intralinks exchange manager.
111089
The Verity search engine is not currently
available.
Consult your Intralinks exchange manager.
111091
Entity specified was not found
Verify that the entity exists on the specified
exchange.
Verify that the data entered in the XML Input
file is valid.
111092
Associated enum not found in the system
for a given String
Verify the data entered in the XML Input file.
111094
Entity Data sent is invalid
Verify the data entered in the XML Input file.
111095
Entity already exists
No action required.
111098
Invalid MimeType for Export of Document
And Folder List
Consult your Intralinks exchange manager.
111099
Illegal Action performed
Consult your Intralinks exchange manager.
111101
Document/placeholder/publication/folder
could not be moved because target folder
was deleted.
Verify that you entered a valid destination
folder in the XML Input file.
111109
The action you are trying to perform is not
supported on this IL5 exchange.
Verify that the XML Input file contains the
right operations for this platform.
111112
User trying to update exchange setting
other than freeze index setting
Contact your Intralinks exchange manager.
111113
System Error. Please contact your System
Administrator.
Contact Intralinks customer service.
111114
Intralinks Platform General Exception
Contact Intralinks customer service.
111115
An unknown system error has occurred
while processing request.
Contact Intralinks customer service if the
problem persists.
111116
An illegal operation occurred. Please contact Intralinks customer service if the problem persists.
Contact Intralinks customer service if the
problem persists.
111117
Your data is in the incorrect format.
Please review your data and try again.
Verify that your XML Input file is formatted in
accordance with the Intralinks schema.
111118
The information you entered already
exists. Please check your entry and try
again.
Verify the information entered in your XML
Input file and resubmit the file, if desired.
111120
Your entry includes reserved words.
Please check your entry and try again.
Verify that your XML Input file does not contain any reserved words. See Appendix B in
this document.
111121
A security violation occurred. Please try
again.
Please wait a few minutes and resubmit your
XML Input file.
Intralinks Integration Adapter User Guide
page 283
No.
Problem
Resolution
111122
This record is currently being updated by
another user.The record will be available
when it is saved, or try again in an hour.
Please wait a few minutes and resubmit your
XML Input file.
111123
An error occurred while updating or creating the resource.
Please wait a few minutes and resubmit your
XML Input file.
111124
The resource you are attempting to
access was deleted by another user.
Please refresh and try again.
Verify that your XML Input file is up to date.
111125
One of the parameter/s in the input data
does not exist on the system or has been
removed.
Verify that your XML Input file is up to date.
111126
The system is busy. Please try again later.
Please wait a few minutes and resubmit your
XML Input file.
111127
You do not have permission to access this
resource.
Consult your Intralinks exchange manager.
111128
You do not have permission to perform
this task.
Consult your Intralinks exchange manager.
111130
You do not have permission to view group
reports.
Consult your Intralinks exchange manager.
111132
No errors were found.
No action required.
111133
You do not have permission to perform
this task.
Consult your Intralinks exchange manager.
111134
You are not authorized to perform this
task.
Consult your Intralinks exchange manager.
111135
You attempted to make a change that is
not allowed. Please review your selections
and try again.
You attempted to make a change that is not
allowed. Please review your selections and
try again.
111136
The Q&A coordinator must be assigned
the Manager Plus exchange role.
The Q&A coordinator must be assigned the
Manager Plus exchange role.
111137
Q&A is not enabled on this exchange.
Q&A is not enabled on this exchange.
111138
The input XML is null. A valid XML entry is
required in order to perform this operation.
The input XML is null. A valid XML entry is
required in order to perform this operation.
111139
The input xml is invalid or does not meet
the requirements for this operation. A valid
XML entry is required in order to perform
the operation.
The input XML is invalid or does not meet
the requirements for this operation. A valid
XML entry is required in order to perform the
operation.
111140
The Intralinks service is not available.
Please try reconnecting in a few minutes.
The Intralinks service is not available.
Please try reconnecting in a few minutes.
111141
A system exception occurred. Please try
again later.
A system exception occurred. Please try
again later.
111143
The view type in your request is invalid.
The view type can be inbox or sent.
The view type in your request is invalid. The
view type can be “inbox” or “sent”.
111144
Task successfully completed.
No action required.
Intralinks Integration Adapter User Guide
page 284
No.
Problem
Resolution
111147
Your access rights to this exchange do not
allow you to perform this action.
Please consult your Intralinks exchange
manager if you wish to change your rights on
this exchange.
111148
The number of operations in your bulk
request exceeds the system limit.
Divide the XML Input file into multiple files.
111149
The data passed to the method by the client is not valid.
Please consult your Intralinks exchange
manager.
111152
This name is in use. Please use another
name.
Renter a valid name in the XML Input file.
111154
Your access rights to this exchange do not
allow you to perform this action.
Please consult your Intralinks exchange
manager if you wish to change your rights on
this exchange.
111155
Your access rights to this exchange do not
allow you to perform this action.
Please consult your Intralinks exchange
manager if you wish to change your rights on
this exchange.
111156
Your access rights to this exchange do not
allow you to perform this action.
Please consult your Intralinks exchange
manager if you wish to change your rights on
this exchange.
111160
The item is being changed by another
user; your change cannot be made.
Please try again later.
This item is being updated by another user.
Try again later.
111165
An unexpected system error has
occurred. Please retry this command. If
the error persists, please contact Intralinks
support.
Resubmit the XML Input file. If the error persists, please contact Intralinks support.
111171
Error occurred while uploading the file to
the server.
Please consult your Intralinks exchange
manager.
111172
FiveX General Exception.
Please consult your Intralinks exchange
manager.
111178
Alerts could not be sent to {0} due to an
invalid email address or a non-permissioned user.
No action required.
111214
Packages that begin with (.) cannot be
couriered. Please rename the package
and try again.
Change the package name.
111216
SortOrder values cannot be duplicated
Change the sort order in the Input XML file.
Amendment Voting processing errors
No.
Problem
Resolution
112000
This exchange is not an Intralinks Platform
exchange. It cannot be reconciled.
Please verify that the exchange ID and
exchange name are entered correctly in the
XML Input file.
Intralinks Integration Adapter User Guide
page 285
No.
Problem
Resolution
112001
This exchange does not support amendment voting. It cannot be reconciled.
Please verify the exchange number you
entered in the Input XML file. If the exchange
ID is correct, please consult your Intralinks
administrator.
112002
Tranche information is required in order to
run a reconciliation process.
Please verify that you have included the
tranche information in the Input XML file.
112003
The source file contains multiple tranches
with the same name. Tranche names
must be unique.
Please enter a unique name for each
tranche in the XML Input file.
112004
The exchange CUSIP was not found. This
information is required.
Please enter a valid CUSIP in the Input XML
file.
112005
The CUSIP is not formatted correctly.
Maximum number of characters is 50.
112006
The lender group <GROUP NAME> must
be a collaboration group to be included in
the reconciliation process.
Please verify that you have entered the correct lender group name in the XML Input file.
If you have, contact your Intralinks exchange
manager.
112007
The lender group <GROUP NAME> is not
a collaboration group on the exchange. It
must be a collaboration group to be
included in the reconciliation process.
Please verify that you have entered the correct lender group name in the XML Input file.
If you have, contact your Intralinks exchange
manager.
112008
The group <GROUP NAME> must be a
lender group to be included in the reconciliation process.
Please verify that you have entered the correct group name in the XML Input file. If you
have, contact your Intralinks exchange manager.
112009
Please note: The commitment amount
and/or Vote% are provided for the tranche
{0}, which has a Terminated status.
No action required.
112012
Only Synchronize and Download operations can be performed on Amendment
Voting exchanges.
Please remove any non-supported operation
types from the XML Input file.
112013
The CUSIP will be ignored. CUSIP IDs are
used only on Amendment Voting
exchanges.
No action required.
112014
The reconciliation includes more than the
maximum number of tranches allowed. Up
to 15 tranches can be included.
You cannot reconcile more than 15
tranches.
112015
The reconciliation includes more than the
maximum number of groups allowed. Up
to 2500 groups can be included.
You cannot reconcile more than 2500
groups.
112016
The CUSIP does not match the CUSIP on
the exchange.
Please verify the CUSIP number you
entered in the XML Input file to ensure that it
matches the CUSIP on the exchange.
112017
The process <Vote Name> was not found.
Please enter a Vote Name in the XML Input
file.
112018
Deal Report <Vote Name> was successfully created.
No action required.
Intralinks Integration Adapter User Guide
page 286
No.
Problem
Resolution
112019
Deal Report could not be created.
If this problem persists, contact your Intralinks administrator.
112020
Deal Report is available for ILP
exchanges only.
Please verity that the exchange ID and
exchange name and entered correctly in the
XML Input file.
112021
Names for Amendment Voting processes
must be included in report parameters.
Please enter a name(s) for the Amendment
Voting process(es) specified in the XML
Input file.
112022
Information about Tranches cannot be
found.
This message concerns the Deal Report.
There are no tranches found for the provided
Process. Contact your Intralinks administrator.
112023
The group <GROUP NAME> is not
marked as a lender group on the
exchange. It must be a lender group to be
included in the reconciliation process.
Please verify that the lender group name
you entered in the XML Input file is correct
and that it is designated as a lender group
on the Intralinks exchange.
112024
The lender group <GROUP NAME> exists
on the deal exchange, but is not included
in the source file.
Please enter a lender group name in the
XML Input file.
112025
A value is required for ConversionPercentage/LenderVotePercentage.
Please enter a value for Conversion Percentage/Lender Vote Percentage in the XML
Input file.
112026
Tranche name {0} length is longer than
the maximum allowed length. This must
be less than 255 characters long.
Please re-enter a valid tranche name in the
XML Input file.
112027
The lender group <GROUP NAME> must
be a collaboration group to be included in
the reconciliation process.
Please verify that you entered the correct
lender group name in the XML Input file and
that this group is designated as a collaboration group on the Intralinks exchange.
112028
The group <GROUP NAME> must be a
lender group to be included in the reconciliation process.
Please verify that you entered the correct
group name in the XML Input file and that
this group is designated as a lender group
on the Intralinks exchange.
112029
The lender group {0} is not a collaboration
group on the exchange. It must be a collaboration group to be included in the reconciliation process.
Please verify that you entered the correct
lender group name in the XML Input file and
that this group is designated as a collaboration group on the Intralinks exchange.
112030
The group <GROUP NAME> is not
marked as a lender group on the
exchange. It must be a lender group to be
included in the reconciliation process.
Please verify that you entered the correct
group name in the XML Input file and that
this group is designated as a lender group
on the Intralinks exchange.
112031
This exchange does not support amendment voting. It cannot be included on the
report.
Please verify that you entered the correct
exchange number in the XML Input file. If so,
please contact your Intralinks exchange
manager.
Intralinks Integration Adapter User Guide
page 287
No.
Problem
Resolution
112032
Tranche data will only be available for
active tranches. The following tranches
are not active, and information will not be
available for them in Intralinks: <List of
Tranche Name/Status>
No action required.
112033
Group information is required in order to
run a reconciliation process.
Please enter the required group information
in the XML Input file.
DMS processing errors
No.
Problem
Resolution
113000
All-in rate must be less than or equal to
99999
Please enter a valid All-in rate.
113001
All-in rate must be greater than or equal to
0
All-in rate must be less than or equal to
99999
113002
All-in rate must be less than or equal to
999.999
All-in rate must be less than or equal to
99999
113003
All-in rate must be greater than or equal to
0.00
All-in rate must be less than or equal to
99999
113004
You cannot assign this Organization as a
Arranger for this deal.
Please assign another Organization as
Arranger for this deal.
113005
This Arranger already exists. You cannot
have duplicate Arrangers.
Please enter a valid Arranger.
113006
Duplicate Arranger Title.
Please enter a valid Arranger.
113007
Base Rate must be less than or equal to
99999
Please enter a valid Base Rate.
113008
Base Rate must be greater than or equal
to 0
Please enter a valid Base Rate.
113009
Base Rate must be less than or equal to
999.999
Please enter a valid Base Rate.
113010
Base Rate must be greater than or equal
to 0.00
Please enter a valid Base Rate.
113011
Commitment Amount maximum value
must be less than or equal to
99999999999999.00
Please enter a valid Commitment Amount.
113012
Commitment Amount must be greater
than or equal to 0.00
Please enter a valid Commitment Amount.
113013
Commitment Spread must be less than or
equal to 99999
Please enter a valid Commitment Amount.
113014
Commitment Spread minimum value must
be greater than or equal to 0
Please enter a valid Commitment Spread.
113015
Invalid format
Please use the correct format for this entry.
Intralinks Integration Adapter User Guide
page 288
No.
Problem
Resolution
113016
Deal CUSIP must contain 9 characters
Please enter a valid CUSIP.
113017
Invalid format
Please use the correct format for this entry.
113018
Deal Name cannot contain more than 100
characters
Please enter a valid Deal Name.
113019
Deal Name must contain at least 1 character
Please enter a valid Deal Name.
113020
Deal Stage and Status do not match.
Please ensure that the Deal Stage and Deal
Status don’t conflict.
113021
Duplicate currency is not allowed
No action required.
113022
The name already exists for another deal.
Please enter a valid Deal Name.
113023
An Investor with the same name already
exists in the input file
Please enter a valid Investor name.
113024
The Subsidiary Borrower specified for this
tranche already exists in the input file.
Remove one of the Subsidiary Borrowers
from the XML Input file.
113025
A tranche with the same name already
exists in the input file
Remove one of the tranches with the same
name from the XML Input file or rename one
of tranches.
113026
Invalid format
Please use the correct format for this entry.
113027
Facility CUSIP must contain 9 characters
Please enter a valid CUSIP.
113028
Invalid format
Please use the correct format for this entry.
113029
Fee Amount must be less than or equal to
99999999999999.00
Please enter a valid Fee Amount.
113030
Fee Amount must be greater than or equal
to 0.00
Please enter a valid Fee Amount.
113031
Final Allocation Amount must be less than
or equal to 99999999999999.00
Please enter a valid Final Allocation Amount.
113032
Final Allocation Amount must be greater
than or equal to 0.00
Please enter a valid Final Allocation Amount.
113033
Final Hold Amount must be less than or
equal to 99999999999999.00
Please enter a valid Final Hold Amount.
113034
Final Hold Amount must be greater than
or equal to 0.00
Please enter a valid Final Hold Amount.
113035
Final OID Amount must be less than or
equal to 99999
Please enter a valid OID Amount.
113036
Final OID Amount maximum whole value
must be less than or equal to 999.999
Please enter a valid OID Amount.
113037
Final OID Amount minimum whole value
must be greater than or equal to 0
Please enter a valid OID Amount.
113038
Final Spread Amount must be less than or
equal to 999.999
Please enter a valid Final Spread Amount.
Intralinks Integration Adapter User Guide
page 289
No.
Problem
113039
Final Spread must be less than or equal to
99999
Please enter a valid Final Spread.
113040
Final Spread must be greater than or
equal to 0.000
Please enter a valid Final Spread.
113041
Final Spread must be greater than or
equal to 0
Please enter a valid Final Spread.
113042
Floor value must be less than or equal to
999.999
Please enter a valid Floor value.
113043
Floor value must be less than or equal to
99999
Please enter a valid Floor value.
113044
Floor value must be greater than or equal
to 0.00
Please enter a valid Floor value.
113045
Floor value must be greater than or equal
to 0.000
Please enter a valid Floor value.
113046
Invalid format
Please use the correct format for this entry.
113047
Global Commitment must be less than or
equal to 99999999999999.00
Please enter a valid Global Commitment
value.
113048
Global Commitment must be greater than
or equal to 0.00
Please enter a valid Global Commitment
value.
113049
The Organization Type is not Investor.
This Organization cannot be assigned as
a Investor to a tranche.
Please enter a valid Investor Organization.
113050
Investor Name cannot contain more than
100 characters
Please enter a valid Investor Name.
113051
Investor Name must contain at least 1
character
Please enter a valid Investor Name.
113052
Invalid Investor Organization Owner
Please enter a valid Investor Organization
Owner.
113053
For Pro-rata deal, this Investor should be
associated with all the tranches in the
deal.
Enter the same Investor name for all the
tranches in this Pro-rata deal in the XML
Input file.
113054
Lending Type cannot be changed to Prorata.
No action required.
113055
Invalid format
Please use the correct format for this entry.
113056
Maturity Value must be less than or equal
to 364
Please enter a valid Maturity Value.
113057
Maturity Value must be greater than or
equal to 1
Please enter a valid Maturity Value.
113058
Invalid format
Please use the correct format for this entry.
113059
Maturity Value must be less than or equal
to 12
Please enter a valid Maturity Value.
Intralinks Integration Adapter User Guide
Resolution
page 290
No.
Problem
Resolution
113060
Maturity Value must be greater than or
equal to 1
Please enter a valid Maturity Value.
113061
Maturity Value must be less than or equal
to 99.99
Please enter a valid Maturity Value.
113062
Maturity Value must be greater than or
equal to 0.01
Please enter a valid Maturity Value.
113063
PL Code cannot contain more than 45
characters
Please enter a valid PL Code.
113064
PL Code must contain at least 1 character
Please enter a valid PL Code.
113066
Invalid format
Please use the correct format for this entry.
113067
Price Talk cannot contain more than 50
characters
Please limit you Price Talk entry to 50 characters or less.
113068
Price Talk must contain at least 1 character
Enter a valid value for Price Talk.
113069
You cannot assign this Organization as a
Primary Borrower for this deal.
Please assign a valid Organization as a Primary Borrower for this deal.
113070
You cannot change the Primary Borrower.
No action required.
113071
Invalid format
Please use the correct format for this entry.
113072
You cannot assign this Organization as a
Subsidiary Borrower for this deal.
Please assign a valid Organization as a
Subsidiary Borrower for this deal.
113073
Sub-borrower does not belong to Parent
Borrower.
Make sure the Sub-borrower belongs to the
Parent Borrower in the XML Input file.
113074
Target Hold Amount must be less than or
equal to 99999999999999.00
Please enter a valid Target Hold Amount.
113075
Target Hold Amount must be greater than
or equal to 0.00
Please enter a valid Target Hold Amount.
113076
Tranche Amount must be greater than or
equal to 99999999999999.00
Please enter a valid Tranche Amount.
113077
Tranche Amount must be less than or
equal to 1.00
Please enter a valid Tranche Amount.
113078
Invalid format
Please use the correct format for this entry.
113079
Tranche Name cannot contain more than
100 characters
Please enter a valid Tranche Name.
113080
Tranche Name must contain at least 1
character
Please enter a valid Tranche Name.
113081
Tranche Type and Tranche Subtype do
not match.
Please ensure that the Tranche Type and
Tranche Subtype match.
113082
Invalid format
Please use the correct format for this entry.
113083
Underwritten Amount must be less than or
equal to 99999999999999.00
Please enter a valid Underwritten Amount.
Intralinks Integration Adapter User Guide
page 291
No.
Problem
Resolution
113084
Subject is missing
Please enter a Subject.
113085
Subject contains invalid characters
Please enter a valid Subject.
113086
Subject has been truncated because it
exceeds maximum characters (400).
No action required.
113087
Comment is missing
Please enter a Comment.
113088
Comment has been truncated because it
exceeds maximum characters (4000).
No action required.
113089
Arranger name is incorrect. Could not tag
the comment to the Borrower Organization.
Please enter a valid Arranger name.
113090
Arranger Contact is incorrect. Could not
tag the comment to this Contact.
Please enter a valid Contact.
113091
Borrower name is incorrect. Could not tag
the comment to the Borrower Organization.
Please enter a valid Borrower.
113092
Borrower Contact is incorrect. Could not
tag the comment to this Contact.
Please enter a valid Borrower Contact.
113093
Investor name is incorrect. Could not tag
the comment to the Investor Organization.
Please enter a valid Investor name.
113094
The Organization is not valid. This Organization cannot be assigned as an Investor
to a tranche.
Please enter a valid Organization.
113095
Could not tag the comment to this deal
because the deal could not be found.
Remove the deal from the input file or correct the deal name.
113096
Could not tag the comment to this tranche
because the tranche could not be found.
Remove the tranche from the input file or
correct the tranche name.
113097
When the Arranger is the External DMS
Organization, Organization owner must be
associated with Arranger Organization for
a Joint Book Deal.
Please enter a valid Organization owner.
113098
For non-Joint-Book Deal, Organization
Owner should be an active DMS user.
Ensure that the Organization Owner has an
“Active” status in DMS. Consult the Intralinks
DMS User Guide.
113099
For Joint Book Deal, when Arranger is the
Internal DMS Organization, Organization
Owner should be an active DMS user.
Ensure that the Organization Owner has an
“Active” status in DMS. Consult the Intralinks
DMS User Guide.
113100
For Joint Book Deal, when Arranger is the
external Arranger Organization, Organization Owner should be a Working Group
Member of the particular Arranger.
Ensure that the Organization Owner is a
Working Group Member of this external
Arranger. Consult the Intralinks DMS User
Guide.
113101
Commitment Percentage should be same
for all the tranches in a Pro-rata deal.
In the input file, ensure that the Commitment
Percentage is the same for all tranches in
this Pro-rata deal.
Intralinks Integration Adapter User Guide
page 292
No.
Problem
Resolution
113102
Final Allocation Percentage should be
same for all the tranches in a Pro-rata
deal.
In the XML input file, assign the same Allocation Percentage to all tranches in this Prorata deal.
113103
DMS Contact does not match with the
associated Investor.
Change the Contact for the associated
Investor in the XML Input file.
113104
Underwritten Amount must be greater
than or equal to 0.00
Please enter a valid Underwritten Amount.
113105
Legal Name must contain at least 1 character
Please enter a valid Legal Name.
113106
Legal Name has been truncated because
it exceeds maximum characters (49).
No action required.
113107
Invalid format
Please use the correct format for this entry.
113108
Address Line 1 has been truncated
because it exceeds maximum characters
(45).
No action required.
113109
Address Line 2 has been truncated
because it exceeds maximum characters
(45).
No action required.
113110
City has been truncated because it
exceeds maximum characters (50).
No action required.
113111
State/Province has been truncated
because it exceeds maximum characters
(10).
No action required.
113112
Postal Code has been truncated because
it exceeds maximum characters (20).
No action required.
113113
Tax ID has been truncated because it
exceeds maximum characters (50).
No action required.
113114
Invalid format
Please use the correct format for this entry.
113115
Summary has been truncated because it
exceeds maximum characters (4000).
No action required.
113116
Invalid format
Please use the correct format for this entry.
113117
First Name must contain at least 1 character
Please enter a valid First Name.
113118
First Name has been truncated because it
exceeds maximum characters (29).
No action required.
113119
Invalid format
Please use the correct format for this entry.
113120
Last Name must contain at least 1 character
Please enter a valid Last Name.
113121
Last Name has been truncated because it
exceeds maximum characters (29).
No action required.
113122
Invalid format
Please use the correct format for this entry.
113123
Email must contain at least 5 characters
Please enter a valid email address.
Intralinks Integration Adapter User Guide
page 293
No.
Problem
113124
Email cannot contain more than 100 characters.
Please enter a valid email address.
113125
Invalid format
Please use the correct format for this entry.
113126
Fax cannot contain more than 255 characters.
Please enter a valid Fax number.
113127
Office Phone must contain at least 4 characters.
Please enter a valid Office Phone number.
113128
Office Phone has been truncated because
it exceeds maximum characters (29).
No action required.
113129
Invalid format
Please use the correct format for this entry.
113130
Mobile Phone must contain at least 4
characters.
Please enter a valid Mobile Phone number.
113131
Mobile Phone has been truncated
because it exceeds maximum characters
(29).
No action required.
113132
Invalid format
Please use the correct format for this entry.
113133
Address Line 1 has been truncated
because it exceeds maximum characters
(50).
No action required.
113134
City has been truncated because it
exceeds maximum characters (50).
No action required.
113135
State/Province has been truncated
because it exceeds maximum characters
(50).
No action required.
113136
Postal Code has been truncated because
it exceeds maximum characters (50).
No action required.
113137
Commitment Amount must be greater
than or equal to 0.00
Please enter a valid Commitment Amount.
113138
Commitment Amount must be less than or
equal to 99999999999999.00
Please enter a valid Commitment Amount.
113141
Commitment Spread must be greater than
or equal to 0
Please enter a valid Commitment Spread.
113142
Commitment Spread must be less than or
equal to 99999
Please enter a valid Commitment Spread.
113143
Final Allocation Amount must be greater
than or equal to 0.00
Please enter a valid Final Allocation Amount.
113144
Final Allocation Amount must be less than
or equal to 99999999999999.00
Please enter a valid Final Allocation Amount.
113147
Final Spread must be greater than or
equal to 0
Please enter a valid Final Allocation Spread.
113148
Final Spread must be less than or equal to
99999
Please enter a valid Final Allocation Spread.
Intralinks Integration Adapter User Guide
Resolution
page 294
No.
Problem
113157
Contact Owner should be an Active user.
Please verify that the Contact Owner is an
active user. If not, enter another Contact
Owner.
113158
For non-Joint-Book Deal, assigned
Arranger does not apply.
No action required. The deal Arranger for a
non-Joint-Book deal defaults to the Organization of the DMS user setting up the deal.
113159
PL Code has been truncated because it
exceeds maximum characters (50).
No action required.
113160
Cannot create Contact; Email ID is used
by another Contact.
Please verify the email ID assigned to this
Contact and try again.
113161
Parent could not be added.
Please enter a valid Parent name in the XML
Input file.
113162
Incorrect Owner.
Please enter a valid Owner in the input file
113163
This Tax ID already exists.
Please enter a valid Tax ID.
113164
One or more CUSIPs already exist.
Please remove any duplicate CUSIPs from
the XML Input file.
113165
This Contact already exists in the Working
Group.
No action required.
113167
For non-Joint-Book Deal, Organization
Owner must be an Active DMS User.
Please ensure that the Organization Owner
is given an “Active” status in DMS. Consult
the Intralinks DMS User Guide.
113168
For Joint Book Deal, when Arranger is the
Internal DMS Organization, Organization
Owner must be an active DMS user.
Please ensure that the Organization Owner
is given an “Active” status in DMS. Consult
the Intralinks DMS User Guide.
113169
For Joint Book Deal, when Arranger is the
external Arranger Organization, Organization Owner must be a Working Group
Member of the particular Arranger
Please ensure that the Organization Owner
is a Working Group Member of the Arranger.
Consult the Intralinks DMS User Guide.
113170
The assigned Arranger Organization is not
associated with the deal
Ensure that you have the correct Arranger
Organization. If you do not, identify the organizations currently associated with the deal.
Consult the Intralinks DMS User Guide.
113172
Address Line 2 has been truncated
because it exceeds maximum characters
(50).
No action required.
113173
Contact already exists.
No action required.
113174
Organization name is incorrect. Could not
tag the comment to the Organization.
Verify the Organization name and try again.
113177
Could not tag the comment to this deal.
Deal name does not exist. Provide a valid
deal name.
113178
Could not tag the comment to this tranche.
Tranche name does not exist inside this
deal. Provide a valid tranche name.
113179
Working Group Member is not valid.
The user you are trying to add is not a member of the Working Group Organization.
Intralinks Integration Adapter User Guide
Resolution
page 295
No.
Problem
Resolution
113182
Duplicate values not allowed
Please enter a new value.
113183
The Organization of the Working Group
Member is not associated with the deal.
Please ensure that the Working Group Member is within an Organization associated with
the deal. Consult the Intralinks DMS User
Guide.
113184
Contact/User is not associated with this
Investor
Please enter a valid Investor Contact.
113187
Invalid format
Please use the correct format for this entry.
113189
No new actions are required for the Deal
Group.
No action required.
113190
Incorrect Industry Identifier value.
Please enter a valid Industry Identifier value.
113191
Rating Value not present
Please enter a Rating Value.
113192
Rating Effective Date not present
Please enter a valid Rating Effective Date.
113193
Incorrect Effective Date.
Please enter a valid Effective Date.
113194
Incorrect Industry Identifier value.
Please enter a valid Industry Identifier value.
113195
Industry Identifier Value cannot contain
more than 50 characters
Please enter a valid Industry Identifier value.
113196
Internal Organization required
Please enter a valid Internal Organization.
113198
For Pro-rata Joint Book deal, this Investor
should assign the same Arranger Organization for all the tranches in the deal.
Assign the same Investor to all of the
tranches in the deal.
113199
Not able to update Organization Parent.
No action required.
113200
You cannot assign an Inactive Status to
the Parent Organization if the Child Organization is active.
No action required.
113201
You cannot update the Type of an Organization.
No action required.
113202
The name already exists.
No action required.
113203
The profile already exists.
No action required.
113204
Invalid Parent; Parent does not exist.
There is no Parent Organization with that
name in DMS. Verify the name of the Parent
Organization you are assigning.
113206
Invalid Rating Date.
Please enter valid date for the Borrower Rating.
113208
Organization Type is invalid.
Please enter a valid Organization Type (Borrower, Arranger, Investor).
113210
Organization create is not allowed.
No action required.
113211
Parent of a Rating Value does not match
the Rating Type.
Please reenter a valid Rating Value/Rating
Type in the XML Input file. Consult the Intralinks DMS User Guide for a list of Rating
Types and Rating Values.
Intralinks Integration Adapter User Guide
page 296
No.
Problem
Resolution
113213
Internal Organization already exists.
No action required.
113214
Cannot create an Internal Organization
with type other than Arranger.
Please change the Organization Type to
Arranger.
113215
Cannot update an Internal Organization.
No action required.
113216
Cannot create an Internal Organization
with Status Inactive.
Please change the Status to “Active”
113217
Cannot create multiple Internal Organizations.
No action required.
113218
Cannot assign Parent to an Internal Organization.
No action required.
113219
Cannot create Organization when there
are duplicate names.
No action required.
113221
Cannot create/update Contact due to
duplicate email addresses in the request.
Please verify the email address of the Contact you are creating/updating and remove
the other email address you are assigning to
this Contact from the XML Input file.
113222
Cannot create Contact because a mismatch exists between Organization value
in Intralinks and the Organization value in
DMS.
Please enter the Contact’s Organization as it
appears in the Intralinks Global User Directory. Consult your Intralinks administrator if
you are unsure.
113224
Cannot add Comment to Contact.
Contact may be “Inactive” or comment have
exceeded character limit.
113225
Cannot update Contact because the Contact's status is Inactive.
Consult your DMS Administrator about having the user’s status changed to “Active”.
113226
Not able to assign Owner to the deal.
Owner may be “Inactive” or deal may be
closed.
113227
Not able to associate Borrower with the
deal.
Borrower may be “Inactive” or the deal may
be closed.
113228
Not able to associate Borrower Contacts
with the deal.
Borrower Contacts may be “Inactive” or the
deal may be closed.
113229
Not able to create Deal Workspace Group
on the Intralinks Exchange.
Contact your Intralinks System Administrator.
113230
The Primary Borrower for the deal
selected is not a Parent Organization or
the Primary Borrower is assigned an Inactive status.
Consult you DMS System Administrator.
113231
You cannot change the Status of this deal.
No action required.
113234
Invalid Organization Type.
Organization Type can only be Arranger,
Borrower, or Investor. Check you XML Input
file and ensure you have selected one of
these types.
Intralinks Integration Adapter User Guide
page 297
No.
Problem
Resolution
113236
The Stage and Status of the deal do not
match.
Please ensure that the Stage and Status
entries for this deal are consistent in the
XML Input file. Consult the Intralinks DMS
User Guide, Appendix A, for a list of Stage
and Status values.
113237
The deal must be in Final Allocations to
finalize the Book.
Please review the status of the deal and set
the Status to
113238
You cannot edit a deal when the Stage is
Closed.
Please change the Status of the deal if you
wish to make further edits.
113240
Contact Organization does not match
Investor Organization.
Verify the Organization name in the Intralinks exchange and reenter the proper information in the XML Input file.
113241
An Organization cannot be of multiple
types.
Assign the Organization as a single type
(Borrower, Arranger, Investor)
113242
A deal name must be unique.
Assign a single name to this deal in the XML
Input file.
113243
The Lending Type of this deal cannot be
changed to Pro-rata.
No action required.
113244
You must include an Internal Arranger.
Please enter a valid Internal Arranger.
113245
You cannot update the Internal Organization.
No action required.
113246
Multiple Joint Book Runner Permissions
are not allowed for Arranger.
Check the XML Input file to ensure that only
one Joint Book Runner Permission is
assigned.
113247
This deal is not accessible to a Coarranger user.
No action required.
113248
Tranche Fee is invalid.
Please enter a valid Tranche Fee.
113249
Tranche cannot be deleted when a deal is
in Mandate Status.
Change the Status of the deal if you want to
delete this tranche.
113250
Tranche cannot be created or updated
when a deal is in Final Allocation Status.
Change the Status of the deal if you want
create a new trance or update a tranche.
113251
Tranche has a duplicate Tranche Type.
A tranche must be of a single type. Verify
that the XML Input file has only a single type
for this tranche.
113252
Deal requires a Primary Borrower.
Please enter a valid Primary Borrower for
this deal.
113253
Mismatch between Parent Borrower and
Sub-borrower.
You can only add a Subsidiary Borrower to
the tranche if the Parent Borrower is associated with the deal.
113254
The Agreed Tranche Commitment for the
tranches in the deal (the sum total)
exceeds the Global Commitment for the
deal.
Please adjust the tranche commitments so
they equal the Global Commitment.
Intralinks Integration Adapter User Guide
page 298
No.
Problem
Resolution
113255
The tranche CUSIP already exists.
A tranche can only have one CUSIP. Verify
that you have included only one CUSIP for
this tranche in the Input XML file.
113256
Organization Type can’t be Investor.
Please change the Organization Profile
Type to either Arranger or Borrower.
113258
Investor Contact already exists.
No action required.
113259
A tranche with the same name exists in
the system.
Please remove one of the tranche names
from the XML Input file.
113260
You cannot update more than one tranche
on a Pro-rata deal.
Ensure that the XML Input file contains an
update for only one tranche for this deal.
113261
The Contact has an Inactive status.
Please consult your DMS administrator to
have the Contact status changed to “Active.”
113262
The tranche could not be updated
because the status is Inactive.
Assign the tranche an “Active” status.
113263
Maturity Value cannot have more than one
decimal place.
Please enter a valid Maturity Value.
113264
The Intralinks GUD user is already associated with DMS.
No action required.
113265
You cannot update yourself in DMS.
No action required.
113266
This user is an administrator and cannot
be a DMS user.
No action required.
113267
Mismatch between GUD Organization
Name and DMS Organization Name.
Verify the Organization name with your Intralinks administrator.
113268
This Contact cannot be added to the
Working Group because the Contact's
Organization is invalid.
Please select a valid Organization for this
Contact.
113270
This member already exists in this Working Group.
No action required.
113271
You cannot perform this action because
you are not a DMS administrator.
No action required.
113272
One or more of the roles given to the
Organizations have not been found on the
exchange template.
Consult your DMS administrator and your
Intralinks administrator to ensure that the
assigned roles agree.
113273
This Organization Type cannot be
assigned to this Investor.
Please assign another Organization Type
(Investor, Borrower, Arranger) to this Investor.
113274
This Organization is not an Internal Organization.
No action required.
113276
This Organization is not an Arranger for
this deal.
If you want, you can assign this Organization
as an Arranger for this deal. Otherwise, no
action required.
113277
An Internal Organization has not been
assigned.
Assign an Internal Organization.
Intralinks Integration Adapter User Guide
page 299
No.
Problem
Resolution
113280
This entry is invalid.
No action required.
113281
Multiple Joint Book Runner Permissions
are not allowed.
Check the XML Input file to ensure that only
one Joint Book Runner Permission is
assigned.
113283
One or more Investors cannot be copied
to the target tranche because the target
tranche Status is Inactive.
Activate the target tranche to add these
Investors.
113184
Contact/User is not associated with this
Investor.
Please enter a valid Investor Contact.
113285
One or more Arrangers passed are duplicate.
Please remove the duplicate Arrangers from
the XML Input file.
113290
This Organization already exists in the
Comments pane.
No action required.
113291
This comment cannot be tagged. Associate the Internal Organization with a deal,
tranche, or other organization and try
again.
Associate the Internal Organization with a
deal, tranche, or other organization and try
again.
113292
You cannot add contacts to an Internal
Organization.
No action required.
113293
The Parent of this Organization cannot be
updated.
No action required.
113294
This Contact is Inactive and cannot be
updated.
Activate Contact or select another Contact.
113295
Primary Borrower and Subsidiary Borrower cannot be the same.
Change either the Primary or the Subsidiary
borrower.
113296
This Contact already exists in the Working
Group.
No action required.
Intralinks Platform errors
The following errors may occur while adding files to Intralinks Platform exchanges
that use Intralinks plugin-free information rights management (IRM). The
messages indicate that the specified documents could not be encrypted or that
another problem occurred.
Error Code
Message
IL_ARC_400_31_1
The file is protected by a password or third-party IRM.
IL_ARC_400_31_2
The file is digitally signed.
IL_ARC_400_31_3
Intralinks plugin-free IRM has been applied to the file already.
IL_ARC_400_31_4
The file is corrupted.
IL_ARC_400_31_5
The file is already unprotected.
IL_ARC_400_31_6
The user's rights do not allow file uploads.
Intralinks Integration Adapter User Guide
page 300
Error Code
Message
IL_ARC_400_31_7
An error occurred. Please try again.
IL_ARC_400_31_9
The file format is not correct or not supported.
Intralinks Integration Adapter User Guide
page 301
Appendix A: Performance Guidelines and
Limitations
Intralinks Integration Adapter
Performance Aspect
Guideline
Comments
Number of top (root) folders
created per input file.
Maximum of 200 top-level
folders.
You can create up to 200 top-level
folders in one job.
Number of folders in an
exchange.
10,000 folders total in one
exchange.
You can create up to 2000 folders in
one job.
If you need to create more than
2000 folders, use multiple jobs.
Number of folder levels.
Maximum recommended folder
depth is 10.
If you are creating the maximum
number of folders in a single job
(2000), it is recommended that you
keep the folder levels to a depth of
4.
Folder count per input file.
2000
If more than 2000 folders are
needed in the exchange, multiple
input files should be used.
Number of folders when
Folder Level Permission is
“On”
Up to 1000 folders in one job
Number of folders when
Folder Level Permission is
“Off”
Up to 2000 folders in one job
Folder count per input file
when Folder Level Permission
is “On”
1000
If more than 1000 folders are
needed in the exchange, multiple
input files should be used.
Folder count per input file
when Folder Level Permission
is “Off”
2000
If more than 2000 folders are
needed in the exchange, multiple
input files should be used.
Document count per input file
2000
Largest individual file size for
uploading and downloading.
11 GB per file.
Number of exchanges per
input file.
100
Number of users supported on
an exchange.
5000 users.
Number of groups supported
on an exchange.
2500 groups.
Intralinks Integration Adapter User Guide
Expected download rate of 1 hour
per GB for file operations, using a
business-quality Internet
connection.
There is no system limit but
performance slows as the number
of users increases.
page 302
Performance Aspect
Guideline
Comments
Number of users supported in
a single group
2500 users per group.
Number of users who can be
added or removed in one job.
5000
Exchange limit.
Number of groups that can be
created or removed in one job
2500
Exchange limit.
Deleting empty groups using
the Configuration Manager
setting.
Under 100 groups.
It is recommended that you have
less than 100 groups in the
exchange if you are using the
Configuration Manager to
automatically remove empty
groups.
Intralinks Exchange
Performance Aspect
Documents
Folders
Users
Groups
Guideline
Comments
Total number
20,000
Affects advanced reports and
exports, DVD archive, and smart
filters. Performance degrades as
the number of documents
increases.
Number in a
single folder
1,000
Performance of folder navigation
will slow as the number of items in
the folder increases.
File size
2 GB
6 GB (ILC only)
6 GB applies only to Courier clients.
Larger size files may be possible,
but 6 GB is the maximum size
tested.
Total size
40 GB
Greater size is possible but may
affect DVD archives.
Total number
10,000
Number of toplevel folders
200
Total users in an
exchange
5000
Total users in a
group
2500
Total number
2500
Intralinks Integration Adapter User Guide
page 303
Client limitations and guidelines
Performance Aspect
Bulk Operations (all
clients)
Intralinks Designer (ILD)
Intralinks Courier
FileSplit
Download Wizard
Guideline
Comments
Permissions
125,000
Setting permissions in bulk (using
permission overview, set folder
permissions, etc.) should be limited
to 125,000 permission records at a
time (total number of documents
multiplied by total number of
groups).
Deletion of
documents
6,000
Deletion of
folders
2,000
Copy/paste
5,000
File size
1,000
Move/re-index
files
1,000
Add folders
2,000
Document
updates
(properties, tags,
etc.)
1,000
File size
6 GB
Bulk account
creation
1000
Distribution
count
500
Posting count
150
Template file
page count
15
Field count
15
Total number of
files per
download
40,000
Expected download rate of 1 hour
per GB for file operations, using a
business-quality Internet
connection.
Total size of
download
6 GB
Expected download rate of 1 hour
per GB for file operations, using a
business-quality Internet
connection.
Intralinks Integration Adapter User Guide
Total of folders and documents
should be fewer than 5,000.
page 304
Appendix B: Validation Rules
Field Name
Comments
FirstName
Validated on server. Limit 29 characters.
Cannot use the following special characters:
/ @, ~ % + : {} () [] <> | ` ; \ "
LastName
Validated on server. Limit 29 characters.
Cannot use the following special characters:
/ @, ~ % + : {} () [] <> | ` ; \ "
Email address
Limit 100 characters; minimum 7 (including @ and .com characters)
All email addresses must include @ and .com in the valid email order
Minimum 1 character before the ‘@’
Minimum 1 character after the ‘@’ and before the ‘.com’
Example:
a@a.com (minimum length email address)
Address 1
Validated on server. Limit 50 characters.
Address 2
Validated on server. Limit 50 characters.
City
Validated on server. Limit 50 characters.
State
Validated on server. Limit 50 characters.
Zip code
Validated on server. Limit 50 characters.
Org
Validated on server. Limit 49 characters.
Cannot use the following special characters:
/ @, ~ % + : {} () [] <> | ` ; \ "
Phone
29-character limit. 4 character minimum
Only the following characters are supported:
0 1 2 3 4 5 6 7 8 9 [ ] - . + x (lower-case only)
Examples:
x1234
111-222-5555 x1234
+011 44 1234556
(123) 555- 11111
Intralinks Integration Adapter User Guide
page 305
Field Name
Comments
Role
Can be one of the following:
"REVIEWER"
"PREVIEWER”
"PUBLISHER"
"MANAGER_LTD"
"MANAGER"
"REVIEWER_PLUS"
"PUBLISHER_PLUS"
"HIDDEN_MANAGER_PLUS"
"MANAGER_PLUS"
UserId
Must be a valid User ID on Intralinks. This is an email field and it can be
validated as a part of the setup and configuration process.
Group <Id>
Must be a valid Group ID on Intralinks. Validated on server.
You can specify multiple groups by separating them with commas.
Group <Name>
Validated on server. Limit 49 characters,
Cannot use the following special characters:
<> \
You can specify multiple groups by separating names with commas.
Group <Type>
Validated on server. Can be “Workspace”, “Buyer” or “Collaboration.”
Group Note
Maximum length is 200 characters.
Workspace <Id>
Must be a valid Workspace ID on Intralinks. Validated on server.
Can specify multiple workspaces by separating with commas.
Workspace <Name>
Must be a valid Workspace Name on Intralinks. Limit = 100 characters.
Cannot use the following special characters:
<> \ /
Validated on server. If you enter the Workspace Attribute and don’t provide a
value, validation will fail.
Can specify multiple workspaces by separating with commas.
Attachments
For IL5, the following characters are not permitted:
# \ / : * ? “ <> |
For Intralinks Platform, the following characters are not permitted:
/ \ : * “ <> ? | %
Maximum number of characters for attachment name:
For IL5: 255 (less the number of characters needed for the file extension and
the “dot”).
For Intralinks Platform: 245.
Intralinks Integration Adapter User Guide
page 306
Field Name
Comments
Folders
For IL5, two consecutive forward slashes (//) are not allowed, but a single
forward slash is allowed.
For Intralinks Platform, the following characters are not allowed:
/ \ : * " <> ? |
Maximum number of characters for the folder name.
60 characters (for either platform).
Folder Note
4000 characters maximum for either platform.
Groups
Maximum number of characters in group name.
49 characters (for either platform)
The following characters are not permitted: / \ < >
Publications
For IL5, two consecutive forward slashes (//) are not allowed, but a single
forward slash is allowed. In addition, the following are not permitted:
\ <>
For maximum character length:
Upon create event: 125*
Upon update event: 150
* Web Services allows 150 characters when creating a publication.
Document Note
4000 characters maximum for either platform.
Phase Names
Hold, Prep, Open
Host Name
100 characters maximum.
Courier Package Name
60 characters maximum.
For IL5, two consecutive forward slashes (//) are not allowed, but a single
forward slash is allowed.
For Intralinks Platform, the following characters are not allowed:
/ \ : * " <> ? |
Courier Body Text (for
Alert)
2500 characters maximum
Courier Package
Private Note Length
4000 characters maximum.
Courier Tracking Code
20 characters maximum.
Courier File Names
260 characters maximum
The following characters are not allowed:
#\ /:*? “ < > |
Intralinks Integration Adapter User Guide
page 307
Field Name
Comments
Do not use the following
reserved device names
for naming entities
CON, PRN, AUX, NUL, COM1, COM2, COM3, COM4, COM5, COM6, COM7,
COM8, COM9, LPT1, LPT2, LPT3, LPT4, LPT5, LPT6, LPT7, LPT8, and
LPT9.
Also avoid these names followed immediately by an extension; for example,
NUL.txt.
Intralinks Integration Adapter User Guide
page 308
Download PDF