Show TOC

Procedure documentationImporting and Exporting SAP CPS Locate this document in the navigation structure

 

Most objects can be exported as CAR files from within the user interface, they can then be imported with the job definition System_Import_Archive or from the command line. To customize your imports and exports, you can specify rule sets. Import and export rule sets allow you to organize the flow of processes between Development, Quality Assurance and Production systems.

Actions

Import rule sets support the following actions:

Action

Description

Export

Export the import rule set into a CAR file

Submit Import Job

Submits an import job with the current import rule set

Edit

Edit the import rule set

Edit Security

Edit the security of the import rule set

Delete

Delete the import rule set

Duplicate

Make a copy of the import rule set to create a similar one

Expand All

Expand all import rule sets in the current filter

New

Create a new import rule set

Filter > New Filter

Create a new import rule set filter

Filter > Edit Filter

Edit current import rule set filter

Filter > Delete

Delete current import rule set filter

Export rule sets support the following actions:

Action

Description

Export

Export the export rule set into a CAR file

Submit Export Job

Submits an export job with the current export rule set

Edit

Edit the export rule set

Edit Security

Edit the security of the export rule set

Delete

Delete the export rule set

Duplicate

Make a copy of the export rule set to create a similar one

Expand All

Expand all export rule sets in the current filter

New

Create a new export rule set

Filter > New Filter

Create a new export rule set filter

Filter > Edit Filter

Edit current export rule set filter

Filter > Delete

Delete current export rule set filter

Imports support the following actions:

Action

Description

Edit

Edit the import

Delete

Delete the import

Submit Import Job

Submits an import job

Expand All

Expand all imports in the current filter

Filter > New Filter

Create a new import filter

Filter > Edit Filter

Edit current import filter

Filter > Delete

Delete current import filter

Exports support the following actions:

Action

Description

Edit

Edit the export

Delete

Delete the export

Submit Export Job

Submits an export job

Expand All

Expand all exports in the current filter

Filter > New Filter

Create a new export filter

Filter > Edit Filter

Edit current export filter

Filter > Delete

Delete current export filter

Finding Import and Export Rule Sets

You can search for import and export rule sets using filters and the Search Import Rule Sets and Search Export Rule Sets box, respectively, known as the intelliSearch boxes, located under your username on the top right-hand side of the user interface. Filters allow you to specify a list of objects with static criteria. IntelliSearch allows you to specify complex queries in a simple way using prefixes. Prefixes are used to specify which property you are searching in and have short and long syntaxes. For example, if you want to display all import rule sets with the term dev in the comment, you would use the search criteria as follows:

c:dev

You can search more than one property, as follows:

c:dev n:ORA

Note Note

No spaces should be entered before or after the colon (:).

End of the note.

See the Advanced Object Search for more information.

The following table illustrates the available prefixes for import and export rule sets:

Prefixes

Description

n, name

searches the name property

c, com, comment

searches the comment property

d, desc, description

searches the description property

a, app, application

searches the application property

Import Rule Sets

Import rules define which objects get imported from CAR archives and the changes required by the new system, which allow one or more objects to be transported from one system into another seamlessly. Import rule sets can hold one or more import rules. When you create an import, you may specify an import rule set according to which Parameters, like INSTANCE, CLIENT, or USERNAME for SAP job definitions, can be adjusted to the new system with overrides.

Note Note

Imports, import rules and import rule sets require the Import/Export module, which requires a specific license.

End of the note.

Actions on import rule sets allow you to specify RedwoodScript code to be executed against the imported objects before they are written to the database. The code can be specified on the Actions tab and make use of the classes that you have stored in a library.

Note Note

You should not persist the session in import rule set actions, as this is done for you at a later stage.

End of the note.
Export Rule Sets

Export rules define which objects get exported into CAR archives. You can match one or more objects to be transported from one system into another seamlessly. Export rule sets can hold one or more export rules.

There is no need to exclude built-in objects, as they cannot be exported and will be discarded.

Note Note

Built-in objects cannot be exported, as such, any built-in object that matches a pattern will be discarded from the export.

End of the note.

Note Note

Exports, export rules and export rule sets require the Import/Export module, which requires a specific license.

End of the note.
Importing CAR Files from the command line

The uploader class is included in the CAR file, so you can run upload CAR files from the command line interface.

