<import> attributes

List of attributes for <import> command.

allow_deleted

allow_deleted

Syntax

[allow_deleted = Boolean : false]

May occur in

<import>

Description

An indicator of whether records marked as deleted (via the DelCd field) can be updated.

Remarks

This flag must be set when a record marked as deleted should be undeleted.

catnew

catnew

Syntax

[catnew = Boolean : false]

May occur in

<import>

Description

An indicator of whether unknown catalog values should be automatically created.

Remarks

It is recommended that new catalog values is not created using this flag due to risk of unwanted duplicates. It works only in the catalog base language.

It is also possible to create new catalog entries based on an external key.

                     <request>
                       <import catnew="1">
                         <fields>
                           <Company>
                             <Company>update Test AG</Company>
                             <FreeK1>Australia</FreeK1>
                             <FreeK2 extkey="1">AT</FreeK2>
                           </Company>
                         </fields>
                       </import>
                     </request>

In the sample above for FreeK2 a matchup is performed via ExtKey. If the value AT is not found the catalog is created– contrary to versions before 7.0.6.203 - (in this sample with Text = AT and ExtKey = AT) because of catnew="1". If FreeK1 doesn’t exist yet (matchup is performed via Text) a catalog value with Text = “Australia” is created.

No additional properties (with the exception of ExtKey) can be specified when creating catalog values this way.

force_update

force_update

Syntax

[force_update = Boolean : false]

May occur in

<import>

Description

An indicator of whether the record contents in <import> commands should be checked against the current values in the database. If true, no check is performed.

Remarks

none

mode

mode

Syntax

[mode = string]

May occur in

<import>

Values

normal, plausi, noexec, trigger

Description

A mode indicator for write operations.

Remarks

normal = Regular insert/update is performed.

plausi = Plausibility check is performed.

no_insert

no_insert

Syntax

[no_insert = Boolean : false]

May occur in

<import>

Description

An indicator of whether the creation of a new record is allowed. If true, only an update is allowed (after matchup has been performed).

Remarks

none

write_cursor_flags

write_cursor_flags

Syntax

[write_cursor_flags = mmFlags]

May occur in

<import>

Description

Flags that control processing of the <import> command.

Remarks

Currently not used

allow_locked_catalogs

allow_locked_catalogs

Syntax

[allow_locked_catalogs = Boolean : false]

May occur in

<import>

Description

An indicator of whether the import of locked catalog values is allowed as well. If true, locked catalog values are imported instead of returning an error.

Remarks

none

In case the catalog value "Locked Country" is locked an error is generated, see example below.

      <request>
        <import allow_locked_catalogs="false">
          <fields>
            <Company>
              <Company>My Company</Company>
              <Country>Locked Country</Country>
            </Company>
          </fields>
        </import>
      </request>
      <response>
        <import>
          <return type="error" func="C_Portal::CheckField">
            <ecode>-10017</ecode>
            <etext>Catalog entry not found</etext>
            <code>0</code>
            <field table="FI" tablename="Company" fid="5" fnr="5" type="K" fieldname="Country"/>
            <value>Locked Country</value>
          </return>
        </import>
      </response>

In order to allow importing of records with locked catalog values you may set allow_locked_catalogs="true".

      <request>
        <import allow_locked_catalogs="true">
          <fields>
            <Company>
              <Company>My Company</Company>
              <Country>LockedCountry</Country>
            </Company>
          </fields>
        </import>
      </request>
      <response>
        <import allow_locked_catalogs="true">
          <return table="FI" tablename="Company" id="42953967942464" type="insert"/>
        </import>
      </response>