KCM Guides
KCM Installation Guide
Kofax Communications Manager
KCM architecture
KCM components
Contract Manager data layers
Applications
Contracts
Instances
Installation options
General requirements
LDAP properties file
Basic installation
Installing KCM
Parameters
Manual component installation
KCM structure installation
Installing the KCM structure
Parameters
Adding a Contract Manager
Installing Contract Manager
Parameters
Starting Contract Manager
Parameters
Stopping Contract Manager
Adding a KCM Instance
Installing KCM Instance
Parameters
Starting KCM Instance
Parameters
Stopping KCM Instance
Registering KCM Instance manually
Adding KCM Control Center
Installing KCM Control Center
Parameters
Starting KCM Control Center
Parameters
Stopping KCM Control Center
Adding Batch & Output Management
Installing B&OM
Parameters
Starting B&OM
Parameters
Stopping B&OM
Creating primary B&OM installation
Creating secondary B&OM installation
Connecting a B&OM installation to an external KCM instance
Custom B&OM service hosts
Configuring the resources of a KCM Server
Install Kofax Communications Manager on Docker
Install the Contract Manager
Create the Contract Manager image
Create the Contract Manager container
Install Kofax Communications Manager instances
Create an instance image
Create an instance container
Configure KCM settings on Docker
Use the CompileInstanceScripts tool
Add constants
Add scripts
Use the ConfigureInstanceSettings tool
Get help for configuration settings type
Get help for runtime settings type
Runtime settings levels
Request runtime settings per level
Request runtime settings per setting type
Set values for configuration settings
Set values for runtime settings
Remove runtime settings
Use the ManageInstanceEnvironment tool
Environments
DIDs
DID modules
Use the RestartInstanceCoreDPServices tool
Other management tools on Docker
KCM Designer for Windows installation
KCM Toolbox for Word installation
Post-installation
Manage example web application
KCM Control Center
OAuth2 in KCM Control Center
Manage Contract Manager data with ManageCM tool
Available operations and command-line parameters
Reload the configuration
Create a partner
Remove a partner
Show information about partners
Create a contract
Show a contract
Remove a contract
Change properties of a contract
Create or update custom contract types
Show contract types
Remove custom contract types
Add interfaces
List interfaces
Remove interfaces
Add an application
List applications
Get a new key for the application
Remove an application
Add a privilege for the application
List privileges for the application
Get all privileges in an XML file
Set privileges
Remove a privilege for the application
Add a new contract type to a contract
Remove a contract type from a contract
Show instances
Register or unregister an instance
Export functionality and initialization of new components
Export Contract Manager configuration
Export KCM instance configuration
Export Batch & Output Management content
Initialize new KCM component using existing configuration
Manage KCM translation
Manage language packs
Retrieve a language pack
Translate a language pack
Add a language pack
List language packs
Validate a language pack
Remove a language pack
Manage translation of custom channels
Manage multiple KCM installations on the same server
Tools
Obtain information from a KCM installation
KCM upgrade
Upgrading KCM
Parameters
Upgrading Batch & Output Management
Switch to old installation
Uninstallation
Uninstall basic KCM deployment
Uninstall KCM Control Center
Uninstall Contract Manager
Uninstall KCM instance
Uninstall KCM Structure
Uninstall Batch & Output Management
Troubleshooting
Package cannot connect to database
Services cannot be created
Cannot start KCM Core for development or test license
CMRestAPI does not start during system startup
Timeouts during components installation or start
Upgrade failed due to unconfigured components
KCM Repository User Guide
Older versions of Repository
Roles and authorization
Predefined roles
Work with KCM Repository
CM Repository as a file system
Projects and folders
Create projects
View and edit objects
Lifecycle management
Use revisions of objects
Draft revisions
Revision numbering
Compare revisions
Restore deleted items
Label objects
Assign a label to an object
Assign characteristics to objects
Create copies of objects
Copy a revision of an object
Create a duplicate of a project
Create a copy of a project
Dependencies between different objects
Document revision dependencies
Master Template revision dependencies
DID revision dependencies
Text Block folder dependencies
Form dependencies
Form revision dependencies
Field Set dependencies
Text Block Lists dependencies
About Master Templates
Use auto-includes
Search paths
Search on the project level
Search on the folder level
Refresh usage information
Develop templates and content
Getting started
Work with data
Use Data Backbone
Data Backbone components
Edit and view Data Backbone
Outdated revisions of a Content Wizard
Data Backbone revision dependencies
Use DIDs
Work with content
Building blocks
Master Templates and Master Template scripts
Master Templates and their revisions get outdated
Text Blocks
Rich Text Blocks
Content Wizards
Requirements to use Content Wizards
Content Wizard and their revisions get outdated
Includes
Forms
QForms
Differences between Forms and QForms
Field Sets
Add a Field to a Field Set
Text Block Lists
Data Backbone
Work with document layout
Word Style Sheet and Word Page Style documents
Multi-brand support
Configure contents
Projects
Dynamic objects
Style Documents
DIDs
Master Templates
Run Master Templates on CM Core from CM Repository
Run Master Templates with dynamic objects
Retrieve building blocks
Retrieve a Master Template and its Data Backbone
Includes
Manage data
Save and Load
Import and Export
Set the identifier for revisions
Export
Transfer to another system
Archival and helpdesk
Import
Error report settings
Word processor settings
Other settings
KCM Repository Administrator Guide
Administer KCM Repository
Administrative account
Default password
After installation
Enter licenses
Administrative tasks
User management
Create user accounts
Allow login as Admin right
Unified logon
Rename a user account
Authorize a user account
Reset a password
Delete a user account
Manage user sessions
User authentication in LDAP mode
Configure the password policy
Requirements for password
Adjust the password policy settings
Configure a list of forbidden passwords
Project management
Break locks on objects
Purge deleted items
View an audit log
Obtain a report
Clear a project
Administrator tools
Dump and load the Repository database
New database
Configure a new database
Initialize a new database and upload reports
PDF preview for Rich Text Blocks
Undo Publish feature
Perform the Undo Publish operation
Configure Undo Publish feature
Restore a saved publication state
Publication states list
Publication state cleanup
Configuration
General
Syntax
Initialization file sections
Shared configuration
[Configuration]
Server configuration
[Server]
Unified logon
Licenses
[ODBC]
[Network]
Timeouts
Client configuration
[server]
Batch & Output Management metadata
Load Batch & Output Management metadata
Save Batch & Output Management metadata
Clear Batch & Output Management metadata
Check Batch & Output Management metadata
Troubleshooting
Object ID out of range for encoding
Forgot administrator password
KCM Repository Developer's Guide
API
Get Model API
Contents of the Get Model API
Call to the Get Model API
Text Block migration
Contents of the TBMigrate tool
Input files
Load Text Blocks
Examples
Import Quick Templates
KCM Template Scripting Developer's Guide
Master Templates and output
Basic structure of the Template scripting language
Integrate text and data
Data Backbone
Data retrieval
Variables and control structures
Built-in functions
Includes
Define Includes
Pre-includes
Post-includes
Manage styles in Includes
Errors in Includes
Pre-includes
Post-includes
Restrictions on ASCII documents
ASCII documents and styles
Keywords
General
Keywords to start and end a Template script
Blocks of code
Scope
Nested blocks
Naming conventions for variables
Entries
FORALL
WITH
Functions and procedures
PROC
FUNC
PATH
WHERE-PAR
Types
BOOL
NUMBER
TEXT
Special characters in a TEXT value
ARRAY
ASSIGN values to elements in ARRAY
MAP
ASSIGN values to elements in MAP
FIELDSET
Declare FIELDSET
Initialize FIELDSET
ASSIGN FIELDSET to another FIELDSET
Merge FIELDSET into another FIELDSET
Add values to FIELDSET
ASSIGN values from an entry to FIELDSET
ASSIGN values from TEXT MAP to FIELDSET
ASSIGN values from FIELDSET to TEXT MAP
Use FIELDSET contents
Remove all assigned Fields from FIELDSET
Forms and QForms
Special Field Sets
_Template
_Document
DATASTRUCTURE
Define a Data Structure
Define members of the Data Structure
Define a Data Structure variable
Access members
ASSIGN a Data Structure variable to another Data Set variable
Inline DATASTRUCTURE definitions
PARAMETER
Define PARAMETER
Description for parameters
Default values for parameters
Optional parameters
New parameters
Initial values for parameters
Use parameters
DOCUMENTSTYLE
Styling for Word output
Styling for HTML output
I/O operations
FORM
Add a FORM
Add identification to a FORM
Add a QUESTION to a FORM
Create a FORM with a file question
QUESTION
Keywords that can be used between QUESTION...ANSWER
Group the FORM content
Group the FORM content in TABLE
Keywords that can be used between BEGINGROUP…ENDGROUP
Add a static text to a FORM
Available Field Sets
Add a BUTTON to a FORM
Close a FORM
Default answers and validation
EXTRA
LEN
DFT
PROMPT
VALUES
CHOICE
INTERACT
WIZARD
Mandatory items in the Content Wizard
QForms
Data Backbone context
SELECTION_INPUT and SELECTION_OUTPUT maps
STOP
WRITE
ERROR
WARNING
Control Structures
IF
FOR
FOREACH
FOREACH KEY
FOREACH WIZARD/NODE
FOREACH SLOT
WHILE
REPEAT
Dynamic building blocks
Dynamic FORM statement
Insert a dynamic FORM
Dynamic Forms and the Data Backbone
TEXTBLOCK statement
Description of the TEXTBLOCK options
Manage Text Blocks styles
Available ITP_ styles in Word output
Available classes in HTML output
Styles structure and elements
Define an alternate set of styles
Insert Text Blocks in a table
Insert multiple Text Blocks
Text Blocks and Data Definitions
Master Template Defined VIEWs
Functions and procedures in Libraries
FORMAT functions
FILTER functions
Text Block properties
EXPORT functions and procedures
Exit point procedures
DBB_PRE_LOAD
DBB_POST_LOAD
DBB_POST_EDIT
DBB_PRE_PACK
Variables
Declare variables
Assign variables
Assign word processor instructions
Operators
Automatic conversions
Formulas and operators
The @ statement
Monadic operators
Dyadic operators
Functions
Text functions
fragment_of_characters
number_of_characters
compare_characters
lowercase_of_characters
uppercase_of_characters
trim
ltrim
rtrim
search
search_first
search_last
replace
lowercase
uppercase
text_to_number
text_fragment
length
lowercase2
uppercase2
uppercases
Date and time functions
date
date_in_words
today
now
number_to_date
format_date
Number function
numerals
number
number_in_words
picture
format
Symbols allowed in the mask
Editing sign controls
Currency symbols used by the format function
Leading symbols
Suppress leading zero
Language customization
round
truncate
round_upwards
uppercase_roman_number
lowercase_roman_number
ordinal
amount
amount_in_words
amount_in_words_euro
area
area_in_words
Mathematical functions
square
square_root
exponent
logarithm
sine
cosine
tangens
arctan
Control functions
euro
status_message
inc
Include a document part
Set alternate documents or documents parts
put_in_document
put_in_text_file
put_in_text_file2
add_to_output
open_buffer
put_buffer_in_document
pragma
LOCALE settings
pragma_struct
system
Return codes
itp_setting
document_property
Microsoft Word document property names
Custom properties
itpserver_parameter
runmodel_setting
itpserver_setting
environment_setting
session_parameter
create_csv
split_csv
add_user_xml
stylesheet
pagestyle
language_code
Supported KCM output languages
headers
footers
paper_types
insert_image
Named parameters
Supported image formats
Measurements and units
Image dimensions
Positioning
Image alignment
Overlapping and text wrapping
Images from the database or KCM Designer
Title and description
Image storage
insert_signature
Measurements and units
Sizing
Arrays functions
length_text_array
length_number_array
length_bool_array
sort_text_array
sort_text_array_characters
sort_text_array_index
sort_text_array_index_characters
sort_number_array
sort_number_array_index
Maps functions
length_text_map
length_number_map
length_bool_map
get_keys_text_map
get_keys_number_map
get_keys_bool_map
key_used_in_text_map
key_used_in_number_map
key_used_in_bool_map
Text Blocks functions
insert_text_block
insert_text_block_extended
get_fields_from_text_block
text_block_exists
import_text_block
get_text_blocks_in_view
read_text_block_from_file
import_text_block_base64
Field Sets functions
clear_fieldset
Data Structures functions
Arrays functions
length_fieldset_array
length_struct_array
sort_fieldset_array
sort_fieldset_array_characters
sort_fieldset_array_index
sort_fieldset_array_index_characters
sort_struct_array
sort_struct_array_characters
sort_struct_array_index
sort_struct_array_index_characters
Maps functions
length_fieldset_map
length_struct_map
get_keys_fieldset_map
get_keys_struct_map
key_used_in_fieldset_map
key_used_in_struct_map
Data structures functions
struct_has_content
fieldsets_in_scope
Dynamic building blocks
metadata_contains
Functions and keywords translations
Translation of the functions
Translation of the keywords
Enhanced Unicode Support
The EnhancedUnicodeMaps setting
Batch & Output Management Getting Started Guide
Introduction
Using KCM B&OM
Lifecycle of objects
Define slot and correspondence types
Define a slot type
Define a correspondence type
Define contact data and organizational metadata
Define contact configuration
Define organizational metadata configuration
Define channels
Define a channel
Define a channel for archiving
Create application, correspondence, and communication rules
About application rules
Configure application rules
Apply application rules
Syntax for application rules
About correspondence rules
Configure correspondence rules
Apply correspondence rules
Syntax for correspondence rules
About communication rules
Configure communication rules
Apply communication rules
Syntax for communication rules
Create requests
Correspondence request
Components: correspondence
Correspondences for compatibility templates
Application request
Components: application event
Application events for compatibility templates
Import request
Components: import correspondence
About standard processes
Information transfer between standard processes
Configure global settings for standard processes
Standard processes
Electronic output
Step 1: CCM_Registration
Step 2: CCM_Application
Step 3: CCM_Communication
Step 4: CCM_ElectronicDelivery
Printed output
Step 1: CCM_Registration
Step 2: CCM_Application
Step 3: CCM_Communication
Step 4: CCM_PrintDelivery
Step 5: CCM_Bundling
Step 6: CCM_Stacking
Step 7: CCM_Streaming
Step 8: CCM_Conversion
Step 9: CCM_Distribution
CCM_CleanUpAll standard process
Change the standard processes
Configure standard processes
Configure processing components in KCM Studio
Registration
Application
Communication
ElectronicDelivery
PrintDelivery
Bundling
Stacking
Streaming
Conversion
ConvertOptions property
Distribution
GarbageCollection and Timer
Define overlays
Glossary
Views columns in KCM Studio
Batch & Output Management Scripting Language Developer's Guide
Standard processes: scripts and functions
Structure of the standard processes
Electronic output
1: CCM_Registration
2: CCM_Application
3: CCM_Communication
4: CCM_ElectronicDelivery
Printed output
1: CCM_Registration
2: CCM_Application
3: CCM_Communication
4: CCM_PrintDelivery
5: CCM_Bundling
6: CCM_Stacking
7: CCM_Streaming
8: CCM_Conversion
9: CCM_Distribution
CCM_CleanUpAll
Processing component functions
RegisterRequest function
ProcessRequest function
CommunicateCorrespondence function
DeliverCommunication function (for electronic output)
DeliverCommunication function (for printed output)
Bundling component functions
Run function in bundling
Stacking component functions
Run function in stacking
Streaming component function
Run function in streaming
Conversion component functions
ConvertStack function
Distribution component functions
DistributeStack function
GarbageCollection component functions
Custom scripting
Configure the accounting functionality
Configure a custom database for accounting
Initiate request accounting
Initiate communication accounting
Add and modify document pages in streaming
Include additional pages for stack, envelope, or document
Modify a document page
Insert a bar code on a document page
Configure the distribution functionality
Batch & Output Management scripting language
Create scripts and conditions
Create a script
Create a condition
View context information
Create a script parameter
Assign a script to an event
Script and condition editor tools
Useful key combinations
Debug a script or condition
Debugger tools
Scripting functions
Data types
Control structures
Exception handling
Standard functions
Beep
BigInteger
CallSystem
CloseDatabase
Contains
Contains_Exactly
CreateGuid
CreatePool
Decimal
DeletePool
EncryptString
EndsWith
Eof
Execute
Float
Format
FormatStr
GetLookupValue
GetObject
GetVariable
GetSystemOId
InitDatabase
InitDataset
Integer
Max
Min
Parse
Protocol
Raise
ReRaise
Round
SetExecSQL
SetPoolVariable
Sleep
SplitStr
StartsWith
StrCompare
StrDelChar
StrIndexOf
StrLastIndexOf
String
StringListAdd
StringListClear
StringListCount
StringListGetCommaText
StringListGetText
StringListGetValue
StringListIndexOf
StringListItemValues
StringListLine
StringListLoad
StringListParams
StringListSave
StringListSetCommaText
StringListSetValue
StringListSort
StrLeft
StrLen
StrLower
StrPos
StrReplace
StrReverse
StrRight
StrTok
StrToLen
StrUpper
StrWord
StrWordCount
SubString
Trim
TrimEnd
TrimStart
Trunc
VerifyPool
Version
Date functions
Format specifiers
Functions of the MLDate class
CurrentDate
CurrentDateToString
DateStringToInt64
DayOfWeek
DaysInMonth
FormatDateTimeString
IncDate
Int64ToDateString
IsLeapYear
WeekOfYear
File processing functions
Functions of the MLDos class
Properties of the MLDos class
ChangeExtension
Combine
CopyFile
CreateTextFile
CreateDirectory
DeleteDirectory
DeleteFile
DeleteFiles
DirectoryExists
ExecuteSynchron
FileAppendText
FileExists
FileReadAllBytes
FileReadAllText
FileSize
GetCommandLine
GetCommandLineArgByName
GetCommandLineArgs
GetCurrentDirectory
GetDirectories
GetDirectoryName
GetDirectoryRoot
GetEnvironmentVariable
GetExtension
GetFileName
GetFileNameWithoutExtension
GetFiles
GetFileSystemEntries
GetFullPath
GetLogicalDrives
GetParentDirectory
GetPathRoot
GetRandomFileName
GetTempFileName
GetTempPath
HasExtension
IsPathRooted
MoveDirectory
MoveFile
ReplaceFile
SetCurrentDirectory
Functions of the MonaLisaTextFile class
Properties of the MonaLisaTextFile class
Append
Close
Eof
Flush
Open
ReadLine
ReadToEnd
Write
WriteFormat
WriteLine
WriteLineFormat
XML processing functions
Additional functions of the MLXmlDocument class
GetNamespaceManager
Load
LoadXml
Array functions
Properties of the MLArrays class
Functions of the MLArrays class
AddToArray
Clear
GetArray
GetAtIndex
InitFromArrayObject
InsertIntoArray
Object functions
Functions of the MLObjects class
CreateNewInstanceOfType
GetEnumValue
GetModule
GetTypeInModule
GetTypeOfObject
GetTypeOfObjectAsString
Scripting contexts
Process
Properties of the Process context
OnProcessError
Properties of the OnProcessError context
StreamingUnit
Properties of the StreamingUnit context
Functions of the IOdinStream interface
AppendDocument
GetProperty
LoadDocument
SetProperty
StreamingPage
Properties of the StreamingPage context
StackDistribution
Properties of the StackDistribution context
Encoding parameters
HTML color names
KCM Core Developer's Guide
Introduction to the functionality
KCM Core Services
Add a Service to create a script
Requirements for printer drivers
Amyuni printer drivers
Reinstall Amyuni printer drivers
Switch to an older Amyuni version
Log and setup reports
Watcher and KCM Document Processor Manager log
Change the size limit of the log file
Error messages
Location of the log files
Read performance statistics from logs
STATS: lines processing
Notifications
Monitor and Watcher
Monitor functionality
Monitor application
HTTP Monitor application
Watcher functionality
Security issues
External interface
Grant or restrict network access
Adjust internal interface settings
Job recovery
Component Object Model resources for job recovery
Document composition
Environments
ITPRun command
Use a rep:/ URl to create a document
Keys and extra parameters
Enable DisablePostIncludes
Specify the environment
IBM i connection parameters
Data Backbone XML setting
OutputMode setting
Master Templates running in a sandbox content
Closed Loop Identifier
RunDocumentPackTemplate Service
RunMdl Service
Test a template
KCM Core scripts
Create and deploy a Core scripting library
Job scheduling
Scheduled jobs
Exit points
Downtime and clock changes
Time zones and daylight saving time
Interactive scheduling
Jobs scheduling on all KCM Document Processors
Integration
APIs and Java classes
TCP/IP API for Microsoft Windows
SSubmitJob function
SSubmitJobMsg function
SSubmitJobEx4 and SSubmitJobEx5 functions
SUBMITJOB4 and SUBMITJOB5
ValidateFileName
ExchangeData
Error codes
Saclient.exe and swclient.exe
.NET library
.NET library installation and distribution
Aia.ITP.Server.Job class
Job method
Submit () method
SubmitAsync () method
ExchangeData event
FileDownload
FileUpload
ProgressMessage
TCP/IP for the IBM i platform
REQHST file
XCHGFIL file
XCHGPGM exit program
Java submission interface
Job class
Methods
ITPDS class
Fields
ITPDSDataReceiver interface
Methods
ITPDSDataSender interface
Methods
ITPDSExchangeData interface
Methods
ITPDSInputStream class
Methods
ProgressListener interface
Methods
Web Services interface
ASP.NET implementation
J2EE implementation
Interface variants
Submit a synchronous job to the Web Services interface
Submit
Sample request (bare version)
Sample reply (bare version)
Sample request (wrapped version)
Sample reply (wrapped version)
SubmitEx
SubmitExResult
Sample request (bare version)
Sample reply (bare version)
Sample request (wrapped version)
Sample reply (wrapped version)
SubmitEx2
SubmitEx2Result
Sample request (bare version)
Sample reply (bare version)
Sample request (wrapped version)
Sample reply (wrapped version)
Submit an asynchronous job to the Web Services interface
SubmitAsync
Sample request (bare version)
Sample reply (bare version)
Sample request (wrapped version)
Sample reply (wrapped version)
SubmitAsync results
itpserverreply.dll
Sample request (bare version)
Sample reply (bare version)
Sample request (wrapped version)
Sample reply (wrapped version)
SubmitAsyncEx2
Sample request (bare version)
Sample reply (bare version)
Sample request (wrapped version)
Sample reply (wrapped version)
SubmitAsyncEx2 results
itpserverreply.dll
Sample request (bare version)
Sample reply (bare version)
Sample request (wrapped version)
Sample reply (wrapped version)
Sample clients for synchronous and asynchronous jobs
Compatibility interfaces
SubmitEx
SubmitExResult
Sample request for SubmitEx
Sample reply for SubmitEx
SubmitEx2
SubmitEx2Result
Sample request for SubmitEx2
Sample reply for SubmitEx2
Directory Watch interface client
Install the KCM Core Directory Watch interface
Configure the KCM Core Directory Watch interface
Configure watched directories
ServiceType parameter values
Sample ITPDirWatch.ini file
Locate log files
Uninstall the KCM Core Directory Watch interface
MQSeries interface
Install the KCM Core MQSeries interface
Configure the MQSeries interface
MQSeries interface functionality
MQSeries configuration
MQSeries protocol
Submit jobs
MQSeries queues and requests
Request format
Request parameters
Invalid requests
Action notifications
Progress messages
File transfers
Uninstall a Service
XML metadata from template runs
XML metadata content
Produce XML metadata
Identify Forms and questions
Form and question IDs
KCM Core Text Block XML format
XML reference
KCM Core Text Block XML elements
Information for system administrators
Assign the Log on as a Service right to a user
Manage the configuration file
Word processing settings
Additional settings
KCM Core Scripting Language Developer's Guide
Introduction
Syntax and conventions of the Core scripting language
Script example: RunMdl script
Script example: RunDocumentPackTemplate script
Layout of the RunMdl and RunDocumentPackTemplate scripts
Rules for the syntax
How to structure your scripts
Start a new Service
Submit a job to a Service
Modify file names and file paths
Send email from a script
Send email without an attachment
Send email with an attachment
TXT and HTML attachments
HTML inline images
Specify the File parameter
Error conditions
Examples of the Mail command
Send preformatted email
KCM Core sessions
Create a session
Access an existing session
Clean up a session
Save and restore a session
Clone a session
KCM Document Packs
Create a Document Pack
Channels in Document Packs
Build a Document Pack
Manipulate content of a Document Pack
Manipulate Document Packs
Clean up a Document Pack
KCM Core exit point scripts
DailyTask.dss
HourlyTask.dss
UserStartUp.dss
UserShutDown.dss
Parameters, variables, constants, files, and expressions
Parameters
Scripts as commands: passing parameters
Map job request parameters to script parameters
Automatic conversion of types
Variables
Assign a value to a variable
Variable scope
Constants
Constants scope
Global constants
Internal constants
Location constants
Temporary files
Expressions
Basic expressions
Operations in expressions
Comments
Commands
Scripts as commands
Examples of script components
Removed support
AttachFilesToPDF
ChangeBins
CleanupSession
CloneSession
CloseDocumentPack
ConcatPDF
Global settings
ConvertCodepage
Code page location search order
Code page mapping files
ConvertDocument
Get a list of available formats and their numbers
Copy
CopyDocumentPack
CopyPDF
CreateDirectory
CreateDocumentPack
CreatePath
CreateSession
Delete
DistributeDocumentPackToOutputManagement
DocToPDF
Using Rendition
Using Microsoft Word
Changes in behavior since KCM 5.7.0
ExpireSessions
ExportDocToPDF
Global defaults
ExportDocToXPS
Global defaults
FTP
InsertDocumentPack
IterateDocumentPack
ITPError
ITPErrorReset
ITPRun
LogEvent
Lpr
Mail
Error conditions
MergePDF
Global settings
Move
OnError
PrintDocument
Progress
PStoPDF
ReceiveFile
RemoveDirectory
RepositoryImportProject
RepositoryExportProject
RestoreSession
RetrieveRepositoryObject
RunCommand
RunMacro
SaveDocumentPack
SaveSession
SecurePDF
Global settings
SendFile
SetSessionParameter
SetTimeOut
Shutdown
SimpleMail
Error conditions
SpoolFile
StartProgram
StopAllDMs
SubmitMaitenanceJob
Temporary
ThrowError
[@*USER] prefix
Unzip
Wait
WriteFile
Zip
Functions
directory_exists (x)
document_metadata (k)
exchange_data (k, v, t)
file_exists (x)
file_format (x)
get_cm_setting (x)
get_ini_setting (f, s, k)
get_sessionparameter (p)
set_sessionparameter (p, v)
get_document_from_pack (s, c, t, d)
get_slots_from_pack (c)
get_channels_from_pack (s)
hex (x)
index (x, s)
rindex (x, s)
itp_parameter (k)
length (x)
number (x)
text (x)
replace (x, s, t)
rsubstring (x, s, n)
substring (x, s, n)
template_property (k)
toupper (s)
tolower (s)
Conditional statements and iterations
If...Then...Fi
For...=...To...Step...Do...Od
ForEach...In...Do...Od
ForEach...File...Do...Od
ForEach...Folder...Do...Od
While
Break
Return
External tools
ITPWinMon
SetReadOnly.vbs
ChangeBins tool
ChangeBins configuration
Identify paper trays
Map input trays
Create the configuration file
Map paper trays
Return codes
Selective tray changes
Map tray settings
Example of different options combined
KCM Database Interface Definition Guide
Introduction to Database Interface Definition
About DID elements
Work with DIDs
Create and edit a DID
Generate an ODBC or Oracle entry
Generate an ODBC stored procedure entry
Upload a DID document to a project
Upload an existing DID to a project
Use a DID wizard to create a DID document
Browse a DID
Copy DID elements to use in a Master Template
Upload a DID created on "IBM System i" to a project
DID specification language
DID document syntax
DID definition
DID module
Included documents
Entries
Entry attributes
Subentries
DID defined functions
Function attributes
Aliases and imports
Fields
Field attributes
Configure connection types
Specify a connection type for a DID
Local connection
Sample local connection entry
ODBC connection
Sample ODBC connection entry
Oracle connection
Sample Oracle connection entry
XML file connection
Sample DID document with XML file connection
XML Web Services connection
Sample DID document with XML Web Services connection
XML MQSeries connection
Sample DID document with the XML MQSeries connection
Example content template
KCM ComposerUI for HTML5 JavaScript API Web Developer's Guide
Introduction
Interactive document composition
Cross-origin resource sharing
API
Dependencies
Calls
Objects
CcmComposerUIAPIV2.Model.RunCallbacks
CcmComposerUIAPIV2.Model.RunOptions
Keys to pass on the stylemap parameter
RunInfo
Result
Document
FieldInfo
Error
Test an example integration of the JavaScript API
Previous versions
CcmComposerUIAPIV1
Calls
Objects
CcmComposerUIAPIV1.Model.RunCallbacks
CcmComposerUIAPIV1.Model.RunOptions
RunInfo
Document
Error
Content management
Unsupported features
Content Wizards
Troubleshooting
PDF preview does not show scroll bars
KCM API Guide
Getting started
KCM package
Install KCM Designer for Windows
Configure Tomcat settings
Create KCM Designer Users
Allow login as Admin right
Requirements for password
Create a new project
Edit Data Backbone
Control calling applications and their access to Contract Manager interfaces
KCM API overview
SOAP web services
CCMInteractive contract type
CCMInteractive V1
CCMInteractive V2
CCMInteractive V3
CCMDistribution contract type
CCMDistribution V1
CCMDistribution V2
CCMAdministration contract type
CCMAdministration V1
CCMContentApprovalWorkflow contract type
CCMContentApprovalWorkflow V1
CCMCompatibility contract type
CCMCompatibility V1
CCMCompatibility V2
CCMCapabilities service
Designer requests
GUI requests
Explore requests
Designer administration requests
Composer requests
Document Pack composition
On-demand compose requests
Compose interactive requests
Document composition
On-demand compose request
Compose interactive requests
Document Pack processing requests
Document Pack Template rerun
Initial run
Rerun phases
Requirements for rerun
Resource handling requests
Administration requests
System Check requests
Example requests and responses
DesignerGetWorkV1
SystemCheckV1
CCMCapabilitiesVerifyContractTypeAvailableV1
KCM API description
Standard fields for web services requests
Field types for web services requests and responses
Web services error handling
Available calls
AdminGetLogsV1
AdminGetLogsV2
DesignerStartSessionV1
DesignerStartSessionV2
DesignerStartSessionV3
DesignerAddFieldsV1
DesignerAddUserV1
DesignerAddUserV2
DesignerAddRoleV1
DesignerApproveWorkV1
DesignerCreateWorkV1
DesignerGetDataBackBoneDefinitionV1
DesignerGetDocumentPackTemplateV1
DesignerGetDocumentTemplateV1
DesignerGetLetterbookV1
DesignerGetLetterbookV2
DesignerGetWorkV1
DesignerGetWorkStateV1
DesignerListAllWorkV1
DesignerListLetterbooksV1
DesignerListLetterbooksV2
DesignerListDocumentTemplatesV1
DesignerListProjectsV1
DesignerListProjectsV2
DesignerListTemplatesV1
DesignerPublishWorkV1
DesignerRejectWorkV1
DocumentPackInteractiveReviewV1
DocumentPackInteractiveModifyV1
DocumentPackInteractiveModifyFromReviewV1
DocumentPackConvertV1
DocumentPackDistributeV1
DocumentPackDistributeOutputManagementV1
DocumentPackDistributeWorkplaceV1
DocumentPackSignV1
ComposeDocumentPackV1
ComposeDocumentPackV2
ComposeDocumentPackInteractiveStartV1
ComposeDocumentPackInteractiveStartV2
ComposeInteractiveGetSuspendedSessionV1
ComposeInteractiveResumeSuspendedSessionV1
ComposeDocumentPackGetV1
ComposeDocxV1
ComposePdfV1
ComposeDocxInteractiveStartV1
ComposeDocxInteractiveGetV1
ComposePdfInteractiveStartV1
ComposePdfInteractiveGetV1
ComposeInteractiveFinishV1
FinishSessionV1
SystemCheckV1
SystemCheckInteractiveStartV1
SystemCheckInteractiveStartV2
SystemCheckInteractiveGetV1
SystemCheckInteractiveGetV2
DIDComposeDocxV1
DIDComposePdfV1
DIDComposeDocxInteractiveStartV1
DIDComposeDocxInteractiveGetV1
DIDComposePdfInteractiveStartV1
DIDComposePdfInteractiveGetV1
DIDComposePackV1
DIDComposePackV2
DIDComposePackInteractiveStartV1
DIDComposePackInteractiveStartV2
DIDComposePackGetV1
DIDFinishSessionV1
CCMCapabilitiesVerifyContractTypeAvailableV1
Format for the definitions
Document Pack Manifest XML
Document Pack Template XML
Document Template XML
Letter Book XML
List Letter Books XML
List Projects XML
List Templates XML
Import Documents XML
KCM Core exit points
ContractDocToPDF
DistributeDocumentPack
KTADistributeDocumentPack
MakePDFDocument
›
KCM API Guide
›
KCM API description
›
Available calls
Available calls
×
KCM Guides