java -jar <CAR> [-server [http[s]]://]host:port -username <username> -password <password> <option> <arguments>]

if -server is omitted, you will be prompted for the data

Valid <options>

-gui (present a GUI for entering server/username/password)

-txt (command line prompt for server/username/password)

If the -gui/-txt option is ommitted the input method will depend on the operating system and JDK version.

Valid <arguments>

-self - self upload this file (default)

-ruleset <ruleset name> - use an import ruleset (optional)

Example

java -jar processServer.car -server prd.masalan.com:50000 -username jdoe -password mysecret

Security

Privilege

Description

ImportRuleSet.Create

Create import rule sets

ImportRuleSet.Delete

Delete import rule sets

ImportRuleSet.Edit

Edit import rule sets

ImportRuleSet.View

Access import rule sets

ExportRuleSet.Create

Create export rule sets

ExportRuleSet.Delete

Delete export rule sets

ExportRuleSet.Edit

Edit export rule sets

ExportRuleSet.View

Access export rule sets

You can grant privileges on two levels, Access and Admin; a privilege granted on Admin level allows the grantee to grant the privilege to other users. These privileges can be granted system-wide, per partition or isolation group.

If you have the security module, which requires the Module.Security license key, you have an additional Security tab on the import and export rule set. It allows you to specify which users can access, edit, and delete the import or export rule set.

Procedure

Creating Import Rule Sets

  1. Navigate to   Promotion → Import Rule Sets  

  2. Choose New from the context menu.

  3. Fill in the details and choose the Import Rules Tab

  4. Choose New to create a new import rule and fill in the details.

  5. Choose Save & Close.

Using Import Rule Sets

  1. Navigate to   Promotion → Import  

  2. Choose Import from the context menu.

  3. Fill in the details and specify an import rule set to narrow down the imported objects.

  4. Choose Save & Close.

Creating Export Rule Sets

  1. Navigate to   Promotion → Export Rule Sets  

  2. Choose Create from the context menu.

  3. Fill in the details and choose the Export Rules Tab

  4. Choose New to create a new import rule and fill in the details.

  5. Choose Save & Close.

Using Export Rule Sets

  1. Navigate to   Promotion → Export  

  2. Choose Export from the context menu.

  3. Fill in the details and specify an export rule set.

  4. Choose Save & Close.

Example

Using import rules to change objects during import

A CAR archive containing multiple job definitions are to be imported, these job definitions all have a parameter named SAP_SYSTEMS that needs to get a new default value. The default value in the car file is Q2A and should be replaced with PR2 to match the new system. The parameter CLIENT also needs to change from 200 to 800.

  1. Navigate to   Promotion → Import Rule Sets  

  2. Choose Create from the context menu.

  3. Fill in a name and choose the Import Rules tab.

  4. Choose New to create a new import rule and fill the details below into the Name and Object Type fields.

  5. Choose New next to Parameter for the Matching field and fill in the details below, do the same for Replaces.a

  6. Perform steps 3 to 5 for the CLIENT parameter.

  7. Choose Save & Close.

Values

SAP_SYSTEMS parameter:

Field

Value

Name

Q2A_TO_PR2

Object Type

Job Definition

Matching - Name

SAP_SYSTEMS

Matching - Default Expression

Q2A

Replaces - Name

SAP_SYSTEMS

Replaces - Default Expression

PR2

CLIENT parameter:

Field

Value

Name

200_TO_800

Object Type

Job Definition

Matching - Name

CLIENT

Matching - Default Expression

200

Replaces - Name

CLIENT

Replaces - Default Expression

800

Using RedwoodScript code to change objects on import
  1. Navigate to Applications.

  2. Choose Create from the context menu and fill Masalan into the Name field.

  3. Choose Save & Close.

  4. Navigate to   Promotion → Import Rule Sets  

  5. Choose Create from the context menu.

  6. Fill in a name and choose the Import Action tab.

  7. Choose New and fill the code below into the Source field.

  8. Choose Save & Close.

Sample code to set the application or parent application to the Masalan application

{

Application app =

jcsSession.getApplicationByName("Masalan");

for (final Iterator it = jcsImportRuleSet.getObjects().iterator();

it.hasNext();)

{

Object o = it.next();

if (o instanceof ApplicationObject)

{

((ApplicationObject) o).setParentApplication(app);

}

}

}