Ricoh InfoPrint Pro C900AFP InfoPrint Manager - Page 211

Notes, Transform options, terminating return code

Page 211 highlights

Notes: 1. If you are specifying any substitutions for which the passed values can contain a blank space, such as job name, be sure to put quotes around the substitution so it is passed correctly. Note that this only applies to single % substitution variables. Do not put quotes around any %% substitution variables. 2. The examples that follow presume that the PATH environment variable has been set to the appropriate path so you do not have to specify the fully qualified path name in the Transform options field. Table 26. Transform substitution variables Transform options substitution variables Meaning %i The name of the input file to transform. %o The name of the file in which to store the output of the transform. Note: If this is a non-terminating transform, data must be stored in the file named by %o. %e The name of the file in which to store any transform information or error messages. If anything is written to this file, it is logged in the InfoPrint Manager server log. Notes: 1. If the transform exits with an exit code of 0 or the value set in the Conditional terminating return code field, the error messages from the transform are logged as debug severity. 2. If the transform exits with a non-zero return code, but not with the value set in the Conditional terminating return code field transform attribute, the error messages from the transform are logged as error severity. 3. InfoPrint Manager writes transform error messages to either the file specified through this substitution variable, or to standard error (stderr). You should not mix output to %e and stderr in a single run of the exit program. You should use either one or the other in any given run. %u The name of the file for updating the pages-completed and job-page-count job attributes. Note: This file should only be accessed through the transform_update utility. %j The name of the original print file, minus the path (from the document-file-name attribute). Note: This should only be used to construct another name, such as a temporary file. %n The name of the original print file, minus the path and minus the extension (from the document-file-name attribute). Note: This should only be used to construct another name, such as a temporary file. Chapter 16. Understanding transform objects and the configurable transform subsystem 197

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336
  • 337
  • 338
  • 339
  • 340
  • 341
  • 342
  • 343
  • 344
  • 345
  • 346
  • 347
  • 348
  • 349
  • 350
  • 351
  • 352
  • 353
  • 354
  • 355
  • 356
  • 357
  • 358
  • 359
  • 360
  • 361
  • 362
  • 363
  • 364
  • 365
  • 366
  • 367
  • 368
  • 369
  • 370
  • 371
  • 372
  • 373
  • 374
  • 375
  • 376
  • 377
  • 378
  • 379
  • 380
  • 381
  • 382
  • 383
  • 384
  • 385
  • 386
  • 387
  • 388
  • 389
  • 390
  • 391
  • 392
  • 393
  • 394
  • 395
  • 396
  • 397
  • 398
  • 399
  • 400
  • 401
  • 402
  • 403
  • 404
  • 405
  • 406
  • 407
  • 408
  • 409
  • 410
  • 411
  • 412
  • 413
  • 414
  • 415
  • 416
  • 417
  • 418

Notes:
1.
If you are specifying any substitutions for which the passed values can contain
a blank space, such as
job name
, be sure to put quotes around the substitution
so it is passed correctly. Note that this only applies to single
%
substitution
variables. Do not put quotes around any
%%
substitution variables.
2.
The examples that follow presume that the
PATH
environment variable has
been set to the appropriate path so you do not have to specify the fully
qualified path name in the
Transform options
field.
Table 26. Transform substitution variables
Transform options substitution variables
Meaning
%i
The name of the input file to transform.
%o
The name of the file in which to store the
output of the transform.
Note:
If this is a non-terminating transform,
data must be stored in the file named by %o.
%e
The name of the file in which to store any
transform information or error messages. If
anything is written to this file, it is logged in
the InfoPrint Manager server log.
Notes:
1.
If the transform exits with an exit code of
0 or the value set in the
Conditional
terminating return code
field, the error
messages from the transform are logged
as
debug
severity.
2.
If the transform exits with a non-zero
return code, but not with the value set in
the
Conditional terminating return code
field transform attribute, the error
messages from the transform are logged
as
error
severity.
3.
InfoPrint Manager writes transform error
messages to either the file specified
through this substitution variable, or to
standard error (
stderr
). You should not
mix output to
%e
and
stderr
in a single
run of the exit program. You should use
either one or the other in any given run.
%u
The name of the file for updating the
pages-completed
and
job-page-count
job
attributes.
Note:
This file should only be accessed
through the
transform_update
utility.
%j
The name of the original print file, minus
the path (from the
document-file-name
attribute).
Note:
This should only be used to construct
another name, such as a temporary file.
%n
The name of the original print file, minus
the path and minus the extension (from the
document-file-name
attribute).
Note:
This should only be used to construct
another name, such as a temporary file.
Chapter 16. Understanding transform objects and the configurable transform subsystem
197